Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 19 additions & 13 deletions enrichments/trace/internal/elastic/resource.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ import (
"github.com/elastic/opentelemetry-lib/elasticattr"
"github.com/elastic/opentelemetry-lib/enrichments/trace/config"
"go.opentelemetry.io/collector/pdata/pcommon"
semconv25 "go.opentelemetry.io/collector/semconv/v1.25.0"
semconv "go.opentelemetry.io/collector/semconv/v1.27.0"
semconv25 "go.opentelemetry.io/otel/semconv/v1.25.0"
semconv "go.opentelemetry.io/otel/semconv/v1.27.0"
)

// EnrichResource derives and adds Elastic specific resource attributes.
Expand All @@ -50,23 +50,23 @@ type resourceEnrichmentContext struct {
func (s *resourceEnrichmentContext) Enrich(resource pcommon.Resource, cfg config.ResourceConfig) {
resource.Attributes().Range(func(k string, v pcommon.Value) bool {
switch k {
case semconv.AttributeHostName:
case string(semconv.HostNameKey):
s.hostName = v.Str()
case semconv.AttributeK8SNodeName:
case string(semconv.K8SNodeNameKey):
s.k8sNodeName = v.Str()
case semconv.AttributeTelemetrySDKName:
case string(semconv.TelemetrySDKNameKey):
s.telemetrySDKName = v.Str()
case semconv.AttributeTelemetrySDKLanguage:
case string(semconv.TelemetrySDKLanguageKey):
s.telemetrySDKLanguage = v.Str()
case semconv.AttributeTelemetrySDKVersion:
case string(semconv.TelemetrySDKVersionKey):
s.telemetrySDKVersion = v.Str()
case semconv.AttributeTelemetryDistroName:
case string(semconv.TelemetryDistroNameKey):
s.telemetryDistroName = v.Str()
case semconv.AttributeTelemetryDistroVersion:
case string(semconv.TelemetryDistroVersionKey):
s.telemetryDistroVersion = v.Str()
case semconv25.AttributeDeploymentEnvironment:
case string(semconv25.DeploymentEnvironmentKey):
s.deploymentEnvironment = v.Str()
case semconv.AttributeDeploymentEnvironmentName:
case string(semconv.DeploymentEnvironmentNameKey):
s.deploymentEnvironmentName = v.Str()
}
return true
Expand All @@ -92,7 +92,10 @@ func (s *resourceEnrichmentContext) Enrich(resource pcommon.Resource, cfg config
// 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 s.deploymentEnvironmentName != "" && s.deploymentEnvironment == "" {
resource.Attributes().PutStr(semconv25.AttributeDeploymentEnvironment, s.deploymentEnvironmentName)
resource.Attributes().PutStr(
string(semconv25.DeploymentEnvironmentKey),
s.deploymentEnvironmentName,
)
}
}

Expand Down Expand Up @@ -146,5 +149,8 @@ func (s *resourceEnrichmentContext) overrideHostNameWithK8sNodeName(resource pco
// and k8s node name are set then host name is overridden as this is
// considered an invalid configuration/smell and k8s node name is
// given higher preference.
resource.Attributes().PutStr(semconv.AttributeHostName, s.k8sNodeName)
resource.Attributes().PutStr(
string(semconv.HostNameKey),
s.k8sNodeName,
)
}
92 changes: 46 additions & 46 deletions enrichments/trace/internal/elastic/resource_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ import (
"github.com/google/go-cmp/cmp"
"github.com/stretchr/testify/assert"
"go.opentelemetry.io/collector/pdata/pcommon"
semconv25 "go.opentelemetry.io/collector/semconv/v1.25.0"
semconv "go.opentelemetry.io/collector/semconv/v1.27.0"
semconv25 "go.opentelemetry.io/otel/semconv/v1.25.0"
semconv "go.opentelemetry.io/otel/semconv/v1.27.0"
)

func TestResourceEnrich(t *testing.T) {
Expand Down Expand Up @@ -54,7 +54,7 @@ func TestResourceEnrich(t *testing.T) {
name: "sdkname_set",
input: func() pcommon.Resource {
res := pcommon.NewResource()
res.Attributes().PutStr(semconv.AttributeTelemetrySDKName, "customflavor")
res.Attributes().PutStr(string(semconv.TelemetrySDKNameKey), "customflavor")
return res
}(),
config: config.Enabled().Resource,
Expand All @@ -67,8 +67,8 @@ func TestResourceEnrich(t *testing.T) {
name: "sdkname_distro_set",
input: func() pcommon.Resource {
res := pcommon.NewResource()
res.Attributes().PutStr(semconv.AttributeTelemetrySDKName, "customflavor")
res.Attributes().PutStr(semconv.AttributeTelemetryDistroName, "elastic")
res.Attributes().PutStr(string(semconv.TelemetrySDKNameKey), "customflavor")
res.Attributes().PutStr(string(semconv.TelemetryDistroNameKey), "elastic")
return res
}(),
config: config.Enabled().Resource,
Expand All @@ -81,9 +81,9 @@ func TestResourceEnrich(t *testing.T) {
name: "sdkname_distro_lang_set",
input: func() pcommon.Resource {
res := pcommon.NewResource()
res.Attributes().PutStr(semconv.AttributeTelemetrySDKName, "customflavor")
res.Attributes().PutStr(semconv.AttributeTelemetrySDKLanguage, "cpp")
res.Attributes().PutStr(semconv.AttributeTelemetryDistroName, "elastic")
res.Attributes().PutStr(string(semconv.TelemetrySDKNameKey), "customflavor")
res.Attributes().PutStr(string(semconv.TelemetrySDKLanguageKey), "cpp")
res.Attributes().PutStr(string(semconv.TelemetryDistroNameKey), "elastic")
return res
}(),
config: config.Enabled().Resource,
Expand All @@ -96,7 +96,7 @@ func TestResourceEnrich(t *testing.T) {
name: "lang_set",
input: func() pcommon.Resource {
res := pcommon.NewResource()
res.Attributes().PutStr(semconv.AttributeTelemetrySDKLanguage, "cpp")
res.Attributes().PutStr(string(semconv.TelemetrySDKLanguageKey), "cpp")
return res
}(),
config: config.Enabled().Resource,
Expand All @@ -109,8 +109,8 @@ func TestResourceEnrich(t *testing.T) {
name: "sdkname_lang_set",
input: func() pcommon.Resource {
res := pcommon.NewResource()
res.Attributes().PutStr(semconv.AttributeTelemetrySDKName, "customflavor")
res.Attributes().PutStr(semconv.AttributeTelemetrySDKLanguage, "cpp")
res.Attributes().PutStr(string(semconv.TelemetrySDKNameKey), "customflavor")
res.Attributes().PutStr(string(semconv.TelemetrySDKLanguageKey), "cpp")
return res
}(),
config: config.Enabled().Resource,
Expand All @@ -123,8 +123,8 @@ func TestResourceEnrich(t *testing.T) {
name: "sdkname_sdkver_set",
input: func() pcommon.Resource {
res := pcommon.NewResource()
res.Attributes().PutStr(semconv.AttributeTelemetrySDKName, "customflavor")
res.Attributes().PutStr(semconv.AttributeTelemetrySDKVersion, "9.999.9")
res.Attributes().PutStr(string(semconv.TelemetrySDKNameKey), "customflavor")
res.Attributes().PutStr(string(semconv.TelemetrySDKVersionKey), "9.999.9")
return res
}(),
config: config.Enabled().Resource,
Expand All @@ -137,9 +137,9 @@ func TestResourceEnrich(t *testing.T) {
name: "sdkname_sdkver_distroname_set",
input: func() pcommon.Resource {
res := pcommon.NewResource()
res.Attributes().PutStr(semconv.AttributeTelemetrySDKName, "customflavor")
res.Attributes().PutStr(semconv.AttributeTelemetrySDKVersion, "9.999.9")
res.Attributes().PutStr(semconv.AttributeTelemetryDistroName, "elastic")
res.Attributes().PutStr(string(semconv.TelemetrySDKNameKey), "customflavor")
res.Attributes().PutStr(string(semconv.TelemetrySDKVersionKey), "9.999.9")
res.Attributes().PutStr(string(semconv.TelemetryDistroNameKey), "elastic")
return res
}(),
config: config.Enabled().Resource,
Expand All @@ -152,10 +152,10 @@ func TestResourceEnrich(t *testing.T) {
name: "sdkname_sdkver_distroname_distrover_set",
input: func() pcommon.Resource {
res := pcommon.NewResource()
res.Attributes().PutStr(semconv.AttributeTelemetrySDKName, "customflavor")
res.Attributes().PutStr(semconv.AttributeTelemetrySDKVersion, "9.999.9")
res.Attributes().PutStr(semconv.AttributeTelemetryDistroName, "elastic")
res.Attributes().PutStr(semconv.AttributeTelemetryDistroVersion, "1.2.3")
res.Attributes().PutStr(string(semconv.TelemetrySDKNameKey), "customflavor")
res.Attributes().PutStr(string(semconv.TelemetrySDKVersionKey), "9.999.9")
res.Attributes().PutStr(string(semconv.TelemetryDistroNameKey), "elastic")
res.Attributes().PutStr(string(semconv.TelemetryDistroVersionKey), "1.2.3")
return res
}(),
config: config.Enabled().Resource,
Expand All @@ -168,81 +168,81 @@ func TestResourceEnrich(t *testing.T) {
name: "host_name_override_with_k8s_node_name",
input: func() pcommon.Resource {
res := pcommon.NewResource()
res.Attributes().PutStr(semconv.AttributeHostName, "test-host")
res.Attributes().PutStr(semconv.AttributeK8SNodeName, "k8s-node")
res.Attributes().PutStr(string(semconv.HostNameKey), "test-host")
res.Attributes().PutStr(string(semconv.K8SNodeNameKey), "k8s-node")
return res
}(),
config: config.Enabled().Resource,
enrichedAttrs: map[string]any{
semconv.AttributeHostName: "k8s-node",
semconv.AttributeK8SNodeName: "k8s-node",
elasticattr.AgentName: "otlp",
elasticattr.AgentVersion: "unknown",
string(semconv.HostNameKey): "k8s-node",
string(semconv.K8SNodeNameKey): "k8s-node",
elasticattr.AgentName: "otlp",
elasticattr.AgentVersion: "unknown",
},
},
{
name: "host_name_if_empty_set_from_k8s_node_name",
input: func() pcommon.Resource {
res := pcommon.NewResource()
res.Attributes().PutStr(semconv.AttributeK8SNodeName, "k8s-node")
res.Attributes().PutStr(string(semconv.K8SNodeNameKey), "k8s-node")
return res
}(),
config: config.Enabled().Resource,
enrichedAttrs: map[string]any{
semconv.AttributeHostName: "k8s-node",
semconv.AttributeK8SNodeName: "k8s-node",
elasticattr.AgentName: "otlp",
elasticattr.AgentVersion: "unknown",
string(semconv.HostNameKey): "k8s-node",
string(semconv.K8SNodeNameKey): "k8s-node",
elasticattr.AgentName: "otlp",
elasticattr.AgentVersion: "unknown",
},
},
{
// Pre SemConv 1.27
name: "deployment_environment_set",
input: func() pcommon.Resource {
res := pcommon.NewResource()
res.Attributes().PutStr(semconv25.AttributeDeploymentEnvironment, "prod")
res.Attributes().PutStr(string(semconv25.DeploymentEnvironmentKey), "prod")
return res
}(),
config: config.Enabled().Resource,
enrichedAttrs: map[string]any{
semconv25.AttributeDeploymentEnvironment: "prod",
elasticattr.AgentName: "otlp",
elasticattr.AgentVersion: "unknown",
string(semconv25.DeploymentEnvironmentKey): "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")
res.Attributes().PutStr(string(semconv.DeploymentEnvironmentNameKey), "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",
string(semconv25.DeploymentEnvironmentKey): "prod",
string(semconv.DeploymentEnvironmentNameKey): "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")
res.Attributes().PutStr(string(semconv.DeploymentEnvironmentNameKey), "prod")
res.Attributes().PutStr(string(semconv25.DeploymentEnvironmentKey), "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",
string(semconv25.DeploymentEnvironmentKey): "test",
string(semconv.DeploymentEnvironmentNameKey): "prod",
elasticattr.AgentName: "otlp",
elasticattr.AgentVersion: "unknown",
},
},
} {
Expand Down
Loading