update docs

pull/6702/head
Alistair Veitch 9 years ago
parent 30fe63243a
commit 092f3f02f0
  1. 14
      src/core/ext/census/census.proto

@ -149,13 +149,14 @@ message Metric {
} }
// An Aggregation summarizes a series of individual Metric measurements, an // An Aggregation summarizes a series of individual Metric measurements, an
// AggregationDescriptor describes an Aggregation // AggregationDescriptor describes an Aggregation.
message AggregationDescriptor { 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 { oneof options {
// Defines the histogram bucket boundaries for Distributions // Defines the histogram bucket boundaries for Distributions.
BucketBoundaries bucket_boundaries = 1; BucketBoundaries bucket_boundaries = 1;
// Defines the time windows to record for IntervalStats // Defines the time windows to record for IntervalStats.
IntervalBoundaries interval_boundaries = 2; IntervalBoundaries interval_boundaries = 2;
} }
@ -164,7 +165,8 @@ message AggregationDescriptor {
// `bucket_boundaries`. // `bucket_boundaries`.
// //
// Describes histogram bucket boundaries. Defines `size(bounds) + 1` (= N) // 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 // [-infinity, bounds[i]) for i == 0
// [bounds[i-1], bounds[i]) for 0 < i < N-2 // [bounds[i-1], bounds[i]) for 0 < i < N-2
@ -253,7 +255,7 @@ message IntervalStats {
repeated Window window = 1; repeated Window window = 1;
} }
// A Tag: key-value pair // A Tag: key-value pair.
message Tag { message Tag {
string key = 1; string key = 1;
string value = 2; string value = 2;

Loading…
Cancel
Save