Add NameValidationScheme

Signed-off-by: SungJin1212 <tjdwls1201@gmail.com>

Author: SungJin1212

docs/configuration/config-file-reference.md

@@ -4344,6 +4344,11 @@ query_rejection:
 
 # list of rule groups to disable
 [disabled_rule_groups: <list of DisabledRuleGroup> | default = []]
+
+# Name validation scheme for metric names and label names, Support values are:
+# legacy, utf8.
+# CLI flag: -validation.name-validation-scheme
+[name_validation_scheme: <int> | default = legacy]
 ```
 
 ### `memberlist_config`

integration/e2e/service.go

@@ -15,6 +15,7 @@ import (
 	"github.com/go-kit/log"
 	"github.com/pkg/errors"
 	"github.com/prometheus/common/expfmt"
+	"github.com/prometheus/common/model"
 	"github.com/thanos-io/thanos/pkg/runutil"
 
 	"github.com/cortexproject/cortex/pkg/util/backoff"
@@ -623,7 +624,7 @@ func (s *HTTPService) SumMetrics(metricNames []string, opts ...MetricsOption) ([
 		return nil, err
 	}
 
-	var tp expfmt.TextParser
+	tp := expfmt.NewTextParser(model.LegacyValidation)
 	families, err := tp.TextToMetricFamilies(strings.NewReader(metrics))
 	if err != nil {
 		return nil, err
@@ -670,7 +671,7 @@ func (s *HTTPService) WaitRemovedMetric(metricName string, opts ...MetricsOption
 		}
 
 		// Parse metrics.
-		var tp expfmt.TextParser
+		tp := expfmt.NewTextParser(model.LegacyValidation)
 		families, err := tp.TextToMetricFamilies(strings.NewReader(metrics))
 		if err != nil {
 			return err

pkg/util/validation/exporter.go

@@ -64,10 +64,13 @@ func ExtractNumericalValues(l *Limits) map[string]float64 {
 
 		switch field.Kind() {
 		case reflect.Int, reflect.Int64:
-			if field.Type().String() == "model.Duration" {
+			switch fieldType.Type.String() {
+			case "model.Duration":
 				// we export the model.Duration in seconds
 				metrics[tag] = time.Duration(field.Int()).Seconds()
-			} else {
+			case "model.ValidationScheme":
+				// skip
+			default:
 				metrics[tag] = float64(field.Int())
 			}
 		case reflect.Uint, reflect.Uint64:

pkg/util/validation/limits.go

@@ -245,6 +245,8 @@ type Limits struct {
 	AlertmanagerMaxSilencesCount               int                `yaml:"alertmanager_max_silences_count" json:"alertmanager_max_silences_count"`
 	AlertmanagerMaxSilencesSizeBytes           int                `yaml:"alertmanager_max_silences_size_bytes" json:"alertmanager_max_silences_size_bytes"`
 	DisabledRuleGroups                         DisabledRuleGroups `yaml:"disabled_rule_groups" json:"disabled_rule_groups" doc:"nocli|description=list of rule groups to disable"`
+
+	NameValidationScheme model.ValidationScheme `yaml:"name_validation_scheme" json:"name_validation_scheme"`
 }
 
 // RegisterFlags adds the flags required to config this to the given FlagSet
@@ -354,6 +356,9 @@ func (l *Limits) RegisterFlags(f *flag.FlagSet) {
 	f.IntVar(&l.AlertmanagerMaxAlertsSizeBytes, "alertmanager.max-alerts-size-bytes", 0, "Maximum total size of alerts that a single user can have, alert size is the sum of the bytes of its labels, annotations and generatorURL. Inserting more alerts will fail with a log message and metric increment. 0 = no limit.")
 	f.IntVar(&l.AlertmanagerMaxSilencesCount, "alertmanager.max-silences-count", 0, "Maximum number of silences that a single user can have, including expired silences. 0 = no limit.")
 	f.IntVar(&l.AlertmanagerMaxSilencesSizeBytes, "alertmanager.max-silences-size-bytes", 0, "Maximum size of individual silences that a single user can have. 0 = no limit.")
+
+	_ = l.NameValidationScheme.Set(model.LegacyValidation.String())
+	f.Var(&l.NameValidationScheme, "validation.name-validation-scheme", fmt.Sprintf("Name validation scheme for metric names and label names, Support values are: %s.", strings.Join([]string{model.LegacyValidation.String(), model.UTF8Validation.String()}, ", ")))
 }
 
 // Validate the limits config and returns an error if the validation
@@ -376,8 +381,18 @@ func (l *Limits) Validate(shardByAllLabels bool, activeSeriesMetricsEnabled bool
 		return errMaxLocalNativeHistogramSeriesPerUserValidation
 	}
 
+	var nameValidationScheme model.ValidationScheme
+	switch l.NameValidationScheme {
+	case model.LegacyValidation, model.UTF8Validation:
+		nameValidationScheme = l.NameValidationScheme
+	case model.UnsetValidation:
+		nameValidationScheme = model.LegacyValidation
+	default:
+		return fmt.Errorf("unsupported name validation scheme: %s", l.NameValidationScheme)
+	}
+
 	if err := l.RulerExternalLabels.Validate(func(l labels.Label) error {
-		if !model.LabelName(l.Name).IsValid() {
+		if !nameValidationScheme.IsValidMetricName(l.Name) {
 			return fmt.Errorf("%w: %q", errInvalidLabelName, l.Name)
 		}
 		if !model.LabelValue(l.Value).IsValid() {

pkg/util/validation/limits_test.go

@@ -245,7 +245,7 @@ limits_per_label_set:
 	err := yaml.Unmarshal([]byte(inputYAML), &limitsYAML)
 	require.NoError(t, err)
 	require.Len(t, limitsYAML.LimitsPerLabelSet, 1)
-	require.Len(t, limitsYAML.LimitsPerLabelSet[0].LabelSet, 1)
+	require.Equal(t, 1, limitsYAML.LimitsPerLabelSet[0].LabelSet.Len())
 	require.Equal(t, limitsYAML.LimitsPerLabelSet[0].Limits.MaxSeries, 10)
 
 	duplicatedInputYAML := `
