Update transaction enrichment to clear the span ID and span Name. Remove span ID and Name enrichment(#254)

* Update transaction enrichment to set clear the span id and span name

This allows the span id and name to be only represented by the elastic attributes (`transaction.id` , `transaction.name`) only

* Remove span.id and span.name enrichment since it is not required, the elasticsearch exporter will add these fields based on the span top-level ID and Name fields

Author: isaacaflores2

enrichments/config/config.go

@@ -49,11 +49,21 @@ type ElasticTransactionConfig struct {
 	// TimestampUs is a temporary attribute to enable higher
 	// resolution timestamps in Elasticsearch. For more details see:
 	// https://github.com/elastic/opentelemetry-dev/issues/374.
-	TimestampUs         AttributeConfig `mapstructure:"timestamp_us"`
-	Sampled             AttributeConfig `mapstructure:"sampled"`
-	ID                  AttributeConfig `mapstructure:"id"`
-	Root                AttributeConfig `mapstructure:"root"`
-	Name                AttributeConfig `mapstructure:"name"`
+	TimestampUs AttributeConfig `mapstructure:"timestamp_us"`
+	Sampled     AttributeConfig `mapstructure:"sampled"`
+	ID          AttributeConfig `mapstructure:"id"`
+	// ClearSpanID sets the span ID to an empty value so that the
+	// ID is only represented by the `transaction.id` attribute.
+	// Applicable only when ID is enabled.
+	// Disabled by default.
+	ClearSpanID AttributeConfig `mapstructure:"clear_span_id"`
+	Root        AttributeConfig `mapstructure:"root"`
+	Name        AttributeConfig `mapstructure:"name"`
+	// ClearSpanName sets the span name to an empty value so that the
+	// name is only represented by the `transaction.name` attribute.
+	// Applicable only when Name is enabled.
+	// Disabled by default.
+	ClearSpanName       AttributeConfig `mapstructure:"clear_span_name"`
 	ProcessorEvent      AttributeConfig `mapstructure:"processor_event"`
 	RepresentativeCount AttributeConfig `mapstructure:"representative_count"`
 	DurationUs          AttributeConfig `mapstructure:"duration_us"`
@@ -73,8 +83,6 @@ type ElasticSpanConfig struct {
 	// resolution timestamps in Elasticsearch. For more details see:
 	// https://github.com/elastic/opentelemetry-dev/issues/374.
 	TimestampUs         AttributeConfig `mapstructure:"timestamp_us"`
-	ID                  AttributeConfig `mapstructure:"id"`
-	Name                AttributeConfig `mapstructure:"name"`
 	ProcessorEvent      AttributeConfig `mapstructure:"processor_event"`
 	RepresentativeCount AttributeConfig `mapstructure:"representative_count"`
 	Action              AttributeConfig `mapstructure:"action"`
@@ -154,8 +162,6 @@ func Enabled() Config {
 		},
 		Span: ElasticSpanConfig{
 			TimestampUs:         AttributeConfig{Enabled: true},
-			ID:                  AttributeConfig{Enabled: true},
-			Name:                AttributeConfig{Enabled: true},
 			ProcessorEvent:      AttributeConfig{Enabled: true},
 			Action:              AttributeConfig{Enabled: true},
 			TypeSubtype:         AttributeConfig{Enabled: true},

enrichments/config/config_test.go

@@ -36,10 +36,22 @@ func TestEnabled(t *testing.T) {
 func assertAllEnabled(t *testing.T, cfg reflect.Value) {
 	t.Helper()
 
+	// Fields that are intentionally disabled by default
+	disabledByDefault := map[string]bool{
+		"ClearSpanID":   true,
+		"ClearSpanName": true,
+	}
+
 	for i := 0; i < cfg.NumField(); i++ {
+		fieldName := cfg.Type().Field(i).Name
 		rAttrCfg := cfg.Field(i).Interface()
 		attrCfg, ok := rAttrCfg.(AttributeConfig)
 		require.True(t, ok, "must be a type of AttributeConfig")
-		require.True(t, attrCfg.Enabled, "must be enabled")
+
+		if disabledByDefault[fieldName] {
+			require.False(t, attrCfg.Enabled, "%s must be disabled by default", fieldName)
+		} else {
+			require.True(t, attrCfg.Enabled, "%s must be enabled", fieldName)
+		}
 	}
 }

enrichments/internal/elastic/span.go

@@ -264,12 +264,18 @@ func (s *spanEnrichmentContext) enrichTransaction(
 		// https://github.com/elastic/apm-data/blob/v1.19.5/input/elasticapm/internal/modeldecoder/v2/decoder.go#L1377-L1379
 		// https://github.com/elastic/apm-data/blob/v1.19.5/input/otlp/traces.go#L185-L194
 		attribute.PutStr(span.Attributes(), elasticattr.SpanID, transactionID)
+		if cfg.ClearSpanID.Enabled {
+			span.SetSpanID(pcommon.SpanID{})
+		}
 	}
 	if cfg.Root.Enabled {
 		attribute.PutBool(span.Attributes(), elasticattr.TransactionRoot, isTraceRoot(span))
 	}
 	if cfg.Name.Enabled {
 		attribute.PutStr(span.Attributes(), elasticattr.TransactionName, span.Name())
+		if cfg.ClearSpanName.Enabled {
+			span.SetName("")
+		}
 	}
 	if cfg.ProcessorEvent.Enabled {
 		attribute.PutStr(span.Attributes(), elasticattr.ProcessorEvent, "transaction")
@@ -315,12 +321,6 @@ func (s *spanEnrichmentContext) enrichSpan(
 	if cfg.TimestampUs.Enabled {
 		attribute.PutInt(span.Attributes(), elasticattr.TimestampUs, getTimestampUs(span.StartTimestamp()))
 	}
-	if cfg.ID.Enabled {
-		attribute.PutStr(span.Attributes(), elasticattr.SpanID, span.SpanID().String())
-	}
-	if cfg.Name.Enabled {
-		attribute.PutStr(span.Attributes(), elasticattr.SpanName, span.Name())
-	}
 	if cfg.RepresentativeCount.Enabled {
 		repCount := getRepresentativeCount(span.TraceState().AsRaw())
 		attribute.PutDouble(span.Attributes(), elasticattr.SpanRepresentativeCount, repCount)