Skip to content

Commit 83c03ab

Browse files
krajoramatacole02
andauthored
docs(nativehistograms): improve description of bucket limiting (#12797)
#### What this PR does Improve the description of how to limit the number of buckets in native histograms. #### Which issue(s) this PR fixes or relates to From Grafana Cloud customer question. #### Checklist - N/A Tests updated. - [x] Documentation added. - [x] `CHANGELOG.md` updated - the order of entries should be `[CHANGE]`, `[FEATURE]`, `[ENHANCEMENT]`, `[BUGFIX]`. If changelog entry is not needed, please add the `changelog-not-needed` label to the PR. - N/A [`about-versioning.md`](https://github.com/grafana/mimir/blob/main/docs/sources/mimir/configure/about-versioning.md) updated with experimental features. --------- Signed-off-by: György Krajcsovits <[email protected]> Co-authored-by: Taylor C <[email protected]>
1 parent ac315d3 commit 83c03ab

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@
107107
### Documentation
108108

109109
* [ENHANCEMENT] Improve the MimirIngesterReachingSeriesLimit runbook. #12356
110+
* [ENHANCEMENT] Improve the description of how to limit the number of buckets in native histograms. #12797
110111
* [BUGFIX] Add a missing attribute to the list of default promoted OTel resource attributes in the docs: deployment.environment. #12181
111112

112113
## 2.17.1

docs/sources/mimir/send/native-histograms/_index.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,23 @@ where the `schema` is chosen as above.
343343
344344
## Limit the number of buckets
345345
346-
The server scraping or receiving native histograms over remote write may limit the number of native histogram buckets it accepts. The server may reject or downscale (reduce resolution and merge adjacent buckets). Even if that wasn't the case, storing and emitting potentially unlimited number of buckets isn't practical.
346+
Emitting and storing a potentially unlimited number of buckets isn't practical, as higher resolution increases the storage costs with diminishing returns.
347+
348+
You can limit the number of buckets in Grafana Mimir or Grafana Cloud, Prometheus, or in application instrumentation.
349+
350+
### Limit the number of buckets in Grafana Mimir or Grafana Cloud
351+
352+
To limit the number of buckets in all native histograms ingested by Grafana Mimir or Grafana Cloud, set the tenant limit [`max_native_histogram_buckets`](../../configure/configure-native-histograms-ingestion/#configure-native-histograms-per-tenant) in Grafana Mimir or submit a support request for Grafana Cloud.
353+
354+
Native histograms that have a higher bucket count than the limit are converted to a native histogram with a lower resolution by merging buckets to reduce the number of buckets. In some rare cases, if the buckets are too widely spread out, merging them isn't possible and the native histogram is rejected.
355+
356+
### Limit the number of buckets in Prometheus
357+
358+
To limit the number of buckets in native histograms scraped by a [scrape configuration](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config), set the parameter `native_histogram_bucket_limit` in the scrape configuration.
359+
360+
Native histograms that have a higher bucket count than the limit are converted to a native histogram with a lower resolution by merging buckets to reduce the number of buckets. In some rare cases, if the buckets are too widely spread out, merging them isn't possible and the native histogram is rejected.
361+
362+
### Limit the number of buckets in application instrumentation
347363
348364
The instrumentation libraries of Prometheus have automation to keep the number of buckets down, provided that the maximum bucket number option is used, such as `NativeHistogramMaxBucketNumber` in Go.
349365

0 commit comments

Comments
 (0)