@@ -477,6 +477,34 @@ alertmanager_notification_rate_limit_per_integration:
 	}
 }
 
+func TestNameValidationSchemeOverrides(t *testing.T) {
+	baseYaml := `
+name_validation_scheme: legacy
+`
+
+	overridesYaml := `
+user1:
+  name_validation_scheme: legacy
+user2:
+  name_validation_scheme: utf8
+`
+	limitsYAML := Limits{}
+	err := yaml.Unmarshal([]byte(baseYaml), &limitsYAML)
+	require.NoError(t, err, "expected to be able to unmarshal from YAML")
+
+	SetDefaultLimitsForYAMLUnmarshalling(limitsYAML)
+
+	overrides := map[string]*Limits{}
+	err = yaml.Unmarshal([]byte(overridesYaml), &overrides)
+	require.NoError(t, err, "parsing overrides")
+
+	tl := newMockTenantLimits(overrides)
+
+	ov := NewOverrides(limitsYAML, tl)
+	require.Equal(t, "legacy", ov.GetOverridesForUser("user1").NameValidationScheme.String())
+	require.Equal(t, "utf8", ov.GetOverridesForUser("user2").NameValidationScheme.String())
+}
+
 func TestAlertmanagerNotificationLimitsOverrides(t *testing.T) {
 	baseYaml := `
 alertmanager_notification_rate_limit: 5

pkg/util/validation/validate.go

@@ -285,7 +285,7 @@ func ValidateLabels(validateMetrics *ValidateMetrics, limits *Limits, userID str
 			return newNoMetricNameError()
 		}
 
-		if !model.IsValidMetricName(model.LabelValue(unsafeMetricName)) {
+		if !limits.NameValidationScheme.IsValidLabelName(unsafeMetricName) {
 			validateMetrics.DiscardedSamples.WithLabelValues(invalidMetricName, userID).Inc()
 			return newInvalidMetricNameError(unsafeMetricName)
 		}
@@ -304,7 +304,7 @@ func ValidateLabels(validateMetrics *ValidateMetrics, limits *Limits, userID str
 	labelsSizeBytes := 0
 
 	for _, l := range ls {
-		if !skipLabelNameValidation && !model.LabelName(l.Name).IsValid() {
+		if !skipLabelNameValidation && !limits.NameValidationScheme.IsValidLabelName(l.Name) {
 			validateMetrics.DiscardedSamples.WithLabelValues(invalidLabel, userID).Inc()
 			return newInvalidLabelError(ls, l.Name)
 		} else if len(l.Name) > maxLabelNameLength {

pkg/util/validation/validate_test.go

@@ -33,6 +33,7 @@ func TestValidateLabels(t *testing.T) {
 	cfg.MaxLabelNamesPerSeries = 2
 	cfg.MaxLabelsSizeBytes = 90
 	cfg.EnforceMetricName = true
+	cfg.NameValidationScheme = model.LegacyValidation
 	cfg.LimitsPerLabelSet = []LimitsPerLabelSet{
 		{
 			Limits: LimitsPerLabelSetEntry{MaxSeries: 0},
@@ -271,6 +272,7 @@ func TestValidateLabelOrder(t *testing.T) {
 	cfg.MaxLabelNameLength = 10
 	cfg.MaxLabelNamesPerSeries = 10
 	cfg.MaxLabelValueLength = 10
+	cfg.NameValidationScheme = model.LegacyValidation
 	reg := prometheus.NewRegistry()
 	validateMetrics := NewValidateMetrics(reg)
 	userID := "testUser"
@@ -299,6 +301,7 @@ func TestValidateLabelDuplication(t *testing.T) {
 	cfg.MaxLabelNameLength = 10
 	cfg.MaxLabelNamesPerSeries = 10
 	cfg.MaxLabelValueLength = 10
+	cfg.NameValidationScheme = model.LegacyValidation
 	reg := prometheus.NewRegistry()
 	validateMetrics := NewValidateMetrics(reg)
 	userID := "testUser"

schemas/cortex-config-schema.json

@@ -5184,6 +5184,12 @@
           "description": "List of metric relabel configurations. Note that in most situations, it is more effective to use metrics relabeling directly in the Prometheus server, e.g. remote_write.write_relabel_configs.",
           "type": "string"
         },
+        "name_validation_scheme": {
+          "default": "legacy",
+          "description": "Name validation scheme for metric names and label names, Support values are: legacy, utf8.",
+          "type": "number",
+          "x-cli-flag": "validation.name-validation-scheme"
+        },
         "native_histogram_ingestion_burst_size": {
           "default": 0,
           "description": "Per-user allowed native histogram ingestion burst size (in number of samples)",