Docs: remove keep_common, count_scalar, drop_common_labels

This commit is contained in:
Brian Brazil 2017-10-27 15:42:44 +01:00
parent c4a68f29bf
commit aeb524ad14
2 changed files with 2 additions and 17 deletions

View file

@ -60,14 +60,6 @@ elements in `v` to have an upper limit of `max`.
`clamp_min(v instant-vector, min scalar)` clamps the sample values of all `clamp_min(v instant-vector, min scalar)` clamps the sample values of all
elements in `v` to have a lower limit of `min`. elements in `v` to have a lower limit of `min`.
## `count_scalar()`
`count_scalar(v instant-vector)` returns the number of elements in a time series
vector as a scalar. This is in contrast to the `count()`
[aggregation operator](operators.md#aggregation-operators), which
always returns a vector (an empty one if the input vector is empty) and allows
grouping by labels via a `by` clause.
## `day_of_month()` ## `day_of_month()`
`day_of_month(v=vector(time()) instant-vector)` returns the day of the month `day_of_month(v=vector(time()) instant-vector)` returns the day of the month
@ -109,11 +101,6 @@ vector `v`, using [simple linear regression](http://en.wikipedia.org/wiki/Simple
`deriv` should only be used with gauges. `deriv` should only be used with gauges.
## `drop_common_labels()`
`drop_common_labels(instant-vector)` drops all labels that have the same name
and value across all series in the input vector.
## `exp()` ## `exp()`
`exp(v instant-vector)` calculates the exponential function for all elements in `v`. `exp(v instant-vector)` calculates the exponential function for all elements in `v`.

View file

@ -193,15 +193,13 @@ vector of fewer elements with aggregated values:
These operators can either be used to aggregate over **all** label dimensions These operators can either be used to aggregate over **all** label dimensions
or preserve distinct dimensions by including a `without` or `by` clause. or preserve distinct dimensions by including a `without` or `by` clause.
<aggr-op>([parameter,] <vector expression>) [without|by (<label list>)] [keep_common] <aggr-op>([parameter,] <vector expression>) [without|by (<label list>)]
`parameter` is only required for `count_values`, `quantile`, `topk` and `parameter` is only required for `count_values`, `quantile`, `topk` and
`bottomk`. `without` removes the listed labels from the result vector, while `bottomk`. `without` removes the listed labels from the result vector, while
all other labels are preserved the output. `by` does the opposite and drops all other labels are preserved the output. `by` does the opposite and drops
labels that are not listed in the `by` clause, even if their label values are labels that are not listed in the `by` clause, even if their label values are
identical between all elements of the vector. The `keep_common` clause allows identical between all elements of the vector.
keeping those extra labels (labels that are identical between elements, but not
in the `by` clause).
`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