Added name validation scheme as a config field and flag as well #6733

av153k · 2025-05-08T06:58:58Z

What this PR does:

Adds name_validation_scheme as yaml flag and name.validation.scheme as a flag
Remove config init and set the model.NameValidationScheme directly in New() method to creating a Cortex object

Which issue(s) this PR fixes:
Fixes #6702

Checklist

Tests updated
Documentation added
CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

Signed-off-by: Abhishek Anand <[email protected]>

av153k · 2025-05-08T09:54:40Z

I am working on the tests for this.

Signed-off-by: Abhishek Anand <[email protected]>

av153k · 2025-05-10T13:50:16Z

Added test for name validation scheme in TestConfigValidation in cortex_test.go

yeya24

Thanks @av153k. Great work and I think it is on the right track. Just few comments

pkg/cortex/configinit/init.go

yeya24 · 2025-05-10T23:29:57Z

pkg/cortex/cortex.go

@@ -193,6 +196,10 @@ func (c *Config) Validate(log log.Logger) error {
 		return errInvalidHTTPPrefix
 	}

+	if c.NameValidationScheme != "" && c.NameValidationScheme != "legacy" && c.NameValidationScheme != "utf-8" {


You can just import and use the string constants from Prometheus https://github.com/prometheus/prometheus/blob/ba4b058b7ab60105e03f83380cc3200a8a66e52f/config/config.go#L72

We need to also handle the case where c.NameValidationScheme is empty and we should use the legacy scheme

The empty case will be handled when we create a new context object as you can see later on in the file.

And in the validation, it does check for non-empty string to validate so I think that will pass as well. Let me know if I need to add something else as well.

I have made the changes and allowed for legacy to be used by default in method to create a new cortex object.

Let's unify the code to make it cleaner. You can just use a single switch statement.

switch c.NameValidationScheme { case "", prom_config.LegacyValidationConfig: model.NameValidationScheme = model.LegacyValidation case prom_config.UTF8ValidationConfig: model.NameValidationScheme = model.UTF8Validation default: // return invalid error }

yeya24 · 2025-05-10T23:31:40Z

pkg/cortex/cortex.go

@@ -146,6 +148,7 @@ 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", "strict", "Used to set name validation scheme in prometheus common. legacy by default")


The default value should be legacy instead of strict.

Let's call the flag name.validation_scheme.
For flag description, let's make it easier for users to understand. How about Validation scheme for metric and label names. Set to utf8 to allow UTF-8 characters.

Fixed this in the latest commit.

You need to regenerate the doc after updating flag description

I made the changes to the doc config-file-reference.md but missed including it in the commit. I am assuming you mean that, or is there any command to generate the docs automatically?

If you do make docs it can generate docs automatically

…andled empty name validation scheme and related tests Signed-off-by: Abhishek Anand <[email protected]>

yeya24

Can you also update changelog?

yeya24 · 2025-05-11T08:02:14Z

pkg/cortex/cortex_test.go

+			name: "should not fail validation for utf-8 name validation scheme",
+			getTestConfig: func() *Config {
+				configuration := newDefaultConfig()
+				configuration.NameValidationScheme = "utf-8"


Let's use const here

const as in from prometheus config, right?

yeya24 · 2025-05-11T08:02:18Z

pkg/cortex/cortex_test.go

+			name: "should not fail validation for legacy name validation scheme",
+			getTestConfig: func() *Config {
+				configuration := newDefaultConfig()
+				configuration.NameValidationScheme = "legacy"


Let's use const here

yeya24 · 2025-05-11T08:03:18Z

pkg/cortex/cortex_test.go

+			expectedError: nil,
+		},
+		{
+			name: "should fail validation for invalid(anything other than legacy and utf-8) name validation scheme",


You can just say should fail validation for invalid name validation scheme. No need to mention legacy and utf8

av153k · 2025-05-11T12:57:05Z

Can you also update changelog?

What would be the version of this change, though?

… in the config file and CLI flag, along with corresponding tests. Signed-off-by: Abhishek Anand <[email protected]>

yeya24 · 2025-05-11T17:49:55Z

pkg/cortex/cortex.go

+	// Setting name validation scheme as legacy if provided with an empty string
+	if c.NameValidationScheme == "" {
+		c.NameValidationScheme = prom_config.LegacyValidationConfig
+	}


We can remove this code now as it will be handled in the switch statement

yeya24 · 2025-05-11T17:49:58Z

pkg/cortex/cortex.go

@@ -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")
+	}


We can remove this code now as it will be handled in the switch statement

yeya24 · 2025-05-11T17:51:15Z

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`)


Let's move the changelog entry to L14. Features are put together

pull-request-size bot added the size/M label May 8, 2025

Added name validation scheme as a config field and flag as well

146188f

Signed-off-by: Abhishek Anand <[email protected]>

av153k force-pushed the feat/namevalidationscheme-flag branch from 2186312 to 146188f Compare May 8, 2025 07:00

av153k marked this pull request as ready for review May 8, 2025 09:54

dosubot bot added the component/documentation label May 8, 2025

Added tests for name validation scheme

2d7737b

Signed-off-by: Abhishek Anand <[email protected]>

yeya24 reviewed May 10, 2025

View reviewed changes

Removed configinit, replaces string with constants from prometheus, h…

9e161d9

…andled empty name validation scheme and related tests Signed-off-by: Abhishek Anand <[email protected]>

yeya24 reviewed May 11, 2025

View reviewed changes

Added name validation scheme configuration for metric and label names…

c5acc77

… in the config file and CLI flag, along with corresponding tests. Signed-off-by: Abhishek Anand <[email protected]>

yeya24 reviewed May 11, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added name validation scheme as a config field and flag as well #6733

Added name validation scheme as a config field and flag as well #6733

av153k commented May 8, 2025 •

edited

Loading

av153k commented May 8, 2025

av153k commented May 10, 2025

yeya24 left a comment •

edited

Loading

yeya24 May 10, 2025

yeya24 May 10, 2025

av153k May 11, 2025

av153k May 11, 2025

yeya24 May 11, 2025

yeya24 May 10, 2025

av153k May 11, 2025

yeya24 May 11, 2025

av153k May 11, 2025

yeya24 May 11, 2025

yeya24 left a comment

yeya24 May 11, 2025

av153k May 11, 2025

yeya24 May 11, 2025

yeya24 May 11, 2025

av153k commented May 11, 2025

yeya24 May 11, 2025

yeya24 May 11, 2025

yeya24 May 11, 2025

Added name validation scheme as a config field and flag as well #6733

Are you sure you want to change the base?

Added name validation scheme as a config field and flag as well #6733

Conversation

av153k commented May 8, 2025 • edited Loading

av153k commented May 8, 2025

av153k commented May 10, 2025

yeya24 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yeya24 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

av153k commented May 11, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

av153k commented May 8, 2025 •

edited

Loading

yeya24 left a comment •

edited

Loading