Merge pull request #7522 from prometheus/beorn7/doc

Add an explanation for φ-quantile to the operators section
This commit is contained in:
Björn Rabenstein 2020-07-06 22:15:52 +02:00 committed by GitHub
commit 933aa367b4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -219,13 +219,18 @@ identical between all elements of the vector.
`count_values` outputs one time series per unique sample value. Each series has `count_values` outputs one time series per unique sample value. Each series has
an additional label. The name of that label is given by the aggregation an additional label. The name of that label is given by the aggregation
parameter, and the label value is the unique sample value. The value of each parameter, and the label value is the unique sample value. The value of each
time series is the number of times that sample value was present. time series is the number of times that sample value was present.
`topk` and `bottomk` are different from other aggregators in that a subset of `topk` and `bottomk` are different from other aggregators in that a subset of
the input samples, including the original labels, are returned in the result the input samples, including the original labels, are returned in the result
vector. `by` and `without` are only used to bucket the input vector. vector. `by` and `without` are only used to bucket the input vector.
`quantile` calculates the φ-quantile, the value that ranks at number φ*N among
the N metric values of the dimensions aggregated over. φ is provided as the
aggregation parameter. For example, `quantile(0.5, ...)` calculates the median,
`quantile(0.95, ...)` the 95th percentile.
Example: Example:
If the metric `http_requests_total` had time series that fan out by If the metric `http_requests_total` had time series that fan out by