Skip to content

Commit 5b6e1eb

Browse files
committed
update doc and changelog
Signed-off-by: Ben Ye <[email protected]>
1 parent ca541eb commit 5b6e1eb

File tree

3 files changed

+15
-6
lines changed

3 files changed

+15
-6
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
* [FEATURE] Query Frontend: Added a query rejection mechanism to block resource-intensive queries. #6005
1010
* [FEATURE] OTLP: Support ingesting OTLP exponential metrics as native histograms. #6071
1111
* [FEATURE] Ingester: Add `ingester.instance-limits.max-inflight-query-requests` to allow limiting ingester concurrent queries. #6081
12+
* [FEATURE] Distributor: Add `validation.max-native-histogram-buckets` to limit max number of bucket count. Distributor will try to automatically reduce histogram resolution until it is within the bucket limit or resolution cannot be reduced anymore. #6104
1213
* [ENHANCEMENT] rulers: Add support to persist tokens in rulers. #5987
1314
* [ENHANCEMENT] Query Frontend/Querier: Added store gateway postings touched count and touched size in Querier stats and log in Query Frontend. #5892
1415
* [ENHANCEMENT] Query Frontend/Querier: Returns `warnings` on prometheus query responses. #5916

docs/configuration/config-file-reference.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3159,11 +3159,13 @@ The `limits_config` configures default and per-tenant limits imposed by Cortex s
31593159
# e.g. remote_write.write_relabel_configs.
31603160
[metric_relabel_configs: <relabel_config...> | default = []]
31613161
3162-
# Enables support for exemplars in TSDB and sets the maximum number that will be
3163-
# stored. less than zero means disabled. If the value is set to zero, cortex
3164-
# will fallback to blocks-storage.tsdb.max-exemplars value.
3165-
# CLI flag: -ingester.max-exemplars
3166-
[max_exemplars: <int> | default = 0]
3162+
# Limit on total number of positive and negative buckets allowed in a single
3163+
# native histogram. The resolution of a histogram with more buckets will be
3164+
# reduced until the number of buckets is within the limit. If the limit cannot
3165+
# be reached, the sample will be discarded. 0 means no limit. Enforced at
3166+
# Distributor.
3167+
# CLI flag: -validation.max-native-histogram-buckets
3168+
[max_native_histogram_buckets: <int> | default = 0]
31673169
31683170
# The maximum number of active series per user, per ingester. 0 to disable.
31693171
# CLI flag: -ingester.max-series-per-user
@@ -3213,6 +3215,12 @@ The `limits_config` configures default and per-tenant limits imposed by Cortex s
32133215
# CLI flag: -ingester.out-of-order-time-window
32143216
[out_of_order_time_window: <duration> | default = 0s]
32153217
3218+
# Enables support for exemplars in TSDB and sets the maximum number that will be
3219+
# stored. less than zero means disabled. If the value is set to zero, cortex
3220+
# will fallback to blocks-storage.tsdb.max-exemplars value.
3221+
# CLI flag: -ingester.max-exemplars
3222+
[max_exemplars: <int> | default = 0]
3223+
32163224
# Maximum number of chunks that can be fetched in a single query from ingesters
32173225
# and long-term storage. This limit is enforced in the querier, ruler and
32183226
# store-gateway. 0 to disable.

pkg/util/validation/limits.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ func (l *Limits) RegisterFlags(f *flag.FlagSet) {
234234
f.Var(&l.CreationGracePeriod, "validation.create-grace-period", "Duration which table will be created/deleted before/after it's needed; we won't accept sample from before this time.")
235235
f.BoolVar(&l.EnforceMetricName, "validation.enforce-metric-name", true, "Enforce every sample has a metric name.")
236236
f.BoolVar(&l.EnforceMetadataMetricName, "validation.enforce-metadata-metric-name", true, "Enforce every metadata has a metric name.")
237-
f.IntVar(&l.MaxNativeHistogramBuckets, "validation.max-native-histogram-buckets", 0, ".")
237+
f.IntVar(&l.MaxNativeHistogramBuckets, "validation.max-native-histogram-buckets", 0, "Limit on total number of positive and negative buckets allowed in a single native histogram. The resolution of a histogram with more buckets will be reduced until the number of buckets is within the limit. If the limit cannot be reached, the sample will be discarded. 0 means no limit. Enforced at Distributor.")
238238

239239
f.IntVar(&l.MaxLocalSeriesPerUser, "ingester.max-series-per-user", 5000000, "The maximum number of active series per user, per ingester. 0 to disable.")
240240
f.IntVar(&l.MaxLocalSeriesPerMetric, "ingester.max-series-per-metric", 50000, "The maximum number of active series per metric name, per ingester. 0 to disable.")

0 commit comments

Comments
 (0)