Merge branch 'main' into mx-psi/configoptional-for-exporterhelper-queuebatchconfig

Author: mx-psi

.chloggen/14140.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: bug_fix
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: all
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Ensure service service.instance.id is the same for all the signals when it is autogenerated.
+
+# One or more tracking issues or pull requests related to the change
+issues: [14140]
+
+# (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: []

confmap/internal/decoder.go

@@ -168,7 +168,7 @@ func mapKeyStringToMapKeyTextUnmarshalerHookFunc() mapstructure.DecodeHookFuncTy
 		}
 
 		// Create a map with key value of to's key to bool.
-		fieldNameSet := reflect.MakeMap(reflect.MapOf(to.Key(), reflect.TypeOf(true)))
+		fieldNameSet := reflect.MakeMap(reflect.MapOf(to.Key(), reflect.TypeFor[bool]()))
 		for k := range data.(map[string]any) {
 			// Create a new value of the to's key type.
 			tKey := reflect.New(to.Key())

confmap/xconfmap/config.go

@@ -15,7 +15,7 @@ import (
 
 // As interface types are only used for static typing, a common idiom to find the reflection Type
 // for an interface type Foo is to use a *Foo value.
-var configValidatorType = reflect.TypeOf((*Validator)(nil)).Elem()
+var configValidatorType = reflect.TypeFor[Validator]()
 
 // Validator defines an optional interface for configurations to implement to do validation.
 type Validator interface {

service/service.go

@@ -124,16 +124,23 @@ func New(ctx context.Context, set Settings, cfg Config) (_ *Service, resultErr e
 		collectorConf: set.CollectorConf,
 	}
 
-	// Create the logger & LoggerProvider first. These may be used
-	// when creating the other telemetry providers.
+	if set.TelemetryFactory == nil {
+		return nil, errors.New("telemetry factory not provided")
+	}
+
+	// Create the resource first. This ensures all telemetry providers
+	// (logger, meter, tracer) use the same resource with a consistent service.instance.id.
 	telemetrySettings := telemetry.Settings{BuildInfo: set.BuildInfo}
+	resource, err := set.TelemetryFactory.CreateResource(ctx, telemetrySettings, cfg.Telemetry)
+	if err != nil {
+		return nil, fmt.Errorf("failed to create resource: %w", err)
+	}
+	telemetrySettings.Resource = &resource
+
 	loggerSettings := telemetry.LoggerSettings{
 		Settings:   telemetrySettings,
 		ZapOptions: set.LoggingOptions,
 	}
-	if set.TelemetryFactory == nil {
-		return nil, errors.New("telemetry factory not provided")
-	}
 	logger, loggerShutdownFunc, err := set.TelemetryFactory.CreateLogger(ctx, loggerSettings, cfg.Telemetry)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create logger: %w", err)
@@ -177,11 +184,6 @@ func New(ctx context.Context, set Settings, cfg Config) (_ *Service, resultErr e
 	}()
 	srv.tracerProvider = tracerProvider
 
-	resource, err := set.TelemetryFactory.CreateResource(ctx, telemetrySettings, cfg.Telemetry)
-	if err != nil {
-		return nil, fmt.Errorf("failed to create resource: %w", err)
-	}
-
 	srv.telemetrySettings = component.TelemetrySettings{
 		Logger:         logger,
 		MeterProvider:  meterProvider,

service/service_test.go

@@ -495,15 +495,15 @@ func TestServiceTelemetryCreateProvidersError(t *testing.T) {
 	}
 	for name, tc := range map[string]testcase{
 		"CreateLogger": {
-			opts:        []telemetry.FactoryOption{loggerOpt, meterOpt, tracerOpt, resourceOpt},
+			opts:        []telemetry.FactoryOption{loggerOpt, meterOpt, tracerOpt},
 			expectedErr: "failed to create logger: something went wrong",
 		},
 		"CreateMeterProvider": {
-			opts:        []telemetry.FactoryOption{meterOpt, tracerOpt, resourceOpt},
+			opts:        []telemetry.FactoryOption{meterOpt, tracerOpt},
 			expectedErr: "failed to create meter provider: something went wrong",
 		},
 		"CreateTracerProvider": {
-			opts:        []telemetry.FactoryOption{tracerOpt, resourceOpt},
+			opts:        []telemetry.FactoryOption{tracerOpt},
 			expectedErr: "failed to create tracer provider: something went wrong",
 		},
 		"CreateResource": {
@@ -527,6 +527,81 @@ func TestNew_NilTelemetryProvider(t *testing.T) {
 	require.EqualError(t, err, "telemetry factory not provided")
 }
 
+func TestServiceTelemetryConsistentInstanceID(t *testing.T) {
+	var loggerResource, meterResource, tracerResource *pcommon.Resource
+
+	createLoggerCalled := false
+	createMeterCalled := false
+	createTracerCalled := false
+
+	baseFactory := otelconftelemetry.NewFactory()
+
+	set := newNopSettings()
+	set.TelemetryFactory = telemetry.NewFactory(
+		baseFactory.CreateDefaultConfig,
+		telemetry.WithCreateResource(baseFactory.CreateResource),
+		telemetry.WithCreateLogger(func(ctx context.Context, settings telemetry.LoggerSettings, cfg component.Config) (*zap.Logger, component.ShutdownFunc, error) {
+			createLoggerCalled = true
+			loggerResource = settings.Resource
+			return baseFactory.CreateLogger(ctx, settings, cfg)
+		}),
+		telemetry.WithCreateMeterProvider(func(ctx context.Context, settings telemetry.MeterSettings, cfg component.Config) (telemetry.MeterProvider, error) {
+			createMeterCalled = true
+			meterResource = settings.Resource
+			return baseFactory.CreateMeterProvider(ctx, settings, cfg)
+		}),
+		telemetry.WithCreateTracerProvider(func(ctx context.Context, settings telemetry.TracerSettings, cfg component.Config) (telemetry.TracerProvider, error) {
+			createTracerCalled = true
+			tracerResource = settings.Resource
+			return baseFactory.CreateTracerProvider(ctx, settings, cfg)
+		}),
+	)
+
+	cfg := newNopConfig()
+	srv, err := New(context.Background(), set, cfg)
+	require.NoError(t, err)
+
+	require.True(t, createLoggerCalled, "logger should have been created")
+	require.True(t, createMeterCalled, "meter provider should have been created")
+	require.True(t, createTracerCalled, "tracer provider should have been created")
+
+	var serviceInstanceID string
+	if sid, ok := srv.telemetrySettings.Resource.Attributes().Get("service.instance.id"); ok {
+		serviceInstanceID = sid.AsString()
+	}
+	require.NotEmpty(t, serviceInstanceID, "service.instance.id not found in service resource")
+
+	require.NotNil(t, loggerResource, "logger should have received a resource")
+	require.NotNil(t, meterResource, "meter provider should have received a resource")
+	require.NotNil(t, tracerResource, "tracer provider should have received a resource")
+
+	var loggerInstanceID, meterInstanceID, tracerInstanceID string
+	if sid, ok := loggerResource.Attributes().Get("service.instance.id"); ok {
+		loggerInstanceID = sid.AsString()
+	}
+	if sid, ok := meterResource.Attributes().Get("service.instance.id"); ok {
+		meterInstanceID = sid.AsString()
+	}
+	if sid, ok := tracerResource.Attributes().Get("service.instance.id"); ok {
+		tracerInstanceID = sid.AsString()
+	}
+
+	require.NotEmpty(t, loggerInstanceID, "logger resource should have service.instance.id")
+	require.NotEmpty(t, meterInstanceID, "meter resource should have service.instance.id")
+	require.NotEmpty(t, tracerInstanceID, "tracer resource should have service.instance.id")
+
+	assert.Equal(t, serviceInstanceID, loggerInstanceID,
+		"logger should use the same service.instance.id as the service resource")
+	assert.Equal(t, serviceInstanceID, meterInstanceID,
+		"meter provider should use the same service.instance.id as the service resource")
+	assert.Equal(t, serviceInstanceID, tracerInstanceID,
+		"tracer provider should use the same service.instance.id as the service resource")
+
+	t.Logf("service.instance.id = %s (shared by logger, meter, and tracer)", serviceInstanceID)
+
+	require.NoError(t, srv.Shutdown(context.Background()))
+}
+
 func newNopSettings() Settings {
 	receiversConfigs, receiversFactories := builders.NewNopReceiverConfigsAndFactories()
 	processorsConfigs, processorsFactories := builders.NewNopProcessorConfigsAndFactories()
@@ -582,7 +657,7 @@ func newNopConfigPipelineConfigs(pipelineCfgs pipelines.Config) Config {
 	return Config{
 		Extensions: extensions.Config{component.NewID(nopType)},
 		Pipelines:  pipelineCfgs,
-		Telemetry: otelconftelemetry.Config{
+		Telemetry: &otelconftelemetry.Config{
 			Logs: otelconftelemetry.LogsConfig{
 				Level:       zapcore.InfoLevel,
 				Development: false,

service/telemetry/otelconftelemetry/logger.go

@@ -7,6 +7,7 @@ import (
 	"context"
 
 	otelconf "go.opentelemetry.io/contrib/otelconf/v0.3.0"
+	sdkresource "go.opentelemetry.io/otel/sdk/resource"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
 
@@ -21,7 +22,8 @@ func createLogger(
 	componentConfig component.Config,
 ) (*zap.Logger, component.ShutdownFunc, error) {
 	cfg := componentConfig.(*Config)
-	res := newResource(set.Settings, cfg)
+	attrs := pcommonAttrsToOTelAttrs(set.Resource)
+	res := sdkresource.NewWithAttributes("", attrs...)
 
 	// Copied from NewProductionConfig.
 	ec := zap.NewProductionEncoderConfig()

service/telemetry/otelconftelemetry/logger_test.go

@@ -133,8 +133,12 @@ func TestCreateLogger(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			buildInfo := component.BuildInfo{}
-			_, provider, err := NewFactory().CreateLogger(context.Background(), telemetry.LoggerSettings{
-				Settings: telemetry.Settings{BuildInfo: buildInfo},
+			factory := NewFactory()
+			resource, err := factory.CreateResource(context.Background(), telemetry.Settings{BuildInfo: buildInfo}, &tt.cfg)
+			require.NoError(t, err)
+
+			_, provider, err := factory.CreateLogger(context.Background(), telemetry.LoggerSettings{
+				Settings: telemetry.Settings{BuildInfo: buildInfo, Resource: &resource},
 			}, &tt.cfg)
 			if tt.wantErr != nil {
 				require.ErrorContains(t, err, tt.wantErr.Error())
@@ -226,13 +230,6 @@ func TestCreateLoggerWithResource(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			core, observedLogs := observer.New(zapcore.DebugLevel)
-			set := telemetry.LoggerSettings{
-				Settings: telemetry.Settings{BuildInfo: tt.buildInfo},
-				ZapOptions: []zap.Option{
-					// Redirect logs to the observer core
-					zap.WrapCore(func(zapcore.Core) zapcore.Core { return core }),
-				},
-			}
 			cfg := &Config{
 				Logs: LogsConfig{
 					Level:    zapcore.InfoLevel,
@@ -241,6 +238,17 @@ func TestCreateLoggerWithResource(t *testing.T) {
 				Resource: tt.resourceConfig,
 			}
 
+			resource, err := createResource(t.Context(), telemetry.Settings{BuildInfo: tt.buildInfo}, cfg)
+			require.NoError(t, err)
+
+			set := telemetry.LoggerSettings{
+				Settings: telemetry.Settings{BuildInfo: tt.buildInfo, Resource: &resource},
+				ZapOptions: []zap.Option{
+					// Redirect logs to the observer core
+					zap.WrapCore(func(zapcore.Core) zapcore.Core { return core }),
+				},
+			}
+
 			logger, loggerProvider, err := createLogger(t.Context(), set, cfg)
 			require.NoError(t, err)
 			defer func() {
@@ -337,7 +345,12 @@ func newOTLPLogger(t *testing.T, level zapcore.Level, handler func(plogotlp.Expo
 		},
 	}
 
-	logger, shutdown, err := createLogger(t.Context(), telemetry.LoggerSettings{}, cfg)
+	resource, err := createResource(t.Context(), telemetry.Settings{}, cfg)
+	require.NoError(t, err)
+
+	logger, shutdown, err := createLogger(t.Context(), telemetry.LoggerSettings{
+		Settings: telemetry.Settings{Resource: &resource},
+	}, cfg)
 	require.NoError(t, err)
 	t.Cleanup(func() {
 		assert.NoError(t, shutdown.Shutdown(context.WithoutCancel(t.Context())))
@@ -371,12 +384,6 @@ func TestLogAttributeInjection(t *testing.T) {
 	})
 	t.Cleanup(srv.Close)
 
-	set := telemetry.LoggerSettings{
-		ZapOptions: []zap.Option{
-			// Redirect console logs to the observer core
-			zap.WrapCore(func(zapcore.Core) zapcore.Core { return core }),
-		},
-	}
 	cfg := &Config{
 		Resource: map[string]*string{
 			"service.instance.id": nil,
@@ -400,6 +407,17 @@ func TestLogAttributeInjection(t *testing.T) {
 		},
 	}
 
+	resource, err := createResource(t.Context(), telemetry.Settings{}, cfg)
+	require.NoError(t, err)
+
+	set := telemetry.LoggerSettings{
+		Settings: telemetry.Settings{Resource: &resource},
+		ZapOptions: []zap.Option{
+			// Redirect console logs to the observer core
+			zap.WrapCore(func(zapcore.Core) zapcore.Core { return core }),
+		},
+	}
+
 	sourceLogger, loggerProvider, err := createLogger(t.Context(), set, cfg)
 	require.NoError(t, err)
 	defer func() {

service/telemetry/otelconftelemetry/metrics.go

@@ -8,6 +8,7 @@ import (
 
 	config "go.opentelemetry.io/contrib/otelconf/v0.3.0"
 	noopmetric "go.opentelemetry.io/otel/metric/noop"
+	sdkresource "go.opentelemetry.io/otel/sdk/resource"
 
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/config/configtelemetry"
@@ -27,7 +28,8 @@ func createMeterProvider(
 		cfg.Metrics.Views = set.DefaultViews(cfg.Metrics.Level)
 	}
 
-	res := newResource(set.Settings, cfg)
+	attrs := pcommonAttrsToOTelAttrs(set.Resource)
+	res := sdkresource.NewWithAttributes("", attrs...)
 	mpConfig := cfg.Metrics.MeterProvider
 	sdk, err := newSDK(ctx, res, config.OpenTelemetryConfiguration{
 		MeterProvider: &mpConfig,

service/telemetry/otelconftelemetry/metrics_test.go

@@ -119,7 +119,12 @@ func TestCreateMeterProvider(t *testing.T) {
 		}
 
 		t.Run(tt.name, func(t *testing.T) {
-			mp, err := createMeterProvider(t.Context(), telemetry.MeterSettings{}, cfg)
+			resource, err := createResource(t.Context(), telemetry.Settings{}, cfg)
+			require.NoError(t, err)
+
+			mp, err := createMeterProvider(t.Context(), telemetry.MeterSettings{
+				Settings: telemetry.Settings{Resource: &resource},
+			}, cfg)
 			require.NoError(t, err)
 			defer func() {
 				assert.NoError(t, mp.Shutdown(t.Context()))
@@ -209,7 +214,12 @@ func TestCreateMeterProvider_Invalid(t *testing.T) {
 		// Invalid -- no OTLP protocol defined
 		Periodic: &config.PeriodicMetricReader{Exporter: config.PushMetricExporter{OTLP: &config.OTLPMetric{}}},
 	}}
-	_, err := createMeterProvider(t.Context(), telemetry.MeterSettings{}, cfg)
+	resource, err := createResource(t.Context(), telemetry.Settings{}, cfg)
+	require.NoError(t, err)
+
+	_, err = createMeterProvider(t.Context(), telemetry.MeterSettings{
+		Settings: telemetry.Settings{Resource: &resource},
+	}, cfg)
 	require.EqualError(t, err, "no valid metric exporter")
 }
 
@@ -221,17 +231,27 @@ func TestCreateMeterProvider_Disabled(t *testing.T) {
 	}}
 
 	core, observedLogs := observer.New(zapcore.DebugLevel)
-	settings := telemetry.MeterSettings{}
-	settings.Logger = zap.New(core)
 
 	factory := NewFactory()
-	_, err := factory.CreateMeterProvider(context.Background(), settings, cfg)
+	resource, err := factory.CreateResource(context.Background(), telemetry.Settings{}, cfg)
+	require.NoError(t, err)
+
+	settings := telemetry.MeterSettings{
+		Settings: telemetry.Settings{Resource: &resource},
+	}
+	settings.Logger = zap.New(core)
+
+	_, err = factory.CreateMeterProvider(context.Background(), settings, cfg)
 	require.EqualError(t, err, "no valid metric exporter")
 	assert.Zero(t, observedLogs.Len())
 
 	// Setting Metrics.Level to LevelNone disables metrics,
 	// so the invalid configuration should not cause an error.
 	cfg.Metrics.Level = configtelemetry.LevelNone
+	resource2, err := createResource(t.Context(), telemetry.Settings{}, cfg)
+	require.NoError(t, err)
+	settings.Resource = &resource2
+
 	mp, err := createMeterProvider(t.Context(), settings, cfg)
 	require.NoError(t, err)
 	assert.NoError(t, mp.Shutdown(t.Context()))
@@ -249,7 +269,12 @@ func TestInstrumentEnabled(t *testing.T) {
 		Pull: &config.PullMetricReader{Exporter: config.PullMetricExporter{Prometheus: prom}},
 	}}
 
-	meterProvider, err := createMeterProvider(t.Context(), telemetry.MeterSettings{}, cfg)
+	resource, err := createResource(t.Context(), telemetry.Settings{}, cfg)
+	require.NoError(t, err)
+
+	meterProvider, err := createMeterProvider(t.Context(), telemetry.MeterSettings{
+		Settings: telemetry.Settings{Resource: &resource},
+	}, cfg)
 	require.NoError(t, err)
 	defer func() {
 		assert.NoError(t, meterProvider.Shutdown(t.Context()))