diff options
author | 2016-05-24 08:59:37 -0700 | |
---|---|---|
committer | 2016-05-24 08:59:37 -0700 | |
commit | 092f3f02f046b5d18afa8056342882f3f7e6947f (patch) | |
tree | d67bd55c37f3ee3d6804c48ab1187af4bcf88705 /src/core/ext/census | |
parent | 30fe63243a99b643f0213ce34b5093aa0750ab31 (diff) |
update docs
Diffstat (limited to 'src/core/ext/census')
-rw-r--r-- | src/core/ext/census/census.proto | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/src/core/ext/census/census.proto b/src/core/ext/census/census.proto index 8aa9610178..c869d851ff 100644 --- a/src/core/ext/census/census.proto +++ b/src/core/ext/census/census.proto @@ -149,13 +149,14 @@ message Metric { } // An Aggregation summarizes a series of individual Metric measurements, an -// AggregationDescriptor describes an Aggregation +// AggregationDescriptor describes an Aggregation. message AggregationDescriptor { - // At most one set of options. + // At most one set of options. If neither option is set, a default type + // of Distribution (without a histogram component) will be used. oneof options { - // Defines the histogram bucket boundaries for Distributions + // Defines the histogram bucket boundaries for Distributions. BucketBoundaries bucket_boundaries = 1; - // Defines the time windows to record for IntervalStats + // Defines the time windows to record for IntervalStats. IntervalBoundaries interval_boundaries = 2; } @@ -164,7 +165,8 @@ message AggregationDescriptor { // `bucket_boundaries`. // // Describes histogram bucket boundaries. Defines `size(bounds) + 1` (= N) - // buckets, with these boundaries for bucket index i: + // buckets (for size(bounds) >= 1; if size(bounds) == 0, then no histogram + // will be defined. The boundaries for bucket index i are: // // [-infinity, bounds[i]) for i == 0 // [bounds[i-1], bounds[i]) for 0 < i < N-2 @@ -253,7 +255,7 @@ message IntervalStats { repeated Window window = 1; } -// A Tag: key-value pair +// A Tag: key-value pair. message Tag { string key = 1; string value = 2; |