use a factory option to set telemetry attributes

Author: github-actions[bot]

.chloggen/factory_option.yaml

@@ -0,0 +1,25 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: xconnector, xexporter, xreceiver, xprocessor
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Offer a factory option for components to register modifications to the telemetry attributes
+
+# One or more tracking issues or pull requests related to the change
+issues: [13832]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: [api]

.github/workflows/utils/cspell.json

@@ -446,7 +446,6 @@
       "tailsampling",
       "tchannel",
       "telemetrygen",
-      "telemetryimpl",
       "testcomponents",
       "testconverter",
       "testdata",

cmd/builder/internal/builder/main_test.go

@@ -92,7 +92,6 @@ var replaceModules = []string{
 	"/internal/fanoutconsumer",
 	"/internal/sharedcomponent",
 	"/internal/telemetry",
-	"/internal/telemetryimpl",
 	"/otelcol",
 	"/pdata",
 	"/pdata/testdata",

cmd/mdatagen/go.mod

@@ -201,5 +201,3 @@ replace go.opentelemetry.io/collector/extension/extensioncapabilities => ../../e
 replace go.opentelemetry.io/collector/pdata/xpdata => ../../pdata/xpdata
 
 replace go.opentelemetry.io/collector/exporter/exporterhelper => ../../exporter/exporterhelper
-
-replace go.opentelemetry.io/collector/internal/telemetryimpl => ../../internal/telemetryimpl

cmd/otelcorecol/builder-config.yaml

@@ -92,7 +92,6 @@ replaces:
   - go.opentelemetry.io/collector/internal/memorylimiter => ../../internal/memorylimiter
   - go.opentelemetry.io/collector/internal/fanoutconsumer => ../../internal/fanoutconsumer
   - go.opentelemetry.io/collector/internal/telemetry => ../../internal/telemetry
-  - go.opentelemetry.io/collector/internal/telemetryimpl => ../../internal/telemetryimpl
   - go.opentelemetry.io/collector/internal/sharedcomponent => ../../internal/sharedcomponent
   - go.opentelemetry.io/collector/otelcol => ../../otelcol
   - go.opentelemetry.io/collector/pdata => ../../pdata

cmd/otelcorecol/go.mod

@@ -120,7 +120,6 @@ require (
 	go.opentelemetry.io/collector/internal/memorylimiter v0.135.0 // indirect
 	go.opentelemetry.io/collector/internal/sharedcomponent v0.135.0 // indirect
 	go.opentelemetry.io/collector/internal/telemetry v0.135.0 // indirect
-	go.opentelemetry.io/collector/internal/telemetryimpl v0.135.0 // indirect
 	go.opentelemetry.io/collector/pdata v1.41.0 // indirect
 	go.opentelemetry.io/collector/pdata/pprofile v0.135.0 // indirect
 	go.opentelemetry.io/collector/pdata/testdata v0.135.0 // indirect
@@ -288,8 +287,6 @@ replace go.opentelemetry.io/collector/internal/fanoutconsumer => ../../internal/
 
 replace go.opentelemetry.io/collector/internal/telemetry => ../../internal/telemetry
 
-replace go.opentelemetry.io/collector/internal/telemetryimpl => ../../internal/telemetryimpl
-
 replace go.opentelemetry.io/collector/internal/sharedcomponent => ../../internal/sharedcomponent
 
 replace go.opentelemetry.io/collector/otelcol => ../../otelcol

connector/xconnector/connector.go

@@ -6,6 +6,8 @@ package xconnector // import "go.opentelemetry.io/collector/connector/xconnector
 import (
 	"context"
 
+	"go.opentelemetry.io/otel/attribute"
+
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/connector"
 	"go.opentelemetry.io/collector/connector/internal"
@@ -213,6 +215,13 @@ func WithProfilesToLogs(createProfilesToLogs CreateProfilesToLogsFunc, sl compon
 	})
 }
 
+// WithTelemetryAttributes overrides the default component attributes setter to change the attributes to set on the component telemetry.
+func WithTelemetryAttributes(attributesFunc func(set attribute.Set) attribute.Set) FactoryOption {
+	return factoryOptionFunc(func(o *factoryOpts) {
+		o.attributesFunc = attributesFunc
+	})
+}
+
 // factory implements the Factory interface.
 type factory struct {
 	connector.Factory
@@ -234,6 +243,8 @@ type factory struct {
 	profilesToTracesStabilityLevel   component.StabilityLevel
 	profilesToMetricsStabilityLevel  component.StabilityLevel
 	profilesToLogsStabilityLevel     component.StabilityLevel
+
+	attributesFunc func(set attribute.Set) attribute.Set
 }
 
 func (f *factory) TracesToProfilesStability() component.StabilityLevel {
@@ -313,6 +324,13 @@ func (f *factory) CreateProfilesToLogs(ctx context.Context, set connector.Settin
 	return f.createProfilesToLogsFunc(ctx, set, cfg, next)
 }
 
+func (f *factory) TelemetryAttributes(attributes attribute.Set) attribute.Set {
+	if f.attributesFunc != nil {
+		return f.attributesFunc(attributes)
+	}
+	return attributes
+}
+
 // NewFactory returns a Factory.
 func NewFactory(cfgType component.Type, createDefaultConfig component.CreateDefaultConfigFunc, options ...FactoryOption) Factory {
 	opts := factoryOpts{factory: &factory{}}

connector/xconnector/connector_test.go

@@ -9,6 +9,7 @@ import (
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/otel/attribute"
 
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/connector"
@@ -146,3 +147,27 @@ func createProfilesToMetrics(context.Context, connector.Settings, component.Conf
 func createProfilesToLogs(context.Context, connector.Settings, component.Config, consumer.Logs) (Profiles, error) {
 	return nopInstance, nil
 }
+
+func TestWithAttributes(t *testing.T) {
+	testType := component.MustNewType("test")
+	defaultCfg := struct{}{}
+	factory := NewFactory(
+		testType,
+		func() component.Config { return &defaultCfg },
+		WithTelemetryAttributes(func(set attribute.Set) attribute.Set {
+			return attribute.NewSet(append(set.ToSlice(), attribute.String("foobar", "bar"))...)
+		}),
+	)
+	type factoryWithAttributes interface {
+		TelemetryAttributes(attributes attribute.Set) attribute.Set
+	}
+	result := factory.(factoryWithAttributes).TelemetryAttributes(attribute.NewSet(attribute.String("foo", "bar")))
+	assert.Equal(t, attribute.NewSet(attribute.String("foobar", "bar"), attribute.String("foo", "bar")), result)
+	// test without attributes set
+	factory = NewFactory(
+		testType,
+		func() component.Config { return &defaultCfg },
+	)
+	result = factory.(factoryWithAttributes).TelemetryAttributes(attribute.NewSet())
+	assert.Empty(t, result.ToSlice())
+}

connector/xconnector/go.mod

@@ -14,6 +14,7 @@ require (
 	go.opentelemetry.io/collector/pdata/testdata v0.135.0
 	go.opentelemetry.io/collector/pipeline v1.41.0
 	go.opentelemetry.io/collector/pipeline/xpipeline v0.135.0
+	go.opentelemetry.io/otel v1.38.0
 )
 
 require (
@@ -27,7 +28,6 @@ require (
 	go.opentelemetry.io/collector/featuregate v1.41.0 // indirect
 	go.opentelemetry.io/collector/internal/telemetry v0.135.0 // indirect
 	go.opentelemetry.io/collector/pdata v1.41.0 // indirect
-	go.opentelemetry.io/otel v1.38.0 // indirect
 	go.opentelemetry.io/otel/metric v1.38.0 // indirect
 	go.opentelemetry.io/otel/trace v1.38.0 // indirect
 	go.uber.org/multierr v1.11.0 // indirect

exporter/xexporter/exporter.go

@@ -6,6 +6,8 @@ package xexporter // import "go.opentelemetry.io/collector/exporter/xexporter"
 import (
 	"context"
 
+	"go.opentelemetry.io/otel/attribute"
+
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/consumer/xconsumer"
 	"go.opentelemetry.io/collector/exporter"
@@ -85,6 +87,7 @@ type factory struct {
 	exporter.Factory
 	createProfilesFunc     CreateProfilesFunc
 	profilesStabilityLevel component.StabilityLevel
+	attributesFunc         func(attributes attribute.Set) attribute.Set
 }
 
 func (f *factory) ProfilesStability() component.StabilityLevel {
@@ -102,6 +105,20 @@ func (f *factory) CreateProfiles(ctx context.Context, set exporter.Settings, cfg
 	return f.createProfilesFunc(ctx, set, cfg)
 }
 
+// WithTelemetryAttributes overrides the default component attributes setter to change the attributes to set on the component telemetry.
+func WithTelemetryAttributes(attributesFunc func(set attribute.Set) attribute.Set) FactoryOption {
+	return factoryOptionFunc(func(o *factoryOpts) {
+		o.attributesFunc = attributesFunc
+	})
+}
+
+func (f *factory) TelemetryAttributes(attributes attribute.Set) attribute.Set {
+	if f.attributesFunc != nil {
+		return f.attributesFunc(attributes)
+	}
+	return attributes
+}
+
 // NewFactory returns a Factory.
 func NewFactory(cfgType component.Type, createDefaultConfig component.CreateDefaultConfigFunc, options ...FactoryOption) Factory {
 	opts := factoryOpts{factory: &factory{}}