Add documentation for custom_values usage in NHCB (#16757)

Signed-off-by: rishi-jat <rishijat098@gmail.com>
Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com>
pull/9577/merge
Rishi Jat 3 days ago committed by GitHub
parent bdada2330c
commit 31e158b749
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 10
      docs/configuration/unit_testing_rules.md

@ -98,8 +98,10 @@ series: <string>
# Native histograms support the same expanding notation as floating point numbers, i.e. 'axn', 'a+bxn' and 'a-bxn'.
# All properties are optional and default to 0. The order is not important. The following properties are supported:
# - schema (int):
# Currently valid schema numbers are -4 <= n <= 8. They are all for
# base-2 bucket schemas, where 1 is a bucket boundary in each case, and
# Currently valid schema numbers are -53 and -4 <= n <= 8.
# Schema -53 is the custom buckets schema, upper bucket boundaries are defined in custom_values
# like for classic histograms, and you shouldn't use z_bucket, z_bucket_w, n_buckets, n_offset.
# The rest are base-2 standard schemas, where 1.0 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).
@ -123,6 +125,10 @@ series: <string>
# The starting index of the first entry in the negative buckets.
# - counter_reset_hint (one of 'unknown', 'reset', 'not_reset' or 'gauge')
# The counter reset hint associated with this histogram. Defaults to 'unknown' if not set.
# - custom_values (list of floats in ascending order):
# The upper limits for custom buckets when schema is -53.
# These have the same role as the 'le' numbers in classic histograms.
# Do not append '+Inf' at the end, it is implicit.
values: <string>
```

Loading…
Cancel
Save