Allow passing trace/metric SDK options to componenttest.Telemetry

Signed-off-by: Bogdan Drutu <[email protected]>

Author: bogdandrutu

.chloggen/main.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: breaking
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: cmd/mdatagen
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Allow passing OTel Metric SDK options to the generated `SetupTelemetry` function.
+
+# One or more tracking issues or pull requests related to the change
+issues: [12160]
+
+# (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/mx-psi_deprecate-level-mdatagen.yaml renamed to .chloggen/setup-telemetry-options.yaml

@@ -24,8 +24,8 @@ type Telemetry struct {
 	componenttest.Telemetry
 }
 
-func SetupTelemetry() Telemetry {
-	return Telemetry{ Telemetry: componenttest.NewTelemetry() }
+func SetupTelemetry(opts ...componenttest.TelemetryOption) Telemetry {
+	return Telemetry{ Telemetry: componenttest.NewTelemetry(opts...) }
 }
 
 {{- if or isConnector isExporter isExtension isProcessor isReceiver isScraper }}

cmd/mdatagen/internal/samplereceiver/internal/metadatatest/generated_telemetrytest.go

@@ -5,6 +5,9 @@ package componenttest // import "go.opentelemetry.io/collector/component/compone
 
 import (
 	"go.opentelemetry.io/otel/attribute"
+	sdkmetric "go.opentelemetry.io/otel/sdk/metric"
+	"go.opentelemetry.io/otel/sdk/resource"
+	sdktrace "go.opentelemetry.io/otel/sdk/trace"
 
 	"go.opentelemetry.io/collector/component"
 )
@@ -90,7 +93,9 @@ func (tts *TestTelemetry) TelemetrySettings() component.TelemetrySettings {
 // The caller must defer a call to `Shutdown` on the returned TestTelemetry.
 func SetupTelemetry(id component.ID) (TestTelemetry, error) {
 	return TestTelemetry{
-		Telemetry: NewTelemetry(),
-		id:        id,
+		Telemetry: NewTelemetry(
+			WithMetricOptions(sdkmetric.WithResource(resource.Empty())),
+			WithTraceOptions(sdktrace.WithResource(resource.Empty()))),
+		id: id,
 	}, nil
 }

cmd/mdatagen/internal/templates/telemetrytest.go.tmpl

@@ -8,29 +8,60 @@ import (
 	"errors"
 
 	sdkmetric "go.opentelemetry.io/otel/sdk/metric"
-	"go.opentelemetry.io/otel/sdk/resource"
 	sdktrace "go.opentelemetry.io/otel/sdk/trace"
 	"go.opentelemetry.io/otel/sdk/trace/tracetest"
 
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/config/configtelemetry"
 )
 
+type TelemetryOption interface {
+	apply(*telemetryOption)
+}
+
+type telemetryOption struct {
+	metricOpts []sdkmetric.Option
+	traceOpts  []sdktrace.TracerProviderOption
+}
+
+type telemetryOptionFunc func(*telemetryOption)
+
+func (f telemetryOptionFunc) apply(o *telemetryOption) { f(o) }
+
+func WithMetricOptions(opts ...sdkmetric.Option) TelemetryOption {
+	return telemetryOptionFunc(func(to *telemetryOption) {
+		to.metricOpts = append(to.metricOpts, opts...)
+	})
+}
+
+func WithTraceOptions(opts ...sdktrace.TracerProviderOption) TelemetryOption {
+	return telemetryOptionFunc(func(to *telemetryOption) {
+		to.traceOpts = append(to.traceOpts, opts...)
+	})
+}
+
 type Telemetry struct {
 	Reader        *sdkmetric.ManualReader
 	SpanRecorder  *tracetest.SpanRecorder
 	meterProvider *sdkmetric.MeterProvider
 	traceProvider *sdktrace.TracerProvider
 }
 
-func NewTelemetry() Telemetry {
+func NewTelemetry(opts ...TelemetryOption) Telemetry {
 	reader := sdkmetric.NewManualReader()
 	spanRecorder := new(tracetest.SpanRecorder)
+	tOpts := telemetryOption{
+		metricOpts: []sdkmetric.Option{sdkmetric.WithReader(reader)},
+		traceOpts:  []sdktrace.TracerProviderOption{sdktrace.WithSpanProcessor(spanRecorder)},
+	}
+	for _, opt := range opts {
+		opt.apply(&tOpts)
+	}
 	return Telemetry{
 		Reader:        reader,
 		SpanRecorder:  spanRecorder,
-		meterProvider: sdkmetric.NewMeterProvider(sdkmetric.WithResource(resource.Empty()), sdkmetric.WithReader(reader)),
-		traceProvider: sdktrace.NewTracerProvider(sdktrace.WithResource(resource.Empty()), sdktrace.WithSpanProcessor(spanRecorder)),
+		meterProvider: sdkmetric.NewMeterProvider(tOpts.metricOpts...),
+		traceProvider: sdktrace.NewTracerProvider(tOpts.traceOpts...),
 	}
 }