package prometheus

Get desktop application:
View/edit binary Protocol Buffers messages

A BucketSpan defines a number of consecutive buckets 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

• sint32 offset = 1

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

• uint32 length = 2

  Length of consecutive buckets.

Chunk represents a TSDB chunk. Time range [min, max] is inclusive.

Used in: ChunkedSeries

• int64 min_time_ms = 1

• int64 max_time_ms = 2

• Chunk.Encoding type = 3

• bytes data = 4

We require this to match chunkenc.Encoding.

Used in: Chunk

• UNKNOWN = 0

• XOR = 1

• HISTOGRAM = 2

ChunkedReadResponse is a response when response_type equals STREAMED_XOR_CHUNKS. We strictly stream full series after series, optionally split by time. This means that a single frame can contain partition of the single series, but once a new series is started to be streamed it means that no more chunks will be sent for previous one. Series are returned sorted in the same way TSDB block are internally.

• repeated ChunkedSeries chunked_series = 1

• int64 query_index = 2

  query_index represents an index of the query from ReadRequest.queries these chunks relates to.

ChunkedSeries represents single, encoded time series.

Used in: ChunkedReadResponse

• repeated Label labels = 1

  Labels should be sorted.

• repeated Chunk chunks = 2

  Chunks will be in start time order and may overlap.

Used in: TimeSeries

• repeated Label labels = 1

  Optional, can be empty.

• double value = 2

• int64 timestamp = 3

  timestamp is in ms format, see model/timestamp/timestamp.go for conversion from time.Time to Prometheus timestamp.

A native histogram, also known as a sparse histogram. Original design doc: https://docs.google.com/document/d/1cLNv3aufPZb3fNfaJgdaRBZsInZKKIHo9E6HinJVbpM/edit The appendix of this design doc also explains the concept of float histograms. This Histogram message can represent both, the usual integer histogram as well as a float histogram.

Used in: TimeSeries

• oneof count

  Count of observations in the histogram.

  • uint64 count_int = 1

  • double count_float = 2

• double sum = 3

  Sum of observations in the histogram.

• sint32 schema = 4

  The 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.

• double zero_threshold = 5

  Breadth of the zero bucket.

• oneof zero_count

  Count in zero bucket.

  • uint64 zero_count_int = 6

  • double zero_count_float = 7

• repeated BucketSpan negative_spans = 8

  Negative Buckets.

• repeated sint64 negative_deltas = 9

  Use either "negative_deltas" or "negative_counts", 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_counts = 10

  Absolute count of each bucket.

• repeated BucketSpan positive_spans = 11

  Positive Buckets.

• repeated sint64 positive_deltas = 12

  Use either "positive_deltas" or "positive_counts", 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_counts = 13

  Absolute count of each bucket.

• Histogram.ResetHint reset_hint = 14

• int64 timestamp = 15

  timestamp is in ms format, see model/timestamp/timestamp.go for conversion from time.Time to Prometheus timestamp.

Used in: Histogram

• UNKNOWN = 0

  Need to test for a counter reset explicitly.

• YES = 1

  This is the 1st histogram after a counter reset.

• NO = 2

  There was no counter reset between this and the previous Histogram.

• GAUGE = 3

  This is a gauge histogram where counter resets don't happen.

Used in: ChunkedSeries, Exemplar, Labels, TimeSeries

• string name = 1

• string value = 2

Matcher specifies a rule, which can match or set of labels or not.

Used in: Query

• LabelMatcher.Type type = 1

• string name = 2

• string value = 3

Used in: LabelMatcher

• EQ = 0

• NEQ = 1

• RE = 2

• NRE = 3

• repeated Label labels = 1

Used in: WriteRequest

• MetricMetadata.MetricType type = 1

  Represents the metric type, these match the set from Prometheus. Refer to model/textparse/interface.go for details.

• string metric_family_name = 2

• string help = 4

• string unit = 5

Used in: MetricMetadata

• UNKNOWN = 0

• COUNTER = 1

• GAUGE = 2

• HISTOGRAM = 3

• GAUGEHISTOGRAM = 4

• SUMMARY = 5

• INFO = 6

• STATESET = 7

Used in: ReadRequest

• int64 start_timestamp_ms = 1

• int64 end_timestamp_ms = 2

• repeated LabelMatcher matchers = 3

• optional ReadHints hints = 4

Used in: ReadResponse

• repeated TimeSeries timeseries = 1

  Samples within a time series must be ordered by time.

Used in: Query

• int64 step_ms = 1

  Query step size in milliseconds.

• string func = 2

  String representation of surrounding function or aggregation.

• int64 start_ms = 3

  Start time in milliseconds.

• int64 end_ms = 4

  End time in milliseconds.

• repeated string grouping = 5

  List of label names used in aggregation.

• bool by = 6

  Indicate whether it is without or by.

• int64 range_ms = 7

  Range vector selector range in milliseconds.

ReadRequest represents a remote read request.

• repeated Query queries = 1

• repeated ReadRequest.ResponseType accepted_response_types = 2

  accepted_response_types allows negotiating the content type of the response. Response types are taken from the list in the FIFO order. If no response type in `accepted_response_types` is implemented by server, error is returned. For request that do not contain `accepted_response_types` field the SAMPLES response type will be used.

Used in: ReadRequest

• SAMPLES = 0

  Server will return a single ReadResponse message with matched series that includes list of raw samples. It's recommended to use streamed response types instead. Response headers: Content-Type: "application/x-protobuf" Content-Encoding: "snappy"

• STREAMED_XOR_CHUNKS = 1

  Server will stream a delimited ChunkedReadResponse message that contains XOR or HISTOGRAM(!) encoded chunks for a single series. Each message is following varint size and fixed size bigendian uint32 for CRC32 Castagnoli checksum. Response headers: Content-Type: "application/x-streamed-protobuf; proto=prometheus.ChunkedReadResponse" Content-Encoding: ""

ReadResponse is a response when response_type equals SAMPLES.

• repeated QueryResult results = 1

  In same order as the request's queries.

Used in: TimeSeries

• double value = 1

• int64 timestamp = 2

  timestamp is in ms format, see model/timestamp/timestamp.go for conversion from time.Time to Prometheus timestamp.

TimeSeries represents samples and labels for a single time series.

Used in: QueryResult, WriteRequest

• repeated Label labels = 1

  For a timeseries to be valid, and for the samples and exemplars to be ingested by the remote system properly, the labels field is required.

• repeated Sample samples = 2

• repeated Exemplar exemplars = 3

• repeated Histogram histograms = 4

• repeated TimeSeries timeseries = 1

• repeated MetricMetadata metadata = 3