Changelog + doc

Signed-off-by: alanprot <[email protected]>
cortexproject · Jun 3, 2024 · c957462 · c957462
1 parent ea85cfa
commit c957462
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,7 +11,7 @@
 * [ENHANCEMENT] Distributor/Querier: Clean stale per-ingester metrics after ingester restarts. #5930
 * [ENHANCEMENT] Distributor/Ring: Allow disabling detailed ring metrics by ring member. #5931
 * [ENHANCEMENT] KV: Etcd Added etcd.ping-without-stream-allowed parameter to disable/enable  PermitWithoutStream #5933
-* [ENHANCEMENT] Ingester: Add a new `max_series_per_label_set` limit. This limit functions similarly to `max_series_per_metric`, but allowing users to define the maximum number of series per LabelSet. #5950
+* [ENHANCEMENT] Ingester: Add a new `limits_per_label_set` limit. This limit functions similarly to `max_series_per_metric`, but allowing users to define the maximum number of series per LabelSet. #5950 #5993
 * [ENHANCEMENT] Store Gateway: Log gRPC requests together with headers configured in `http_request_headers_to_log`. #5958
 * [BUGFIX] Configsdb: Fix endline issue in db password. #5920
 * [BUGFIX] Ingester: Fix `user` and `type` labels for the `cortex_ingester_tsdb_head_samples_appended_total` TSDB metric. #5952

diff --git a/docs/configuration/config-file-reference.md b/docs/configuration/config-file-reference.md
@@ -5319,7 +5319,8 @@ otel:
 ```yaml
 limits:
   # The maximum number of active series per LabelSet, across the cluster before
-  # replication.
+  # replication. Setting the value 0 will enable the monitoring (metrics) but
+  # would not enforce any limits.
   [max_series: <int> | default = ]
 
 # LabelSet which the limit should be applied.

diff --git a/pkg/util/validation/limits.go b/pkg/util/validation/limits.go
@@ -78,7 +78,7 @@ type TimeWindow struct {
 }
 
 type LimitsPerLabelSetEntry struct {
-	MaxSeries int `yaml:"max_series" json:"max_series" doc:"nocli|description=The maximum number of active series per LabelSet, across the cluster before replication."`
+	MaxSeries int `yaml:"max_series" json:"max_series" doc:"nocli|description=The maximum number of active series per LabelSet, across the cluster before replication. Setting the value 0 will enable the monitoring (metrics) but would not enforce any limits."`
 }
 
 type LimitsPerLabelSet struct {