doc

Signed-off-by: alanprot <[email protected]>

Author: alanprot

docs/configuration/config-file-reference.md

@@ -3168,6 +3168,10 @@ The `limits_config` configures default and per-tenant limits imposed by Cortex s
 # CLI flag: -ingester.max-global-series-per-metric
 [max_global_series_per_metric: <int> | default = 0]
 
+# [Experimental] The maximum number of active series per LabelSet, across the
+# cluster before replication. Empty list to disable.
+[max_series_per_label_set: <list of MaxSeriesPerLabelSet> | default = []]
+
 # The maximum number of active metrics with metadata per user, per ingester. 0
 # to disable.
 # CLI flag: -ingester.max-metadata-per-user
@@ -4009,7 +4013,7 @@ The `ruler_config` configures the Cortex ruler.
 [external_url: <url> | default = ]
 
 # Labels to add to all alerts.
-[external_labels: <list of Label> | default = []]
+[external_labels: <map of string (labelName) to string (labelValue)> | default = []]
 
 ruler_client:
   # gRPC client max receive message size (bytes).
@@ -5306,6 +5310,16 @@ otel:
     [tls_insecure_skip_verify: <boolean> | default = false]
 ```
 
+### `MaxSeriesPerLabelSet`
+
+```yaml
+# The maximum number of active series per LabelSet before replication.
+[limit: <int> | default = ]
+
+# LabelSet which the limit should be applied.
+[label_set: <map of string (labelName) to string (labelValue)> | default = []]
+```
+
 ### `PriorityDef`
 
 ```yaml
