package io.prometheus.client

Get desktop application:
View/edit binary Protocol Buffers messages

A Bucket of a conventional histogram, each of which is treated as an individual counter-like time series by Prometheus.

Used in: Histogram

• optional uint64 cumulative_count = 1

  Cumulative in increasing order.

• optional double cumulative_count_float = 4

  Overrides cumulative_count if > 0.

• optional double upper_bound = 2

  Inclusive.

• optional Exemplar exemplar = 3

A BucketSpan defines a number of consecutive buckets in a native histogram with their offset. Logically, it would be more straightforward to include the bucket counts in the Span. However, the protobuf representation is more compact in the way the data is structured here (with all the buckets in a single array separate from the Spans).

Used in: Histogram

• optional sint32 offset = 1

  Gap to previous span, or starting point for 1st span (which can be negative).

• optional uint32 length = 2

  Length of consecutive buckets.

Used in: Metric

• optional double value = 1

• optional Exemplar exemplar = 2

• optional google.protobuf.Timestamp created_timestamp = 3

Used in: Bucket, Counter, Histogram

• repeated LabelPair label = 1

• optional double value = 2

• optional google.protobuf.Timestamp timestamp = 3

  OpenMetrics-style.

Used in: Metric

• optional double value = 1

Used in: Metric

• optional uint64 sample_count = 1

• optional double sample_count_float = 4

  Overrides sample_count if > 0.

• optional double sample_sum = 2

• repeated Bucket bucket = 3

  Buckets for the conventional histogram.

  Ordered in increasing order of upper_bound, +Inf bucket is optional.

• optional google.protobuf.Timestamp created_timestamp = 15

• optional sint32 schema = 5

  schema defines the bucket schema. Currently, valid numbers are -4 <= n <= 8. They are all for base-2 bucket schemas, where 1 is a bucket boundary in each case, and then each power of two is divided into 2^n logarithmic buckets. Or in other words, each bucket boundary is the previous boundary times 2^(2^-n). In the future, more bucket schemas may be added using numbers < -4 or > 8.

• optional double zero_threshold = 6

  Breadth of the zero bucket.

• optional uint64 zero_count = 7

  Count in zero bucket.

• optional double zero_count_float = 8

  Overrides sb_zero_count if > 0.

• repeated BucketSpan negative_span = 9

  Negative buckets for the native histogram.

• repeated sint64 negative_delta = 10

  Use either "negative_delta" or "negative_count", the former for regular histograms with integer counts, the latter for float histograms.

  Count delta of each bucket compared to previous one (or to zero for 1st bucket).

• repeated double negative_count = 11

  Absolute count of each bucket.

• repeated BucketSpan positive_span = 12

  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 sint64 positive_delta = 13

  Use either "positive_delta" or "positive_count", the former for regular histograms with integer counts, the latter for float histograms.

  Count delta of each bucket compared to previous one (or to zero for 1st bucket).

• repeated double positive_count = 14

  Absolute count of each bucket.

• repeated Exemplar exemplars = 16

  Only used for native histograms. These exemplars MUST have a timestamp.

Used in: Exemplar, Metric

• optional string name = 1

• optional string value = 2

Used in: MetricFamily

• repeated LabelPair label = 1

• optional Gauge gauge = 2

• optional Counter counter = 3

• optional Summary summary = 4

• optional Untyped untyped = 5

• optional Histogram histogram = 7

• optional int64 timestamp_ms = 6

Used in: envoy.service.metrics.v2.StreamMetricsMessage, envoy.service.metrics.v3.StreamMetricsMessage

• optional string name = 1

• optional string help = 2

• optional MetricType type = 3

• repeated Metric metric = 4

• optional string unit = 5

Used in: MetricFamily

• COUNTER = 0

  COUNTER must use the Metric field "counter".

• GAUGE = 1

  GAUGE must use the Metric field "gauge".

• SUMMARY = 2

  SUMMARY must use the Metric field "summary".

• UNTYPED = 3

  UNTYPED must use the Metric field "untyped".

• HISTOGRAM = 4

  HISTOGRAM must use the Metric field "histogram".

• GAUGE_HISTOGRAM = 5

  GAUGE_HISTOGRAM must use the Metric field "histogram".

Used in: Summary

• optional double quantile = 1

• optional double value = 2

Used in: Metric

• optional uint64 sample_count = 1

• optional double sample_sum = 2

• repeated Quantile quantile = 3

• optional google.protobuf.Timestamp created_timestamp = 4

Used in: Metric

• optional double value = 1