Merge pull request #11731 from colega/remove-comments-from-remote-read-docs

Remove comments from the remote read docs
This commit is contained in:
Julien Pivotto 2022-12-15 22:16:23 +01:00 committed by GitHub
commit fc06260d88
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -65,8 +65,6 @@ Note: Names of query parameters that may be repeated end with `[]`.
This API provides data read functionality from Prometheus. This interface expects [snappy](https://github.com/google/snappy) compression. This API provides data read functionality from Prometheus. This interface expects [snappy](https://github.com/google/snappy) compression.
The API definition is located [here](https://github.com/prometheus/prometheus/blob/master/prompb/remote.proto). The API definition is located [here](https://github.com/prometheus/prometheus/blob/master/prompb/remote.proto).
/// Can you clarify what you mean by this?
/// https://github.com/prometheus/prometheus/pull/7266#discussion_r426456791 Can we talk a little bit how negotiation works of sampled vs streamed ?
Request are made to the following endpoint. Request are made to the following endpoint.
``` ```
@ -74,12 +72,10 @@ Request are made to the following endpoint.
``` ```
### Samples ### Samples
/// Does it return a message that includes a list, or does it return a list of raw samples?
This returns a message that includes a list of raw samples. This returns a message that includes a list of raw samples.
### Streamed Chunks ### Streamed Chunks
/// This is a little much detail, the relevant point is they're the internal implementation of the chunks.
These streamed chunks utilize an XOR algorithm inspired by the [Gorilla](http://www.vldb.org/pvldb/vol8/p1816-teller.pdf) These streamed chunks utilize an XOR algorithm inspired by the [Gorilla](http://www.vldb.org/pvldb/vol8/p1816-teller.pdf)
compression to encode the chunks. However, it provides resolution to the millisecond instead of to the second. compression to encode the chunks. However, it provides resolution to the millisecond instead of to the second.