feat: added name validation scheme as a config field and flag as well

CHANGELOG.md

@@ -39,6 +39,7 @@
 * [BUGFIX] Querier: Fix panic when marshaling QueryResultRequest. #6601
 * [BUGFIX] Ingester: Avoid resharding for query when restart readonly ingesters. #6642
 * [BUGFIX] Query Frontend: Fix query frontend per `user` metrics clean up. #6698
+* [FEATURE] Config: Name validation scheme for metric and label names can be set using the config file (`name_validation_scheme`) as well as a CLI flag (`-name.validation_scheme`)
 
 ## 1.19.0 2025-02-27
 

docs/configuration/config-file-reference.md

@@ -68,6 +68,11 @@ Where default_value is the value to use if the environment variable is undefined
 # CLI flag: -http.prefix
 [http_prefix: <string> | default = "/api/prom"]
 
+# Validation scheme for metric and label names. Set to utf8 to allow UTF-8 characters.
+# Set to legacy as default
+# CLI flag: -name.validation_scheme
+[name_validation_scheme: <string> | default = "legacy"]
+
 # Comma-separated list of resources to monitor. Supported values are cpu and
 # heap, which tracks metrics from github.com/prometheus/procfs and
 # runtime/metrics that are close estimates. Empty string to disable.

pkg/cortex/cortex.go

