Update span enrichment to preserve existing values for: span.type, span.subtype, service.target.type, service.target.name, span.destination.service.resource.

isaacaflores2 · isaacaflores2 · commit 1df26abd6af7 · 2025-11-07T15:52:36.000-08:00
This allows any events that have been received using the `elasticapmintake receiver` to retain their original values.
diff --git a/enrichments/internal/elastic/span.go b/enrichments/internal/elastic/span.go
@@ -29,8 +29,6 @@ import (
 	"net/url"
 	"strconv"
 
-	"github.com/elastic/opentelemetry-lib/elasticattr"
-	"github.com/elastic/opentelemetry-lib/enrichments/config"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/sampling"
 	"github.com/ua-parser/uap-go/uaparser"
 	"go.opentelemetry.io/collector/pdata/pcommon"
@@ -40,6 +38,9 @@ import (
 	semconv37 "go.opentelemetry.io/otel/semconv/v1.37.0"
 	tracepb "go.opentelemetry.io/proto/otlp/trace/v1"
 	"google.golang.org/grpc/codes"
+
+	"github.com/elastic/opentelemetry-lib/elasticattr"
+	"github.com/elastic/opentelemetry-lib/enrichments/config"
 )
 
 // defaultRepresentativeCount is the representative count to use for adjusting
@@ -444,9 +445,14 @@ func (s *spanEnrichmentContext) setSpanTypeSubtype(span ptrace.Span) (spanType s
 		}
 	}
 
-	span.Attributes().PutStr(elasticattr.SpanType, spanType)
+	// do not overwrite existing span.type and span.subtype attributes
+	if existingSpanType, _ := span.Attributes().Get(elasticattr.SpanType); existingSpanType.Str() == "" {
+		span.Attributes().PutStr(elasticattr.SpanType, spanType)
+	}
 	if spanSubtype != "" {
-		span.Attributes().PutStr(elasticattr.SpanSubtype, spanSubtype)
+		if existingSpanSubtype, _ := span.Attributes().Get(elasticattr.SpanSubtype); existingSpanSubtype.Str() == "" {
+			span.Attributes().PutStr(elasticattr.SpanSubtype, spanSubtype)
+		}
 	}
 
 	return spanType, spanSubtype
@@ -494,9 +500,15 @@ func (s *spanEnrichmentContext) setServiceTarget(span ptrace.Span) {
 		}
 	}
 
+	// set either target.type or target.name if at least one is available
 	if targetType != "" || targetName != "" {
-		span.Attributes().PutStr(elasticattr.ServiceTargetType, targetType)
-		span.Attributes().PutStr(elasticattr.ServiceTargetName, targetName)
+		// do not overwrite existing target.type and target.name attributes
+		if existingTargetType, _ := span.Attributes().Get(elasticattr.ServiceTargetType); existingTargetType.Str() == "" {
+			span.Attributes().PutStr(elasticattr.ServiceTargetType, targetType)
+		}
+		if existingTargetName, _ := span.Attributes().Get(elasticattr.ServiceTargetName); existingTargetName.Str() == "" {
+			span.Attributes().PutStr(elasticattr.ServiceTargetName, targetName)
+		}
 	}
 }
 
@@ -536,7 +548,10 @@ func (s *spanEnrichmentContext) setDestinationService(span ptrace.Span) {
 	}
 
 	if destnResource != "" {
-		span.Attributes().PutStr(elasticattr.SpanDestinationServiceResource, destnResource)
+		// do not overwrite existing span.destination.service.resource attribute
+		if existingDestnResource, _ := span.Attributes().Get(elasticattr.SpanDestinationServiceResource); existingDestnResource.Str() == "" {
+			span.Attributes().PutStr(elasticattr.SpanDestinationServiceResource, destnResource)
+		}
 	}
 }
 
