Merge pull request #67 from prometheus/beorn7/histogram

histogram: Add a doc comment about when to add a no-op span
prometheus · Jul 26, 2023 · cfbcccb · cfbcccb
2 parents 95a0733 + 2a367b9
commit cfbcccb
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/go/metrics.pb.go b/go/metrics.pb.go
diff --git a/io/prometheus/client/metrics.proto b/io/prometheus/client/metrics.proto
@@ -98,6 +98,9 @@ message Histogram {
   repeated double negative_count    = 11; // Absolute count of each bucket.
 
   // Positive buckets for the native histogram.
+  // Use a no-op span (offset 0, length 0) for a native histogram without any
+  // observations yet and with a zero_threshold of 0. Otherwise, it would be
+  // indistinguishable from a classic histogram.
   repeated BucketSpan positive_span = 12;
   // Use either "positive_delta" or "positive_count", the former for
   // regular histograms with integer counts, the latter for float