Handle deployment.environment.name

If `deployment.environment.name` is set, we duplicate it into `deployment.environment` in order to make the `service.environment` -> `deployment.environment` work.

Author: gregkalapos

enrichments/trace/config/config.go

@@ -28,9 +28,10 @@ type Config struct {
 
 // ResourceConfig configures the enrichment of resource attributes.
 type ResourceConfig struct {
-	AgentName        AttributeConfig `mapstructure:"agent_name"`
-	AgentVersion     AttributeConfig `mapstructure:"agent_version"`
-	OverrideHostName AttributeConfig `mapstructure:"override_host_name"`
+	AgentName             AttributeConfig `mapstructure:"agent_name"`
+	AgentVersion          AttributeConfig `mapstructure:"agent_version"`
+	OverrideHostName      AttributeConfig `mapstructure:"override_host_name"`
+	DeploymentEnvironment AttributeConfig `mapstructure:"deployment_environment"`
 }
 
 // ScopeConfig configures the enrichment of scope attributes.
@@ -103,9 +104,10 @@ type AttributeConfig struct {
 func Enabled() Config {
 	return Config{
 		Resource: ResourceConfig{
-			AgentName:        AttributeConfig{Enabled: true},
-			AgentVersion:     AttributeConfig{Enabled: true},
-			OverrideHostName: AttributeConfig{Enabled: true},
+			AgentName:             AttributeConfig{Enabled: true},
+			AgentVersion:          AttributeConfig{Enabled: true},
+			OverrideHostName:      AttributeConfig{Enabled: true},
+			DeploymentEnvironment: AttributeConfig{Enabled: true},
 		},
 		Scope: ScopeConfig{
 			ServiceFrameworkName:    AttributeConfig{Enabled: true},

enrichments/trace/internal/elastic/resource.go

@@ -23,7 +23,8 @@ import (
 	"github.com/elastic/opentelemetry-lib/elasticattr"
 	"github.com/elastic/opentelemetry-lib/enrichments/trace/config"
 	"go.opentelemetry.io/collector/pdata/pcommon"
-	semconv "go.opentelemetry.io/collector/semconv/v1.25.0"
+	semconv25 "go.opentelemetry.io/collector/semconv/v1.25.0"
+	semconv "go.opentelemetry.io/collector/semconv/v1.27.0"
 )
 
 // EnrichResource derives and adds Elastic specific resource attributes.
@@ -73,6 +74,22 @@ func (s *resourceEnrichmentContext) Enrich(resource pcommon.Resource, cfg config
 	if cfg.OverrideHostName.Enabled {
 		s.overrideHostNameWithK8sNodeName(resource)
 	}
+
+	if cfg.DeploymentEnvironment.Enabled {
+		s.setDeploymentEnvironment(resource)
+	}
+}
+
+// SemConv v1.27.0 deprecated `deployment.environment` and added `deployment.environment.name` in favor of it.
+// In the `otel-data` ES plugin we alias `service.environment` to `deployment.environment`.
+// ES currently doesn't allow aliases with multiple targets, so if the new field name is used (SemConv v1.27+),
+// we duplicate the value and also send it with the old field name to make the alias work.
+func (s *resourceEnrichmentContext) setDeploymentEnvironment(resource pcommon.Resource) {
+	if deploymentEnvironmentName, deploymentEnvironmentNameExists := resource.Attributes().Get(semconv.AttributeDeploymentEnvironmentName); deploymentEnvironmentNameExists {
+		if _, deploymentEnvironmentExists := resource.Attributes().Get(semconv25.AttributeDeploymentEnvironment); !deploymentEnvironmentExists {
+			resource.Attributes().PutStr(semconv25.AttributeDeploymentEnvironment, deploymentEnvironmentName.AsString())
+		}
+	}
 }
 
 func (s *resourceEnrichmentContext) setAgentName(resource pcommon.Resource) {

enrichments/trace/internal/elastic/resource_test.go

@@ -25,7 +25,8 @@ import (
 	"github.com/google/go-cmp/cmp"
 	"github.com/stretchr/testify/assert"
 	"go.opentelemetry.io/collector/pdata/pcommon"
-	semconv "go.opentelemetry.io/collector/semconv/v1.25.0"
+	semconv25 "go.opentelemetry.io/collector/semconv/v1.25.0"
+	semconv "go.opentelemetry.io/collector/semconv/v1.27.0"
 )
 
 func TestResourceEnrich(t *testing.T) {
@@ -194,6 +195,56 @@ func TestResourceEnrich(t *testing.T) {
 				elasticattr.AgentVersion:     "unknown",
 			},
 		},
+		{
+			// Pre SemConv 1.27
+			name: "deployment_environment_set",
+			input: func() pcommon.Resource {
+				res := pcommon.NewResource()
+				res.Attributes().PutStr(semconv25.AttributeDeploymentEnvironment, "prod")
+				return res
+			}(),
+			config: config.Enabled().Resource,
+			enrichedAttrs: map[string]any{
+				semconv25.AttributeDeploymentEnvironment: "prod",
+				elasticattr.AgentName:                    "otlp",
+				elasticattr.AgentVersion:                 "unknown",
+			},
+		},
+		{
+			// SemConv 1.27+ with new `deployment.environment.name` field
+			name: "deployment_environment_name_set",
+			input: func() pcommon.Resource {
+				res := pcommon.NewResource()
+				res.Attributes().PutStr(semconv.AttributeDeploymentEnvironmentName, "prod")
+				return res
+			}(),
+			config: config.Enabled().Resource,
+			enrichedAttrs: map[string]any{
+				// To satisfy aliases defined in ES, we duplicate the value for both fields.
+				semconv25.AttributeDeploymentEnvironment:   "prod",
+				semconv.AttributeDeploymentEnvironmentName: "prod",
+				elasticattr.AgentName:                      "otlp",
+				elasticattr.AgentVersion:                   "unknown",
+			},
+		},
+		{
+			// Mixed pre and post SemConv 1.27 versions (should be an edge case, but some EDOTs might do this).
+			name: "deployment_environment_mixed",
+			input: func() pcommon.Resource {
+				res := pcommon.NewResource()
+				res.Attributes().PutStr(semconv.AttributeDeploymentEnvironmentName, "prod")
+				res.Attributes().PutStr(semconv25.AttributeDeploymentEnvironment, "test")
+				return res
+			}(),
+			config: config.Enabled().Resource,
+			enrichedAttrs: map[string]any{
+				// If both are set, we don't touch those values and take them as they are.
+				semconv25.AttributeDeploymentEnvironment:   "test",
+				semconv.AttributeDeploymentEnvironmentName: "prod",
+				elasticattr.AgentName:                      "otlp",
+				elasticattr.AgentVersion:                   "unknown",
+			},
+		},
 	} {
 		t.Run(tc.name, func(t *testing.T) {
 			// Merge existing resource attrs with the attrs added