diff --git a/enrichments/internal/elastic/span_test.go b/enrichments/internal/elastic/span_test.go
@@ -24,8 +24,6 @@ import (
 	"testing"
 	"time"
 
-	"github.com/elastic/opentelemetry-lib/elasticattr"
-	"github.com/elastic/opentelemetry-lib/enrichments/config"
 	"github.com/google/go-cmp/cmp"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatatest/ptracetest"
 	"github.com/stretchr/testify/assert"
@@ -37,6 +35,9 @@ import (
 	semconv37 "go.opentelemetry.io/otel/semconv/v1.37.0"
 	tracepb "go.opentelemetry.io/proto/otlp/trace/v1"
 	"google.golang.org/grpc/codes"
+
+	"github.com/elastic/opentelemetry-lib/elasticattr"
+	"github.com/elastic/opentelemetry-lib/enrichments/config"
 )
 
 // Tests the enrichment logic for elastic's transaction definition.
@@ -931,6 +932,39 @@ func TestElasticSpanEnrich(t *testing.T) {
 				elasticattr.SpanDestinationServiceResource: "testsvc",
 			},
 		},
+		{
+			name: "http_span_with_existing_attributes_are_preserved",
+			input: func() ptrace.Span {
+				span := getElasticSpan()
+				span.SetName("testspan")
+				span.Attributes().PutStr(string(semconv25.PeerServiceKey), "testsvc")
+				span.Attributes().PutInt(
+					string(semconv25.HTTPResponseStatusCodeKey),
+					http.StatusOK,
+				)
+				span.Attributes().PutStr(elasticattr.SpanType, "external-test")
+				span.Attributes().PutStr(elasticattr.SpanSubtype, "http-test")
+				span.Attributes().PutStr(elasticattr.ServiceTargetName, "api.example.com")
+				span.Attributes().PutStr(elasticattr.ServiceTargetType, "http-test")
+				span.Attributes().PutStr(elasticattr.SpanDestinationServiceResource, "api.example.com:443")
+				return span
+			}(),
+			config: config.Enabled().Span,
+			enrichedAttrs: map[string]any{
+				elasticattr.TimestampUs:                    startTs.AsTime().UnixMicro(),
+				elasticattr.SpanName:                       "testspan",
+				elasticattr.ProcessorEvent:                 "span",
+				elasticattr.SpanRepresentativeCount:        float64(1),
+				elasticattr.SpanType:                       "external-test",
+				elasticattr.SpanSubtype:                    "http-test",
+				elasticattr.SpanDurationUs:                 expectedDuration.Microseconds(),
+				elasticattr.EventOutcome:                   "success",
+				elasticattr.SuccessCount:                   int64(1),
+				elasticattr.ServiceTargetType:              "http-test",
+				elasticattr.ServiceTargetName:              "api.example.com",
+				elasticattr.SpanDestinationServiceResource: "api.example.com:443",
+			},
+		},
 		{
 			name: "http_span_full_url",
 			input: func() ptrace.Span {
@@ -1059,6 +1093,39 @@ func TestElasticSpanEnrich(t *testing.T) {
 				elasticattr.SpanDestinationServiceResource: "testsvc",
 			},
 		},
+		{
+			name: "rpc_span_grpc_with_existing_attributes_are_preserved",
+			input: func() ptrace.Span {
+				span := getElasticSpan()
+				span.SetName("testspan")
+				span.Attributes().PutStr(string(semconv25.PeerServiceKey), "testsvc")
+				span.Attributes().PutInt(
+					string(semconv25.RPCGRPCStatusCodeKey),
+					int64(codes.OK),
+				)
+				span.Attributes().PutStr(elasticattr.SpanType, "external-test")
+				span.Attributes().PutStr(elasticattr.SpanSubtype, "grpc-test")
+				span.Attributes().PutStr(elasticattr.ServiceTargetName, "myservice.EchoService")
+				span.Attributes().PutStr(elasticattr.ServiceTargetType, "grpc-test")
+				span.Attributes().PutStr(elasticattr.SpanDestinationServiceResource, "api.example.com:443")
+				return span
+			}(),
+			config: config.Enabled().Span,
+			enrichedAttrs: map[string]any{
+				elasticattr.TimestampUs:                    startTs.AsTime().UnixMicro(),
+				elasticattr.SpanName:                       "testspan",
+				elasticattr.ProcessorEvent:                 "span",
+				elasticattr.SpanRepresentativeCount:        float64(1),
+				elasticattr.SpanType:                       "external-test",
+				elasticattr.SpanSubtype:                    "grpc-test",
+				elasticattr.SpanDurationUs:                 expectedDuration.Microseconds(),
+				elasticattr.EventOutcome:                   "success",
+				elasticattr.SuccessCount:                   int64(1),
+				elasticattr.ServiceTargetType:              "grpc-test",
+				elasticattr.ServiceTargetName:              "myservice.EchoService",
+				elasticattr.SpanDestinationServiceResource: "api.example.com:443",
+			},
+		},
 		{
 			name: "rpc_span_system",
 			input: func() ptrace.Span {
@@ -1187,6 +1254,36 @@ func TestElasticSpanEnrich(t *testing.T) {
 				elasticattr.SpanDestinationServiceResource: "testsvc",
 			},
 		},
+		{
+			name: "messaging_with_existing_attributes_are_preserved",
+			input: func() ptrace.Span {
+				span := getElasticSpan()
+				span.SetName("testspan")
+				span.Attributes().PutStr(string(semconv25.PeerServiceKey), "testsvc")
+				span.Attributes().PutStr(string(semconv25.MessagingSystemKey), "kafka")
+				span.Attributes().PutStr(elasticattr.SpanType, "messaging-test")
+				span.Attributes().PutStr(elasticattr.SpanSubtype, "kafka-test")
+				span.Attributes().PutStr(elasticattr.ServiceTargetName, "user-events")
+				span.Attributes().PutStr(elasticattr.ServiceTargetType, "kafka-test")
+				span.Attributes().PutStr(elasticattr.SpanDestinationServiceResource, "broker.com:443")
+				return span
+			}(),
+			config: config.Enabled().Span,
+			enrichedAttrs: map[string]any{
+				elasticattr.TimestampUs:                    startTs.AsTime().UnixMicro(),
+				elasticattr.SpanName:                       "testspan",
+				elasticattr.ProcessorEvent:                 "span",
+				elasticattr.SpanRepresentativeCount:        float64(1),
+				elasticattr.SpanType:                       "messaging-test",
+				elasticattr.SpanSubtype:                    "kafka-test",
+				elasticattr.SpanDurationUs:                 expectedDuration.Microseconds(),
+				elasticattr.EventOutcome:                   "success",
+				elasticattr.SuccessCount:                   int64(1),
+				elasticattr.ServiceTargetType:              "kafka-test",
+				elasticattr.ServiceTargetName:              "user-events",
+				elasticattr.SpanDestinationServiceResource: "broker.com:443",
+			},
+		},
 		{
 			name: "messaging_destination",
 			input: func() ptrace.Span {
@@ -1265,6 +1362,40 @@ func TestElasticSpanEnrich(t *testing.T) {
 				elasticattr.SpanDestinationServiceResource: "testsvc",
 			},
 		},
+		{
+			name: "db_with_existing_attributes_are_preserved",
+			input: func() ptrace.Span {
+				span := getElasticSpan()
+				span.SetName("testspan")
+				span.Attributes().PutStr(string(semconv25.PeerServiceKey), "testsvc")
+				span.Attributes().PutStr(
+					string(semconv25.URLFullKey),
+					"https://localhost:5432",
+				)
+				span.Attributes().PutStr(string(semconv25.DBSystemKey), "postgresql")
+				span.Attributes().PutStr(elasticattr.SpanType, "db")
+				span.Attributes().PutStr(elasticattr.SpanSubtype, "postgresql")
+				span.Attributes().PutStr(elasticattr.ServiceTargetName, "customers")
+				span.Attributes().PutStr(elasticattr.ServiceTargetType, "postgresql")
+				span.Attributes().PutStr(elasticattr.SpanDestinationServiceResource, "postgresql/testdb")
+				return span
+			}(),
+			config: config.Enabled().Span,
+			enrichedAttrs: map[string]any{
+				elasticattr.TimestampUs:                    startTs.AsTime().UnixMicro(),
+				elasticattr.SpanName:                       "testspan",
+				elasticattr.ProcessorEvent:                 "span",
+				elasticattr.SpanRepresentativeCount:        float64(1),
+				elasticattr.SpanType:                       "db",
+				elasticattr.SpanSubtype:                    "postgresql",
+				elasticattr.SpanDurationUs:                 expectedDuration.Microseconds(),
+				elasticattr.EventOutcome:                   "success",
+				elasticattr.SuccessCount:                   int64(1),
+				elasticattr.ServiceTargetType:              "postgresql",
+				elasticattr.ServiceTargetName:              "customers",
+				elasticattr.SpanDestinationServiceResource: "postgresql/testdb",
+			},
+		},
 		{
 			name: "db_over_rpc",
 			input: func() ptrace.Span {
@@ -1374,6 +1505,36 @@ func TestElasticSpanEnrich(t *testing.T) {
 				elasticattr.SuccessCount:            int64(1),
 			},
 		},
+		{
+			name: "genai_with_existing_attributes_are_preserved",
+			input: func() ptrace.Span {
+				span := getElasticSpan()
+				span.SetName("testspan")
+				span.SetSpanID([8]byte{1})
+				span.Attributes().PutStr(string(semconv37.GenAIProviderNameKey), "openai")
+				span.Attributes().PutStr(elasticattr.SpanType, "genai")
+				span.Attributes().PutStr(elasticattr.SpanSubtype, "openai-test")
+				span.Attributes().PutStr(elasticattr.ServiceTargetName, "openai-api")
+				span.Attributes().PutStr(elasticattr.ServiceTargetType, "genai")
+				span.Attributes().PutStr(elasticattr.SpanDestinationServiceResource, "api.openai.com:443")
+				return span
+			}(),
+			config: config.Enabled().Span,
+			enrichedAttrs: map[string]any{
+				elasticattr.TimestampUs:                    startTs.AsTime().UnixMicro(),
+				elasticattr.SpanName:                       "testspan",
+				elasticattr.ProcessorEvent:                 "span",
+				elasticattr.SpanRepresentativeCount:        float64(1),
+				elasticattr.SpanType:                       "genai",
+				elasticattr.SpanSubtype:                    "openai-test",
+				elasticattr.SpanDurationUs:                 expectedDuration.Microseconds(),
+				elasticattr.EventOutcome:                   "success",
+				elasticattr.SuccessCount:                   int64(1),
+				elasticattr.ServiceTargetType:              "genai",
+				elasticattr.ServiceTargetName:              "openai-api",
+				elasticattr.SpanDestinationServiceResource: "api.openai.com:443",
+			},
+		},
 		{
 			name: "rpc_span_with_only_rpc_sevice_attr",
 			input: func() ptrace.Span {

Original file line number	Diff line number	Diff line change
`@@ -29,8 +29,6 @@ import (`
`29`	`29`	`"net/url"`
`30`	`30`	`"strconv"`
`31`	`31`
`32`		`- "github.com/elastic/opentelemetry-lib/elasticattr"`
`33`		`- "github.com/elastic/opentelemetry-lib/enrichments/config"`
`34`	`32`	`"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/sampling"`
`35`	`33`	`"github.com/ua-parser/uap-go/uaparser"`
`36`	`34`	`"go.opentelemetry.io/collector/pdata/pcommon"`
`@@ -40,6 +38,9 @@ import (`
`40`	`38`	`semconv37 "go.opentelemetry.io/otel/semconv/v1.37.0"`
`41`	`39`	`tracepb "go.opentelemetry.io/proto/otlp/trace/v1"`
`42`	`40`	`"google.golang.org/grpc/codes"`
	`41`	`+`
	`42`	`+ "github.com/elastic/opentelemetry-lib/elasticattr"`
	`43`	`+ "github.com/elastic/opentelemetry-lib/enrichments/config"`
`43`	`44`	`)`
`44`	`45`
`45`	`46`	`// defaultRepresentativeCount is the representative count to use for adjusting`
`@@ -444,9 +445,14 @@ func (s *spanEnrichmentContext) setSpanTypeSubtype(span ptrace.Span) (spanType s`
`444`	`445`	`}`
`445`	`446`	`}`
`446`	`447`
`447`		`- span.Attributes().PutStr(elasticattr.SpanType, spanType)`
	`448`	`+ // do not overwrite existing span.type and span.subtype attributes`
	`449`	`+ if existingSpanType, _ := span.Attributes().Get(elasticattr.SpanType); existingSpanType.Str() == "" {`
	`450`	`+ span.Attributes().PutStr(elasticattr.SpanType, spanType)`
	`451`	`+ }`
`448`	`452`	`if spanSubtype != "" {`
`449`		`- span.Attributes().PutStr(elasticattr.SpanSubtype, spanSubtype)`
	`453`	`+ if existingSpanSubtype, _ := span.Attributes().Get(elasticattr.SpanSubtype); existingSpanSubtype.Str() == "" {`
	`454`	`+ span.Attributes().PutStr(elasticattr.SpanSubtype, spanSubtype)`
	`455`	`+ }`
`450`	`456`	`}`
`451`	`457`
`452`	`458`	`return spanType, spanSubtype`
`@@ -494,9 +500,15 @@ func (s *spanEnrichmentContext) setServiceTarget(span ptrace.Span) {`
`494`	`500`	`}`
`495`	`501`	`}`
`496`	`502`
	`503`	`+ // set either target.type or target.name if at least one is available`
`497`	`504`	`if targetType != "" \|\| targetName != "" {`
`498`		`- span.Attributes().PutStr(elasticattr.ServiceTargetType, targetType)`
`499`		`- span.Attributes().PutStr(elasticattr.ServiceTargetName, targetName)`
	`505`	`+ // do not overwrite existing target.type and target.name attributes`
	`506`	`+ if existingTargetType, _ := span.Attributes().Get(elasticattr.ServiceTargetType); existingTargetType.Str() == "" {`
	`507`	`+ span.Attributes().PutStr(elasticattr.ServiceTargetType, targetType)`
	`508`	`+ }`
	`509`	`+ if existingTargetName, _ := span.Attributes().Get(elasticattr.ServiceTargetName); existingTargetName.Str() == "" {`
	`510`	`+ span.Attributes().PutStr(elasticattr.ServiceTargetName, targetName)`
	`511`	`+ }`
`500`	`512`	`}`
`501`	`513`	`}`
`502`	`514`
`@@ -536,7 +548,10 @@ func (s *spanEnrichmentContext) setDestinationService(span ptrace.Span) {`
`536`	`548`	`}`
`537`	`549`
`538`	`550`	`if destnResource != "" {`
`539`		`- span.Attributes().PutStr(elasticattr.SpanDestinationServiceResource, destnResource)`
	`551`	`+ // do not overwrite existing span.destination.service.resource attribute`
	`552`	`+ if existingDestnResource, _ := span.Attributes().Get(elasticattr.SpanDestinationServiceResource); existingDestnResource.Str() == "" {`
	`553`	`+ span.Attributes().PutStr(elasticattr.SpanDestinationServiceResource, destnResource)`
	`554`	`+ }`
`540`	`555`	`}`
`541`	`556`	`}`
`542`	`557`