@@ -14,6 +14,8 @@ import (
 	"github.com/go-kit/log/level"
 	"github.com/pkg/errors"
 	"github.com/prometheus/client_golang/prometheus"
+	"github.com/prometheus/common/model"
+	prom_config "github.com/prometheus/prometheus/config"
 	"github.com/prometheus/prometheus/promql"
 	prom_storage "github.com/prometheus/prometheus/storage"
 	"github.com/weaveworks/common/server"
@@ -31,7 +33,6 @@ import (
 	"github.com/cortexproject/cortex/pkg/configs"
 	configAPI "github.com/cortexproject/cortex/pkg/configs/api"
 	"github.com/cortexproject/cortex/pkg/configs/db"
-	_ "github.com/cortexproject/cortex/pkg/cortex/configinit"
 	"github.com/cortexproject/cortex/pkg/cortex/storage"
 	"github.com/cortexproject/cortex/pkg/cortexpb"
 	"github.com/cortexproject/cortex/pkg/distributor"
@@ -90,11 +91,12 @@ var (
 
 // Config is the root config for Cortex.
 type Config struct {
-	Target             flagext.StringSliceCSV `yaml:"target"`
-	AuthEnabled        bool                   `yaml:"auth_enabled"`
-	PrintConfig        bool                   `yaml:"-"`
-	HTTPPrefix         string                 `yaml:"http_prefix"`
-	MonitoredResources flagext.StringSliceCSV `yaml:"monitored_resources"`
+	Target               flagext.StringSliceCSV `yaml:"target"`
+	AuthEnabled          bool                   `yaml:"auth_enabled"`
+	PrintConfig          bool                   `yaml:"-"`
+	HTTPPrefix           string                 `yaml:"http_prefix"`
+	NameValidationScheme string                 `yaml:"name_validation_scheme"`
+	MonitoredResources   flagext.StringSliceCSV `yaml:"monitored_resources"`
 
 	ExternalQueryable prom_storage.Queryable `yaml:"-"`
 	ExternalPusher    ruler.Pusher           `yaml:"-"`
@@ -146,6 +148,12 @@ func (c *Config) RegisterFlags(f *flag.FlagSet) {
 	f.BoolVar(&c.AuthEnabled, "auth.enabled", true, "Set to false to disable auth.")
 	f.BoolVar(&c.PrintConfig, "print.config", false, "Print the config and exit.")
 	f.StringVar(&c.HTTPPrefix, "http.prefix", "/api/prom", "HTTP path prefix for Cortex API.")
+	f.StringVar(&c.NameValidationScheme, "name.validation_scheme", prom_config.LegacyValidationConfig, "Validation scheme for metric and label names. Set to utf8 to allow UTF-8 characters. legacy by default")
+
+	// Setting name validation scheme as legacy if provided with an empty string
+	if c.NameValidationScheme == "" {
+		c.NameValidationScheme = prom_config.LegacyValidationConfig
+	}
 
 	c.MonitoredResources = []string{}
 	f.Var(&c.MonitoredResources, "monitored.resources", "Comma-separated list of resources to monitor. "+
@@ -193,6 +201,10 @@ func (c *Config) Validate(log log.Logger) error {
 		return errInvalidHTTPPrefix
 	}
 
+	if c.NameValidationScheme != "" && c.NameValidationScheme != prom_config.LegacyValidationConfig && c.NameValidationScheme != prom_config.UTF8ValidationConfig {
+		return fmt.Errorf("invalid name validation scheme")
+	}
+
 	if err := c.API.Validate(); err != nil {
 		return errors.Wrap(err, "invalid api config")
 	}
@@ -361,6 +373,16 @@ func New(cfg Config) (*Cortex, error) {
 		os.Exit(0)
 	}
 
+	// Sets the NameValidationScheme in prometheus/common
+	switch cfg.NameValidationScheme {
+	case "", prom_config.LegacyValidationConfig:
+		model.NameValidationScheme = model.LegacyValidation
+	case prom_config.UTF8ValidationConfig:
+		model.NameValidationScheme = model.UTF8Validation
+	default:
+		fmt.Errorf("invalid name validation scheme")
+	}
+
 	// Swap out the default resolver to support multiple tenant IDs separated by a '|'
 	if cfg.TenantFederation.Enabled {
 		util_log.WarnExperimentalUse("tenant-federation")

pkg/cortex/cortex_test.go

@@ -14,6 +14,7 @@ import (
 	"time"
 
 	"github.com/prometheus/client_golang/prometheus"
+	prom_config "github.com/prometheus/prometheus/config"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"github.com/weaveworks/common/server"
@@ -184,6 +185,43 @@ func TestConfigValidation(t *testing.T) {
 			},
 			expectedError: nil,
 		},
+		// NameValidationScheme tests
+		{
+			name: "should not fail validation for empty name validation scheme (use legacy by default)",
+			getTestConfig: func() *Config {
+				configuration := newDefaultConfig()
+				configuration.NameValidationScheme = ""
+				return configuration
+			},
+			expectedError: nil,
+		},
+		{
+			name: "should not fail validation for legacy name validation scheme",
+			getTestConfig: func() *Config {
+				configuration := newDefaultConfig()
+				configuration.NameValidationScheme = prom_config.LegacyValidationConfig
+				return configuration
+			},
+			expectedError: nil,
+		},
+		{
+			name: "should not fail validation for utf-8 name validation scheme",
+			getTestConfig: func() *Config {
+				configuration := newDefaultConfig()
+				configuration.NameValidationScheme = prom_config.UTF8ValidationConfig
+				return configuration
+			},
+			expectedError: nil,
+		},
+		{
+			name: "should fail validation for invalid name validation scheme",
+			getTestConfig: func() *Config {
+				configuration := newDefaultConfig()
+				configuration.NameValidationScheme = "invalid"
+				return configuration
+			},
+			expectedError: fmt.Errorf("invalid name validation scheme"),
+		},
 	} {
 		t.Run(tc.name, func(t *testing.T) {
 			err := tc.getTestConfig().Validate(nil)

pkg/distributor/distributor_test.go

@@ -35,7 +35,6 @@ import (
 	"google.golang.org/grpc/status"
 
 	promchunk "github.com/cortexproject/cortex/pkg/chunk/encoding"
-	_ "github.com/cortexproject/cortex/pkg/cortex/configinit"
 	"github.com/cortexproject/cortex/pkg/cortexpb"
 	"github.com/cortexproject/cortex/pkg/ha"
 	"github.com/cortexproject/cortex/pkg/ingester"

pkg/util/validation/validate_test.go

@@ -16,7 +16,6 @@ import (
 	"github.com/stretchr/testify/require"
 	"github.com/weaveworks/common/httpgrpc"
 
-	_ "github.com/cortexproject/cortex/pkg/cortex/configinit"
 	"github.com/cortexproject/cortex/pkg/cortexpb"
 	util_log "github.com/cortexproject/cortex/pkg/util/log"
 )