@@ -5350,11 +5364,3 @@ time_window:
 # name of the rule group
 [name: <string> | default = ""]
 ```
-
-### `Label`
-
-```yaml
-[name: <string> | default = ""]
-
-[value: <string> | default = ""]
-```

pkg/ingester/ingester_test.go

@@ -84,15 +84,15 @@ func TestIngesterPerLabelsetLimitExceeded(t *testing.T) {
 
 	limits.MaxSeriesPerLabelSet = []validation.MaxSeriesPerLabelSet{
 		{
-			LabelSet: map[string]string{
+			LabelSet: labels.FromMap(map[string]string{
 				"label1": "value1",
-			},
+			}),
 			Limit: 3,
 		},
 		{
-			LabelSet: map[string]string{
+			LabelSet: labels.FromMap(map[string]string{
 				"label2": "value2",
-			},
+			}),
 			Limit: 2,
 		},
 	}
@@ -122,8 +122,8 @@ func TestIngesterPerLabelsetLimitExceeded(t *testing.T) {
 	// Create first series within the limits
 	for _, set := range limits.MaxSeriesPerLabelSet {
 		lbls := []string{labels.MetricName, "metric_name"}
-		for k, v := range set.LabelSet {
-			lbls = append(lbls, k, v)
+		for _, lbl := range set.LabelSet {
+			lbls = append(lbls, lbl.Name, lbl.Value)
 		}
 		for i := 0; i < set.Limit; i++ {
 			_, err = ing.Push(ctx, cortexpb.ToWriteRequest(
@@ -143,8 +143,8 @@ func TestIngesterPerLabelsetLimitExceeded(t *testing.T) {
 	// Should impose limits
 	for _, set := range limits.MaxSeriesPerLabelSet {
 		lbls := []string{labels.MetricName, "metric_name"}
-		for k, v := range set.LabelSet {
-			lbls = append(lbls, k, v)
+		for _, lbl := range set.LabelSet {
+			lbls = append(lbls, lbl.Name, lbl.Value)
 		}
 		_, err = ing.Push(ctx, cortexpb.ToWriteRequest(
 			[]labels.Labels{labels.FromStrings(append(lbls, "newLabel", "newValue")...)}, samples, nil, nil, cortexpb.API))
@@ -164,20 +164,20 @@ func TestIngesterPerLabelsetLimitExceeded(t *testing.T) {
 
 	// Should apply composite limits
 	limits.MaxSeriesPerLabelSet = append(limits.MaxSeriesPerLabelSet,
-		validation.MaxSeriesPerLabelSet{LabelSet: map[string]string{
+		validation.MaxSeriesPerLabelSet{LabelSet: labels.FromMap(map[string]string{
 			"comp1": "compValue1",
-		},
+		}),
 			Limit: 10,
 		},
-		validation.MaxSeriesPerLabelSet{LabelSet: map[string]string{
+		validation.MaxSeriesPerLabelSet{LabelSet: labels.FromMap(map[string]string{
 			"comp2": "compValue2",
-		},
+		}),
 			Limit: 10,
 		},
-		validation.MaxSeriesPerLabelSet{LabelSet: map[string]string{
+		validation.MaxSeriesPerLabelSet{LabelSet: labels.FromMap(map[string]string{
 			"comp1": "compValue1",
 			"comp2": "compValue2",
-		},
+		}),
 			Limit: 2,
 		},
 	)
@@ -224,10 +224,10 @@ func TestIngesterPerLabelsetLimitExceeded(t *testing.T) {
 
 	// Should bootstrap and apply limits when configuration change
 	limits.MaxSeriesPerLabelSet = append(limits.MaxSeriesPerLabelSet,
-		validation.MaxSeriesPerLabelSet{LabelSet: map[string]string{
+		validation.MaxSeriesPerLabelSet{LabelSet: labels.FromMap(map[string]string{
 			labels.MetricName: "metric_name",
 			"comp2":           "compValue2",
-		},
+		}),
 			Limit: 3, // we already have 2 so we need to allow 1 more
 		},
 	)

pkg/ingester/limiter.go

@@ -189,12 +189,18 @@ func (l *Limiter) formatMaxSeriesPerLabelSetError(err errMaxSeriesPerLabelSetLim
 
 func (l *Limiter) maxSeriesPerLabelSet(userID string, metric labels.Labels) []validation.MaxSeriesPerLabelSet {
 	m := l.limits.MaxSeriesPerLabelSet(userID)
+
+	// returning early to not have any overhead
+	if len(m) == 0 {
+		return nil
+	}
+
 	r := make([]validation.MaxSeriesPerLabelSet, 0, len(m))
 outer:
 	for _, lbls := range m {
-		for name, value := range lbls.LabelSet {
+		for _, lbl := range lbls.LabelSet {
 			// We did not find some of the labels on  the set
-			if v := metric.Get(name); v != value {
+			if v := metric.Get(lbl.Name); v != lbl.Value {
 				continue outer
 			}
 		}

pkg/ingester/user_state.go

@@ -136,8 +136,8 @@ func (m *labelSetCounter) canAddSeriesForLabelSet(ctx context.Context, u *userTS
 		defer s.Unlock()
 		if r, ok := s.valuesCounter[set.Hash]; !ok {
 			postings := make([]index.Postings, 0, len(set.LabelSet))
-			for k, v := range set.LabelSet {
-				p, err := ir.Postings(ctx, k, v)
+			for _, lbl := range set.LabelSet {
+				p, err := ir.Postings(ctx, lbl.Name, lbl.Value)
 				if err != nil {
 					return 0, err
 				}
@@ -157,7 +157,7 @@ func (m *labelSetCounter) canAddSeriesForLabelSet(ctx context.Context, u *userTS
 
 			s.valuesCounter[set.Hash] = &labelSetCounterEntry{
 				count:  totalCount,
-				labels: labels.FromMap(set.LabelSet),
+				labels: set.LabelSet,
 			}
 			return totalCount, nil
 		} else {
@@ -176,7 +176,7 @@ func (m *labelSetCounter) increaseSeriesLabelSet(u *userTSDB, metric labels.Labe
 		} else {
 			s.valuesCounter[l.Hash] = &labelSetCounterEntry{
 				count:  1,
-				labels: labels.FromMap(l.LabelSet),
+				labels: l.LabelSet,
 			}
 		}
 		s.Unlock()

pkg/util/validation/limits.go

@@ -77,10 +77,10 @@ type TimeWindow struct {
 }
 
 type MaxSeriesPerLabelSet struct {
-	Limit    int               `yaml:"limit" json:"limit" doc:"nocli"`
-	LabelSet map[string]string `yaml:"label_set" json:"label_set" doc:"nocli"`
-	Id       string            `yaml:"-" json:"-" doc:"nocli"`
-	Hash     uint64            `yaml:"-" json:"-" doc:"nocli"`
+	Limit    int           `yaml:"limit" json:"limit" doc:"nocli|description=The maximum number of active series per LabelSet before replication."`
+	LabelSet labels.Labels `yaml:"label_set" json:"label_set" doc:"nocli|description=LabelSet which the limit should be applied."`
+	Id       string        `yaml:"-" json:"-" doc:"nocli"`
+	Hash     uint64        `yaml:"-" json:"-" doc:"nocli"`
 }
 
 // Limits describe all the limits for users; can be used to describe global default
@@ -115,7 +115,7 @@ type Limits struct {
 	MaxLocalSeriesPerMetric  int                    `yaml:"max_series_per_metric" json:"max_series_per_metric"`
 	MaxGlobalSeriesPerUser   int                    `yaml:"max_global_series_per_user" json:"max_global_series_per_user"`
 	MaxGlobalSeriesPerMetric int                    `yaml:"max_global_series_per_metric" json:"max_global_series_per_metric"`
-	MaxSeriesPerLabelSet     []MaxSeriesPerLabelSet `yaml:"max_series_per_label_set" json:"max_series_per_label_set" doc:"hidden"`
+	MaxSeriesPerLabelSet     []MaxSeriesPerLabelSet `yaml:"max_series_per_label_set" json:"max_series_per_label_set" doc:"nocli|description=[Experimental] The maximum number of active series per LabelSet, across the cluster before replication. Empty list to disable."`
 
 	// Metadata
 	MaxLocalMetricsWithMetadataPerUser  int `yaml:"max_metadata_per_user" json:"max_metadata_per_user"`
@@ -330,7 +330,7 @@ func (l *Limits) UnmarshalJSON(data []byte) error {
 
 func (l *Limits) calculateMaxSeriesPerLabelSetId() {
 	for k, limit := range l.MaxSeriesPerLabelSet {
-		limit.Id = labels.FromMap(limit.LabelSet).String()
+		limit.Id = limit.LabelSet.String()
 		limit.Hash = fnv1a.HashBytes64([]byte(limit.Id))
 		l.MaxSeriesPerLabelSet[k] = limit
 	}

tools/doc-generator/parser.go

@@ -193,10 +193,12 @@ func parseConfig(block *configBlock, cfg interface{}, flags map[uintptr]*flag.Fl
 		if field.Type.Kind() == reflect.Slice {
 			sliceElementType := field.Type.Elem()
 			if sliceElementType.Kind() == reflect.Struct {
-				rootBlocks = append(rootBlocks, rootBlock{
-					name:       field.Type.Elem().Name(),
-					structType: field.Type.Elem(),
-				})
+				if field.Type.String() != "labels.Labels" {
+					rootBlocks = append(rootBlocks, rootBlock{
+						name:       field.Type.Elem().Name(),
+						structType: field.Type.Elem(),
+					})
+				}
 				sliceElementBlock := &configBlock{
 					name: field.Type.Elem().Name(),
 					desc: "",
@@ -286,6 +288,8 @@ func getFieldType(t reflect.Type) (string, error) {
 		return "string", nil
 	case "[]*relabel.Config":
 		return "relabel_config...", nil
+	case "labels.Labels":
+		return "map of string (labelName) to string (labelValue)", nil
 	}
 
 	// Fallback to auto-detection of built-in data types