package prometheus

Get desktop application:
View/edit binary Protocol Buffers messages

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

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 pkg/timestamp/timestamp.go for conversion from time.Time to Prometheus timestamp.

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 pkg/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 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 pkg/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 TimeSeries timeseries = 1

• repeated MetricMetadata metadata = 3