fix cluster name resolved path

Paamicky · Paamicky · commit f42dcc32a4ee · 2026-07-20T20:57:34.000Z
diff --git a/translator/cmdutil/translatorutil_test.go b/translator/cmdutil/translatorutil_test.go
@@ -451,12 +451,6 @@ func TestOpenTelemetryWindowsEventsInvalidSchemaValidation(t *testing.T) {
 	})
 }
 
-func TestOpenTelemetryInvalidClusterNameSchemaValidation(t *testing.T) {
-	checkIfSchemaValidateAsExpected(t, "../../translator/config/sampleSchema/opentelemetry/invalidClusterName.json", false, map[string]int{
-		"pattern": 1,
-	})
-}
-
 func TestCombinedV1V2SchemaValidation(t *testing.T) {
 	checkIfSchemaValidateAsExpected(t, "../../translator/config/sampleSchema/opentelemetry/validCombinedV1V2Config.json", true, map[string]int{})
 }
diff --git a/translator/config/sampleSchema/opentelemetry/invalidClusterName.json b/translator/config/sampleSchema/opentelemetry/invalidClusterName.json
diff --git a/translator/config/schema.json b/translator/config/schema.json
@@ -1808,8 +1808,7 @@
       "properties": {
         "cluster_name": {
           "description": "The name of the K8s cluster. Applied to all telemetry collected under opentelemetry.",
-          "type": "string",
-          "pattern": "^[0-9A-Za-z][A-Za-z0-9\\-_]*$"
+          "type": "string"
         },
         "collect": {
           "type": "object",
diff --git a/translator/translate/otel/common/common.go b/translator/translate/otel/common/common.go
@@ -8,6 +8,7 @@ import (
 	"fmt"
 	"os"
 	"reflect"
+	"regexp"
 	"strconv"
 	"strings"
 	"time"
@@ -556,9 +557,9 @@ func SanitizeName(input string) string {
 	}, strings.ToLower(input))
 }
 
-func GetClusterName(conf *confmap.Conf) string {
-	val, ok := GetString(conf, ConfigKey(LogsKey, MetricsCollectedKey, KubernetesKey, "cluster_name"))
-	if ok && val != "" {
+func GetClusterName(conf *confmap.Conf, key string) string {
+	// Check any config keys passed
+	if val, ok := GetString(conf, key); ok && val != "" {
 		return val
 	}
 
@@ -598,3 +599,17 @@ func EscapeDollarDigit(s string) string {
 
 // OtelClusterNameKey is the config key for the root-level cluster name under opentelemetry.
 var OtelClusterNameKey = ConfigKey(OpenTelemetryKey, ClusterNameKey)
+
+// LegacyClusterNameKey is the config key for the cluster name in the V1 config path.
+var LegacyClusterNameKey = ConfigKey(LogsKey, MetricsCollectedKey, KubernetesKey, ClusterNameKey)
+
+// ClusterNameRegex validates cluster names.
+var ClusterNameRegex = regexp.MustCompile(`^[0-9A-Za-z][A-Za-z0-9\-_]*$`)
+
+// ValidateClusterName returns an error if the cluster name does not match the expected pattern.
+func ValidateClusterName(name string) error {
+	if !ClusterNameRegex.MatchString(name) {
+		return fmt.Errorf("cluster_name %q is invalid: must match pattern %s", name, ClusterNameRegex.String())
+	}
+	return nil
+}
diff --git a/translator/translate/otel/exporter/awsemf/prometheus.go b/translator/translate/otel/exporter/awsemf/prometheus.go
@@ -39,7 +39,7 @@ func setPrometheusLogGroup(conf *confmap.Conf, cfg *awsemfexporter.Config) error
 			}
 		} else {
 
-			if clusterName := common.GetClusterName(conf); clusterName != "" {
+			if clusterName := common.GetClusterName(conf, common.LegacyClusterNameKey); clusterName != "" {
 				cfg.LogGroupName = fmt.Sprintf(eksDefaultLogGroupFormat, clusterName)
 			}
 		}
diff --git a/translator/translate/otel/pipeline/opentelemetry/containerinsights/common.go b/translator/translate/otel/pipeline/opentelemetry/containerinsights/common.go
@@ -75,9 +75,12 @@ func (t *yamlComponentTranslator) Translate(_ *confmap.Conf) (component.Config,
 }
 
 func getClusterName(conf *confmap.Conf) (string, error) {
-	name, _ := common.GetString(conf, common.OtelClusterNameKey)
+	name := common.GetClusterName(conf, common.OtelClusterNameKey)
 	if name == "" {
-		return "", fmt.Errorf("cluster_name is required for container_insights: set opentelemetry::cluster_name in config")
+		return "", fmt.Errorf("cluster_name is required for container_insights: set opentelemetry::cluster_name in config or K8S_CLUSTER_NAME environment variable")
+	}
+	if err := common.ValidateClusterName(name); err != nil {
+		return "", err
 	}
 	return name, nil
 }
diff --git a/translator/translate/otel/pipeline/opentelemetry/translator_logs.go b/translator/translate/otel/pipeline/opentelemetry/translator_logs.go
@@ -113,7 +113,11 @@ func (t *baseLogsTranslator) Translate(conf *confmap.Conf) (*common.ComponentTra
 		processors.Set(k8sattributesprocessor.NewTranslator(common.OpenTelemetryKey))
 	}
 	// Apply root-level cluster name if set
-	if clusterName, ok := common.GetString(conf, common.OtelClusterNameKey); ok && clusterName != "" {
+	clusterName := common.GetClusterName(conf, common.OtelClusterNameKey)
+	if clusterName != "" {
+		if err := common.ValidateClusterName(clusterName); err != nil {
+			return nil, err
+		}
 		stmt := fmt.Sprintf(`set(resource.attributes["k8s.cluster.name"], "%s")`, clusterName)
 		processors.Set(transformprocessor.NewTranslatorWithName("set_cluster_name",
 			transformprocessor.WithMetricResourceStatements([]string{stmt}),
diff --git a/translator/translate/otel/pipeline/opentelemetry/translator_metrics.go b/translator/translate/otel/pipeline/opentelemetry/translator_metrics.go
@@ -64,7 +64,11 @@ func (t *baseMetricsTranslator) Translate(conf *confmap.Conf) (*common.Component
 		processors.Set(k8sattributesprocessor.NewTranslator(common.OpenTelemetryKey))
 	}
 	// Apply root-level cluster name if set
-	if clusterName, ok := common.GetString(conf, common.OtelClusterNameKey); ok && clusterName != "" {
+	clusterName := common.GetClusterName(conf, common.OtelClusterNameKey)
+	if clusterName != "" {
+		if err := common.ValidateClusterName(clusterName); err != nil {
+			return nil, err
+		}
 		stmt := fmt.Sprintf(`set(resource.attributes["k8s.cluster.name"], "%s")`, clusterName)
 		processors.Set(transformprocessor.NewTranslatorWithName("set_cluster_name",
 			transformprocessor.WithMetricResourceStatements([]string{stmt}),
diff --git a/translator/translate/otel/pipeline/opentelemetry/translator_traces.go b/translator/translate/otel/pipeline/opentelemetry/translator_traces.go
@@ -59,7 +59,11 @@ func (t *baseTracesTranslator) Translate(conf *confmap.Conf) (*common.ComponentT
 		processors.Set(k8sattributesprocessor.NewTranslator(common.OpenTelemetryKey))
 	}
 	// Apply root-level cluster name if set
-	if clusterName, ok := common.GetString(conf, common.OtelClusterNameKey); ok && clusterName != "" {
+	clusterName := common.GetClusterName(conf, common.OtelClusterNameKey)
+	if clusterName != "" {
+		if err := common.ValidateClusterName(clusterName); err != nil {
+			return nil, err
+		}
 		stmt := fmt.Sprintf(`set(resource.attributes["k8s.cluster.name"], "%s")`, clusterName)
 		processors.Set(transformprocessor.NewTranslatorWithName("set_cluster_name",
 			transformprocessor.WithMetricResourceStatements([]string{stmt}),
diff --git a/translator/translate/otel/processor/awsapplicationsignals/translator.go b/translator/translate/otel/processor/awsapplicationsignals/translator.go
@@ -67,7 +67,7 @@ func (t *translator) Translate(conf *confmap.Conf) (component.Config, error) {
 	hostedIn, hostedInConfigured := common.GetHostedIn(conf)
 	if common.IsAppSignalsKubernetes() {
 		if !hostedInConfigured {
-			hostedIn = common.GetClusterName(conf)
+			hostedIn = common.GetClusterName(conf, common.LegacyClusterNameKey)
 		}
 	}
 
diff --git a/translator/translate/otel/processor/awsentity/translator.go b/translator/translate/otel/processor/awsentity/translator.go
@@ -103,7 +103,7 @@ func (t *translator) Translate(conf *confmap.Conf) (component.Config, error) {
 		clusterName, clusterNameConfigured := common.GetHostedIn(conf)
 
 		if !clusterNameConfigured {
-			clusterName = common.GetClusterName(conf)
+			clusterName = common.GetClusterName(conf, common.LegacyClusterNameKey)
 		}
 
 		cfg.ClusterName = clusterName
diff --git a/translator/translate/otel/processor/resourceprocessor/translator.go b/translator/translate/otel/processor/resourceprocessor/translator.go
@@ -137,7 +137,7 @@ func (t *translator) getJMXAttributes(conf *confmap.Conf) []any {
 }
 
 func (t *translator) getContainerInsightsJMXAttributes(conf *confmap.Conf) []any {
-	clusterName := common.GetClusterName(conf)
+	clusterName := common.GetClusterName(conf, common.LegacyClusterNameKey)
 	nodeName := os.Getenv(config.HOST_NAME)
 	return []any{
 		map[string]any{
diff --git a/translator/translate/otel/receiver/awscontainerinsight/translator.go b/translator/translate/otel/receiver/awscontainerinsight/translator.go
@@ -130,7 +130,7 @@ func (t *translator) Translate(conf *confmap.Conf) (component.Config, error) {
 }
 
 func (t *translator) setClusterName(conf *confmap.Conf, cfg *awscontainerinsightreceiver.Config) error {
-	cfg.ClusterName = common.GetClusterName(conf)
+	cfg.ClusterName = common.GetClusterName(conf, common.LegacyClusterNameKey)
 
 	if cfg.ClusterName == "" {
 		return errors.New("cluster name is not provided and was not auto-detected from EC2 tags")
diff --git a/translator/translate/otel/receiver/awscontainerinsightskueue/translator.go b/translator/translate/otel/receiver/awscontainerinsightskueue/translator.go
@@ -59,7 +59,7 @@ func (t *translator) Translate(conf *confmap.Conf) (component.Config, error) {
 }
 
 func (t *translator) setClusterName(conf *confmap.Conf, cfg *awscontainerinsightskueuereceiver.Config) error {
-	cfg.ClusterName = common.GetClusterName(conf)
+	cfg.ClusterName = common.GetClusterName(conf, common.LegacyClusterNameKey)
 
 	if cfg.ClusterName == "" {
 		return errors.New("cluster name is not provided and was not auto-detected from EC2 tags")

Original file line number	Diff line number	Diff line change
`@@ -451,12 +451,6 @@ func TestOpenTelemetryWindowsEventsInvalidSchemaValidation(t *testing.T) {`
`451`	`451`	`})`
`452`	`452`	`}`
`453`	`453`
`454`		`-func TestOpenTelemetryInvalidClusterNameSchemaValidation(t *testing.T) {`
`455`		`- checkIfSchemaValidateAsExpected(t, "../../translator/config/sampleSchema/opentelemetry/invalidClusterName.json", false, map[string]int{`
`456`		`- "pattern": 1,`
`457`		`- })`
`458`		`-}`
`459`		`-`
`460`	`454`	`func TestCombinedV1V2SchemaValidation(t *testing.T) {`
`461`	`455`	`checkIfSchemaValidateAsExpected(t, "../../translator/config/sampleSchema/opentelemetry/validCombinedV1V2Config.json", true, map[string]int{})`
`462`	`456`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ func setPrometheusLogGroup(conf confmap.Conf, cfg awsemfexporter.Config) error`
`39`	`39`	`}`
`40`	`40`	`} else {`
`41`	`41`
`42`		`- if clusterName := common.GetClusterName(conf); clusterName != "" {`
	`42`	`+ if clusterName := common.GetClusterName(conf, common.LegacyClusterNameKey); clusterName != "" {`
`43`	`43`	`cfg.LogGroupName = fmt.Sprintf(eksDefaultLogGroupFormat, clusterName)`
`44`	`44`	`}`
`45`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -75,9 +75,12 @@ func (t yamlComponentTranslator) Translate(_ confmap.Conf) (component.Config,`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`func getClusterName(conf *confmap.Conf) (string, error) {`
`78`		`- name, _ := common.GetString(conf, common.OtelClusterNameKey)`
	`78`	`+ name := common.GetClusterName(conf, common.OtelClusterNameKey)`
`79`	`79`	`if name == "" {`
`80`		`- return "", fmt.Errorf("cluster_name is required for container_insights: set opentelemetry::cluster_name in config")`
	`80`	`+ return "", fmt.Errorf("cluster_name is required for container_insights: set opentelemetry::cluster_name in config or K8S_CLUSTER_NAME environment variable")`
	`81`	`+ }`
	`82`	`+ if err := common.ValidateClusterName(name); err != nil {`
	`83`	`+ return "", err`
`81`	`84`	`}`
`82`	`85`	`return name, nil`
`83`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ func (t translator) Translate(conf confmap.Conf) (component.Config, error) {`
`67`	`67`	`hostedIn, hostedInConfigured := common.GetHostedIn(conf)`
`68`	`68`	`if common.IsAppSignalsKubernetes() {`
`69`	`69`	`if !hostedInConfigured {`
`70`		`- hostedIn = common.GetClusterName(conf)`
	`70`	`+ hostedIn = common.GetClusterName(conf, common.LegacyClusterNameKey)`
`71`	`71`	`}`
`72`	`72`	`}`
`73`	`73`