Add singleton flags to factories and standardize attributes

.chloggen/singleton-flags-and-attributes-exporter.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: exporter
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Add `Metadata` method to `Factory` interface.
+
+# One or more tracking issues or pull requests related to the change
+issues: [12057]
+
+# (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]

.chloggen/singleton-flags-and-attributes-receiver.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: receiver
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Add `Metadata` method to `Factory` interface.
+
+# One or more tracking issues or pull requests related to the change
+issues: [12057]
+
+# (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]

exporter/exporter.go

@@ -72,9 +72,17 @@ type Factory interface {
 	// LogsStability gets the stability level of the Logs exporter.
 	LogsStability() component.StabilityLevel
 
+	// Metadata returns the metadata describing the receiver.
+	Metadata() Metadata
+
 	unexportedFactoryFunc()
 }
 
+// Metadata contains metadata describing the component that is created by the factory.
+type Metadata struct {
+	SharedInstance bool
+}
+
 // FactoryOption apply changes to Factory.
 type FactoryOption interface {
 	// applyOption applies the option.
@@ -132,6 +140,7 @@ type factory struct {
 	metricsStabilityLevel component.StabilityLevel
 	CreateLogsFunc
 	logsStabilityLevel component.StabilityLevel
+	metadata           Metadata
 }
 
 func (f *factory) Type() component.Type {
@@ -152,6 +161,10 @@ func (f *factory) LogsStability() component.StabilityLevel {
 	return f.logsStabilityLevel
 }
 
+func (f *factory) Metadata() Metadata {
+	return f.metadata
+}
+
 // WithTraces overrides the default "error not supported" implementation for Factory.CreateTraces and the default "undefined" stability level.
 func WithTraces(createTraces CreateTracesFunc, sl component.StabilityLevel) FactoryOption {
 	return factoryOptionFunc(func(o *factory) {
@@ -176,6 +189,13 @@ func WithLogs(createLogs CreateLogsFunc, sl component.StabilityLevel) FactoryOpt
 	})
 }
 
+// WithSharedInstance indicates that the factory always returns the same instance of the component for a given component ID.
+func WithSharedInstance() FactoryOption {
+	return factoryOptionFunc(func(o *factory) {
+		o.metadata.SharedInstance = true
+	})
+}
+
 // NewFactory returns a Factory.
 func NewFactory(cfgType component.Type, createDefaultConfig component.CreateDefaultConfigFunc, options ...FactoryOption) Factory {
 	f := &factory{

exporter/exporter_test.go

@@ -29,6 +29,7 @@ func TestNewFactory(t *testing.T) {
 	require.ErrorIs(t, err, pipeline.ErrSignalNotSupported)
 	_, err = f.CreateLogs(context.Background(), Settings{}, &defaultCfg)
 	require.ErrorIs(t, err, pipeline.ErrSignalNotSupported)
+	assert.False(t, f.Metadata().SharedInstance)
 }
 
 func TestNewFactoryWithOptions(t *testing.T) {
@@ -39,7 +40,8 @@ func TestNewFactoryWithOptions(t *testing.T) {
 		func() component.Config { return &defaultCfg },
 		WithTraces(createTraces, component.StabilityLevelDevelopment),
 		WithMetrics(createMetrics, component.StabilityLevelAlpha),
-		WithLogs(createLogs, component.StabilityLevelDeprecated))
+		WithLogs(createLogs, component.StabilityLevelDeprecated),
+		WithSharedInstance())
 	assert.EqualValues(t, testType, f.Type())
 	assert.EqualValues(t, &defaultCfg, f.CreateDefaultConfig())
 
@@ -53,7 +55,9 @@ func TestNewFactoryWithOptions(t *testing.T) {
 
 	assert.Equal(t, component.StabilityLevelDeprecated, f.LogsStability())
 	_, err = f.CreateLogs(context.Background(), Settings{}, &defaultCfg)
-	assert.NoError(t, err)
+	require.NoError(t, err)
+
+	assert.True(t, f.Metadata().SharedInstance)
 }
 
 func TestMakeFactoryMap(t *testing.T) {

exporter/xexporter/exporter.go

@@ -88,6 +88,13 @@ func WithProfiles(createProfiles CreateProfilesFunc, sl component.StabilityLevel
 	})
 }
 
+// WithSharedInstance WithSharedInstance indicates that the factory always returns the same instance of the component for a given component ID.
+func WithSharedInstance() FactoryOption {
+	return factoryOptionFunc(func(o *factoryOpts) {
+		o.opts = append(o.opts, exporter.WithSharedInstance())
+	})
+}
+
 type factory struct {
 	exporter.Factory
 	CreateProfilesFunc

exporter/xexporter/exporter_test.go

@@ -21,6 +21,7 @@ func TestNewFactoryWithProfiles(t *testing.T) {
 		testType,
 		func() component.Config { return &defaultCfg },
 		WithProfiles(createProfiles, component.StabilityLevelDevelopment),
+		WithSharedInstance(),
 	)
 	assert.EqualValues(t, testType, factory.Type())
 	assert.EqualValues(t, &defaultCfg, factory.CreateDefaultConfig())

receiver/otlpreceiver/factory.go

@@ -34,6 +34,7 @@ func NewFactory() receiver.Factory {
 		xreceiver.WithMetrics(createMetrics, metadata.MetricsStability),
 		xreceiver.WithLogs(createLog, metadata.LogsStability),
 		xreceiver.WithProfiles(createProfiles, metadata.ProfilesStability),
+		xreceiver.WithSharedInstance(),
 	)
 }
 

receiver/receiver.go

@@ -84,9 +84,17 @@ type Factory interface {
 	// LogsStability gets the stability level of the Logs receiver.
 	LogsStability() component.StabilityLevel
 
+	// Metadata returns the metadata describing the receiver.
+	Metadata() Metadata
+
 	unexportedFactoryFunc()
 }
 
+// Metadata contains metadata describing the component that is created by the factory.
+type Metadata struct {
+	SharedInstance bool
+}
+
 // FactoryOption apply changes to Factory.
 type FactoryOption interface {
 	// applyOption applies the option.
@@ -142,6 +150,7 @@ type factory struct {
 	metricsStabilityLevel component.StabilityLevel
 	CreateLogsFunc
 	logsStabilityLevel component.StabilityLevel
+	metadata           Metadata
 }
 
 func (f *factory) Type() component.Type {
@@ -162,6 +171,10 @@ func (f *factory) LogsStability() component.StabilityLevel {
 	return f.logsStabilityLevel
 }
 
+func (f *factory) Metadata() Metadata {
+	return f.metadata
+}
+
 // WithTraces overrides the default "error not supported" implementation for Factory.CreateTraces and the default "undefined" stability level.
 func WithTraces(createTraces CreateTracesFunc, sl component.StabilityLevel) FactoryOption {
 	return factoryOptionFunc(func(o *factory) {
@@ -186,6 +199,13 @@ func WithLogs(createLogs CreateLogsFunc, sl component.StabilityLevel) FactoryOpt
 	})
 }
 
+// WithSharedInstance indicates that the factory always returns the same instance of the component for a given component ID.
+func WithSharedInstance() FactoryOption {
+	return factoryOptionFunc(func(o *factory) {
+		o.metadata.SharedInstance = true
+	})
+}
+
 // NewFactory returns a Factory.
 func NewFactory(cfgType component.Type, createDefaultConfig component.CreateDefaultConfigFunc, options ...FactoryOption) Factory {
 	f := &factory{

receiver/receiver_test.go

@@ -30,6 +30,7 @@ func TestNewFactory(t *testing.T) {
 	require.ErrorIs(t, err, pipeline.ErrSignalNotSupported)
 	_, err = f.CreateLogs(context.Background(), Settings{}, &defaultCfg, consumertest.NewNop())
 	require.ErrorIs(t, err, pipeline.ErrSignalNotSupported)
+	assert.False(t, f.Metadata().SharedInstance)
 }
 
 func TestNewFactoryWithOptions(t *testing.T) {
@@ -40,7 +41,8 @@ func TestNewFactoryWithOptions(t *testing.T) {
 		func() component.Config { return &defaultCfg },
 		WithTraces(createTraces, component.StabilityLevelDeprecated),
 		WithMetrics(createMetrics, component.StabilityLevelAlpha),
-		WithLogs(createLogs, component.StabilityLevelStable))
+		WithLogs(createLogs, component.StabilityLevelStable),
+		WithSharedInstance())
 	assert.EqualValues(t, testType, f.Type())
 	assert.EqualValues(t, &defaultCfg, f.CreateDefaultConfig())
 
@@ -54,7 +56,9 @@ func TestNewFactoryWithOptions(t *testing.T) {
 
 	assert.Equal(t, component.StabilityLevelStable, f.LogsStability())
 	_, err = f.CreateLogs(context.Background(), Settings{}, &defaultCfg, nil)
-	assert.NoError(t, err)
+	require.NoError(t, err)
+
+	assert.True(t, f.Metadata().SharedInstance)
 }
 
 func TestMakeFactoryMap(t *testing.T) {

receiver/xreceiver/profiles.go

@@ -105,6 +105,13 @@ func WithProfiles(createProfiles CreateProfilesFunc, sl component.StabilityLevel
 	})
 }
 
+// WithSharedInstance WithSharedInstance indicates that the factory always returns the same instance of the component for a given component ID.
+func WithSharedInstance() FactoryOption {
+	return factoryOptionFunc(func(o *factoryOpts) {
+		o.opts = append(o.opts, receiver.WithSharedInstance())
+	})
+}
+
 // NewFactory returns a Factory.
 func NewFactory(cfgType component.Type, createDefaultConfig component.CreateDefaultConfigFunc, options ...FactoryOption) Factory {
 	opts := factoryOpts{factory: &factory{}}

receiver/xreceiver/receiver_test.go

@@ -22,6 +22,7 @@ func TestNewFactoryWithProfiles(t *testing.T) {
 		testType,
 		func() component.Config { return &defaultCfg },
 		WithProfiles(createProfiles, component.StabilityLevelAlpha),
+		WithSharedInstance(),
 	)
 	assert.EqualValues(t, testType, factory.Type())
 	assert.EqualValues(t, &defaultCfg, factory.CreateDefaultConfig())

service/extensions/extensions.go

@@ -17,8 +17,8 @@ import (
 	"go.opentelemetry.io/collector/confmap"
 	"go.opentelemetry.io/collector/extension"
 	"go.opentelemetry.io/collector/extension/extensioncapabilities"
+	"go.opentelemetry.io/collector/service/internal/attribute"
 	"go.opentelemetry.io/collector/service/internal/builders"
-	"go.opentelemetry.io/collector/service/internal/components"
 	"go.opentelemetry.io/collector/service/internal/status"
 	"go.opentelemetry.io/collector/service/internal/zpages"
 )
@@ -38,7 +38,7 @@ type Extensions struct {
 func (bes *Extensions) Start(ctx context.Context, host component.Host) error {
 	bes.telemetry.Logger.Info("Starting extensions...")
 	for _, extID := range bes.extensionIDs {
-		extLogger := components.ExtensionLogger(bes.telemetry.Logger, extID)
+		extLogger := attribute.Extension(extID).Logger(bes.telemetry.Logger)
 		extLogger.Info("Extension is starting...")
 		instanceID := bes.instanceIDs[extID]
 		ext := bes.extMap[extID]
@@ -216,7 +216,7 @@ func New(ctx context.Context, set Settings, cfg Config, options ...Option) (*Ext
 			BuildInfo:         set.BuildInfo,
 			ModuleInfo:        set.ModuleInfo,
 		}
-		extSet.TelemetrySettings.Logger = components.ExtensionLogger(set.Telemetry.Logger, extID)
+		extSet.TelemetrySettings.Logger = attribute.Extension(extID).Logger(set.Telemetry.Logger)
 
 		ext, err := set.Extensions.Create(ctx, extSet)
 		if err != nil {

service/internal/attribute/attribute.go

@@ -7,6 +7,7 @@ import (
 	"hash/fnv"
 
 	"go.opentelemetry.io/otel/attribute"
+	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/pipeline"
@@ -47,6 +48,14 @@ func (a Attributes) ID() int64 {
 	return a.id
 }
 
+func (a Attributes) Logger(logger *zap.Logger) *zap.Logger {
+	fields := make([]zap.Field, 0, a.set.Len())
+	for _, kv := range a.set.ToSlice() {
+		fields = append(fields, zap.String(string(kv.Key), kv.Value.AsString()))
+	}
+	return logger.With(fields...)
+}
+
 func Receiver(pipelineType pipeline.Signal, id component.ID) *Attributes {
 	return newAttributes(
 		attribute.String(componentKindKey, component.KindReceiver.String()),
@@ -55,6 +64,13 @@ func Receiver(pipelineType pipeline.Signal, id component.ID) *Attributes {
 	)
 }
 
+func SharedReceiver(id component.ID) *Attributes {
+	return newAttributes(
+		attribute.String(componentKindKey, component.KindReceiver.String()),
+		attribute.String(componentIDKey, id.String()),
+	)
+}
+
 func Processor(pipelineID pipeline.ID, id component.ID) *Attributes {
 	return newAttributes(
 		attribute.String(componentKindKey, component.KindProcessor.String()),
@@ -72,6 +88,13 @@ func Exporter(pipelineType pipeline.Signal, id component.ID) *Attributes {
 	)
 }
 
+func SharedExporter(id component.ID) *Attributes {
+	return newAttributes(
+		attribute.String(componentKindKey, component.KindExporter.String()),
+		attribute.String(componentIDKey, id.String()),
+	)
+}
+
 func Connector(exprPipelineType, rcvrPipelineType pipeline.Signal, id component.ID) *Attributes {
 	return newAttributes(
 		attribute.String(componentKindKey, component.KindConnector.String()),