Standarize Settings instead of Params and Parameters

Fixes open-telemetry#2650
Changes:
 Replace: ReceiverCreateParams, ProcessorCreateParams, ExtensionCreateParams and ExporterCreateParams with ComponentSettings struct
 Replace all dependencies in Extensions, Exporters, Processors and Receivers
 Replace Parameters and settings structs with new struct Settings
 Replace dependencies in service and main
 Update tests

Signed-off-by: Patryk Matyjasek <[email protected]>

# Conflicts:
#	exporter/kafkaexporter/factory.go
#	exporter/kafkaexporter/factory_test.go
#	exporter/kafkaexporter/kafka_exporter.go
#	exporter/kafkaexporter/kafka_exporter_test.go
#	exporter/prometheusexporter/factory.go
#	receiver/jaegerreceiver/jaeger_agent_test.go
#	receiver/jaegerreceiver/trace_receiver_test.go
#	receiver/kafkareceiver/factory.go
#	receiver/kafkareceiver/factory_test.go
#	receiver/kafkareceiver/kafka_receiver.go
#	receiver/kafkareceiver/kafka_receiver_test.go

# Conflicts:
#	processor/batchprocessor/batch_processor.go
#	processor/batchprocessor/batch_processor_test.go
#	processor/batchprocessor/factory.go
#	processor/filterprocessor/filter_processor_test.go
#	service/application.go

# Conflicts:
#	cmd/otelcol/main.go
#	component/component.go
#	component/exporter.go
#	component/extension.go
#	component/processor.go
#	component/processor_test.go
#	component/receiver.go
#	exporter/exporterhelper/factory_test.go
#	extension/extensionhelper/factory_test.go
#	processor/batchprocessor/batch_processor.go
#	processor/processorhelper/factory_test.go
#	receiver/jaegerreceiver/factory.go
#	receiver/jaegerreceiver/trace_receiver_test.go
#	receiver/otlpreceiver/factory.go
#	receiver/prometheusreceiver/factory.go
#	receiver/receiverhelper/factory_test.go
#	service/application.go
#	service/application_test.go
#	service/defaultcomponents/default_exporters_test.go
#	service/defaultcomponents/default_extensions_test.go
#	service/defaultcomponents/default_processors_test.go
#	service/defaultcomponents/default_receivers_test.go
#	service/internal/builder/exporters_builder.go
#	service/internal/builder/extensions_builder.go
#	service/internal/builder/pipelines_builder.go
#	service/internal/builder/receivers_builder.go
#	service/service.go
#	service/service_test.go
#	testbed/testbed/otelcol_runner.go

cmd/otelcol/main.go

@@ -38,12 +38,16 @@ func main() {
 		Version:     version.Version,
 	}
 
-	if err := run(service.Parameters{BuildInfo: info, Factories: factories}); err != nil {
+	componentSettings := component.ComponentSettings{
+		BuildInfo: info,
+	}
+
+	if err := run(service.Settings{ComponentSettings: componentSettings, Factories: factories}); err != nil {
 		log.Fatal(err)
 	}
 }
 
-func runInteractive(params service.Parameters) error {
+func runInteractive(params service.Settings) error {
 	app, err := service.New(params)
 	if err != nil {
 		return fmt.Errorf("failed to construct the application: %w", err)

cmd/otelcol/main_others.go

@@ -18,6 +18,6 @@ package main
 
 import "go.opentelemetry.io/collector/service"
 
-func run(params service.Parameters) error {
+func run(params service.Settings) error {
 	return runInteractive(params)
 }

component/component.go

@@ -18,6 +18,7 @@ import (
 	"context"
 
 	"go.opentelemetry.io/collector/config"
+	"go.uber.org/zap"
 )
 
 // Component is either a receiver, exporter, processor or an extension.
@@ -60,7 +61,17 @@ type Component interface {
 	Shutdown(ctx context.Context) error
 }
 
-// Kind represents component kinds.
+// ComponentSettings is passed to ReceiverFactory.Create* functions.
+type ComponentSettings struct {
+	// Logger that the factory can use during creation and can pass to the created
+	// component to be used later as well.
+	Logger *zap.Logger
+
+	// BuildInfo can be used by components for informational purposes
+	BuildInfo BuildInfo
+}
+
+// Kind specified one of the 4 components kinds, see consts below.
 type Kind int
 
 const (

component/componenttest/nop_exporter.go

@@ -52,7 +52,7 @@ func (f *nopExporterFactory) CreateDefaultConfig() config.Exporter {
 // CreateTracesExporter implements component.ExporterFactory interface.
 func (f *nopExporterFactory) CreateTracesExporter(
 	_ context.Context,
-	_ component.ExporterCreateParams,
+	_ component.ComponentSettings,
 	_ config.Exporter,
 ) (component.TracesExporter, error) {
 	return nopExporterInstance, nil
@@ -61,7 +61,7 @@ func (f *nopExporterFactory) CreateTracesExporter(
 // CreateMetricsExporter implements component.ExporterFactory interface.
 func (f *nopExporterFactory) CreateMetricsExporter(
 	_ context.Context,
-	_ component.ExporterCreateParams,
+	_ component.ComponentSettings,
 	_ config.Exporter,
 ) (component.MetricsExporter, error) {
 	return nopExporterInstance, nil
@@ -70,7 +70,7 @@ func (f *nopExporterFactory) CreateMetricsExporter(
 // CreateLogsExporter implements component.ExporterFactory interface.
 func (f *nopExporterFactory) CreateLogsExporter(
 	_ context.Context,
-	_ component.ExporterCreateParams,
+	_ component.ComponentSettings,
 	_ config.Exporter,
 ) (component.LogsExporter, error) {
 	return nopExporterInstance, nil

component/componenttest/nop_exporter_test.go

@@ -33,19 +33,19 @@ func TestNewNopExporterFactory(t *testing.T) {
 	cfg := factory.CreateDefaultConfig()
 	assert.Equal(t, &nopExporterConfig{ExporterSettings: config.NewExporterSettings(config.NewID("nop"))}, cfg)
 
-	traces, err := factory.CreateTracesExporter(context.Background(), component.ExporterCreateParams{}, cfg)
+	traces, err := factory.CreateTracesExporter(context.Background(), component.ComponentSettings{}, cfg)
 	require.NoError(t, err)
 	assert.NoError(t, traces.Start(context.Background(), NewNopHost()))
 	assert.NoError(t, traces.ConsumeTraces(context.Background(), pdata.NewTraces()))
 	assert.NoError(t, traces.Shutdown(context.Background()))
 
-	metrics, err := factory.CreateMetricsExporter(context.Background(), component.ExporterCreateParams{}, cfg)
+	metrics, err := factory.CreateMetricsExporter(context.Background(), component.ComponentSettings{}, cfg)
 	require.NoError(t, err)
 	assert.NoError(t, metrics.Start(context.Background(), NewNopHost()))
 	assert.NoError(t, metrics.ConsumeMetrics(context.Background(), pdata.NewMetrics()))
 	assert.NoError(t, metrics.Shutdown(context.Background()))
 
-	logs, err := factory.CreateLogsExporter(context.Background(), component.ExporterCreateParams{}, cfg)
+	logs, err := factory.CreateLogsExporter(context.Background(), component.ComponentSettings{}, cfg)
 	require.NoError(t, err)
 	assert.NoError(t, logs.Start(context.Background(), NewNopHost()))
 	assert.NoError(t, logs.ConsumeLogs(context.Background(), pdata.NewLogs()))

component/componenttest/nop_extension.go

@@ -51,7 +51,7 @@ func (f *nopExtensionFactory) CreateDefaultConfig() config.Extension {
 // CreateExtension implements component.ExtensionFactory interface.
 func (f *nopExtensionFactory) CreateExtension(
 	_ context.Context,
-	_ component.ExtensionCreateParams,
+	_ component.ComponentSettings,
 	_ config.Extension,
 ) (component.Extension, error) {
 	return nopExtensionInstance, nil

component/componenttest/nop_extension_test.go

@@ -32,7 +32,7 @@ func TestNewNopExtensionFactory(t *testing.T) {
 	cfg := factory.CreateDefaultConfig()
 	assert.Equal(t, &nopExtensionConfig{ExtensionSettings: config.NewExtensionSettings(config.NewID("nop"))}, cfg)
 
-	traces, err := factory.CreateExtension(context.Background(), component.ExtensionCreateParams{}, cfg)
+	traces, err := factory.CreateExtension(context.Background(), component.ComponentSettings{}, cfg)
 	require.NoError(t, err)
 	assert.NoError(t, traces.Start(context.Background(), NewNopHost()))
 	assert.NoError(t, traces.Shutdown(context.Background()))

component/componenttest/nop_processor.go

@@ -55,7 +55,7 @@ func (f *nopProcessorFactory) CreateDefaultConfig() config.Processor {
 // CreateTracesProcessor implements component.ProcessorFactory interface.
 func (f *nopProcessorFactory) CreateTracesProcessor(
 	_ context.Context,
-	_ component.ProcessorCreateParams,
+	_ component.ComponentSettings,
 	_ config.Processor,
 	_ consumer.Traces,
 ) (component.TracesProcessor, error) {
@@ -65,7 +65,7 @@ func (f *nopProcessorFactory) CreateTracesProcessor(
 // CreateMetricsProcessor implements component.ProcessorFactory interface.
 func (f *nopProcessorFactory) CreateMetricsProcessor(
 	_ context.Context,
-	_ component.ProcessorCreateParams,
+	_ component.ComponentSettings,
 	_ config.Processor,
 	_ consumer.Metrics,
 ) (component.MetricsProcessor, error) {
@@ -75,7 +75,7 @@ func (f *nopProcessorFactory) CreateMetricsProcessor(
 // CreateLogsProcessor implements component.ProcessorFactory interface.
 func (f *nopProcessorFactory) CreateLogsProcessor(
 	_ context.Context,
-	_ component.ProcessorCreateParams,
+	_ component.ComponentSettings,
 	_ config.Processor,
 	_ consumer.Logs,
 ) (component.LogsProcessor, error) {

component/componenttest/nop_processor_test.go

@@ -34,21 +34,21 @@ func TestNewNopProcessorFactory(t *testing.T) {
 	cfg := factory.CreateDefaultConfig()
 	assert.Equal(t, &nopProcessorConfig{ProcessorSettings: config.NewProcessorSettings(config.NewID("nop"))}, cfg)
 
-	traces, err := factory.CreateTracesProcessor(context.Background(), component.ProcessorCreateParams{}, cfg, consumertest.NewNop())
+	traces, err := factory.CreateTracesProcessor(context.Background(), component.ComponentSettings{}, cfg, consumertest.NewNop())
 	require.NoError(t, err)
 	assert.Equal(t, component.ProcessorCapabilities{MutatesConsumedData: false}, traces.GetCapabilities())
 	assert.NoError(t, traces.Start(context.Background(), NewNopHost()))
 	assert.NoError(t, traces.ConsumeTraces(context.Background(), pdata.NewTraces()))
 	assert.NoError(t, traces.Shutdown(context.Background()))
 
-	metrics, err := factory.CreateMetricsProcessor(context.Background(), component.ProcessorCreateParams{}, cfg, consumertest.NewNop())
+	metrics, err := factory.CreateMetricsProcessor(context.Background(), component.ComponentSettings{}, cfg, consumertest.NewNop())
 	require.NoError(t, err)
 	assert.Equal(t, component.ProcessorCapabilities{MutatesConsumedData: false}, metrics.GetCapabilities())
 	assert.NoError(t, metrics.Start(context.Background(), NewNopHost()))
 	assert.NoError(t, metrics.ConsumeMetrics(context.Background(), pdata.NewMetrics()))
 	assert.NoError(t, metrics.Shutdown(context.Background()))
 
-	logs, err := factory.CreateLogsProcessor(context.Background(), component.ProcessorCreateParams{}, cfg, consumertest.NewNop())
+	logs, err := factory.CreateLogsProcessor(context.Background(), component.ComponentSettings{}, cfg, consumertest.NewNop())
 	require.NoError(t, err)
 	assert.Equal(t, component.ProcessorCapabilities{MutatesConsumedData: false}, logs.GetCapabilities())
 	assert.NoError(t, logs.Start(context.Background(), NewNopHost()))

component/componenttest/nop_receiver.go

@@ -52,7 +52,7 @@ func (f *nopReceiverFactory) CreateDefaultConfig() config.Receiver {
 // CreateTracesReceiver implements component.ReceiverFactory interface.
 func (f *nopReceiverFactory) CreateTracesReceiver(
 	_ context.Context,
-	_ component.ReceiverCreateParams,
+	_ component.ComponentSettings,
 	_ config.Receiver,
 	_ consumer.Traces,
 ) (component.TracesReceiver, error) {
@@ -62,7 +62,7 @@ func (f *nopReceiverFactory) CreateTracesReceiver(
 // CreateMetricsReceiver implements component.ReceiverFactory interface.
 func (f *nopReceiverFactory) CreateMetricsReceiver(
 	_ context.Context,
-	_ component.ReceiverCreateParams,
+	_ component.ComponentSettings,
 	_ config.Receiver,
 	_ consumer.Metrics,
 ) (component.MetricsReceiver, error) {
@@ -72,7 +72,7 @@ func (f *nopReceiverFactory) CreateMetricsReceiver(
 // CreateLogsReceiver implements component.ReceiverFactory interface.
 func (f *nopReceiverFactory) CreateLogsReceiver(
 	_ context.Context,
-	_ component.ReceiverCreateParams,
+	_ component.ComponentSettings,
 	_ config.Receiver,
 	_ consumer.Logs,
 ) (component.LogsReceiver, error) {

component/componenttest/nop_receiver_test.go

@@ -33,17 +33,17 @@ func TestNewNopReceiverFactory(t *testing.T) {
 	cfg := factory.CreateDefaultConfig()
 	assert.Equal(t, &nopReceiverConfig{ReceiverSettings: config.NewReceiverSettings(config.NewID("nop"))}, cfg)
 
-	traces, err := factory.CreateTracesReceiver(context.Background(), component.ReceiverCreateParams{}, cfg, consumertest.NewNop())
+	traces, err := factory.CreateTracesReceiver(context.Background(), component.ComponentSettings{}, cfg, consumertest.NewNop())
 	require.NoError(t, err)
 	assert.NoError(t, traces.Start(context.Background(), NewNopHost()))
 	assert.NoError(t, traces.Shutdown(context.Background()))
 
-	metrics, err := factory.CreateMetricsReceiver(context.Background(), component.ReceiverCreateParams{}, cfg, consumertest.NewNop())
+	metrics, err := factory.CreateMetricsReceiver(context.Background(), component.ComponentSettings{}, cfg, consumertest.NewNop())
 	require.NoError(t, err)
 	assert.NoError(t, metrics.Start(context.Background(), NewNopHost()))
 	assert.NoError(t, metrics.Shutdown(context.Background()))
 
-	logs, err := factory.CreateLogsReceiver(context.Background(), component.ReceiverCreateParams{}, cfg, consumertest.NewNop())
+	logs, err := factory.CreateLogsReceiver(context.Background(), component.ComponentSettings{}, cfg, consumertest.NewNop())
 	require.NoError(t, err)
 	assert.NoError(t, logs.Start(context.Background(), NewNopHost()))
 	assert.NoError(t, logs.Shutdown(context.Background()))

component/componenttest/shutdown_verifier.go

@@ -34,7 +34,7 @@ func verifyTracesProcessorDoesntProduceAfterShutdown(t *testing.T, factory compo
 	nextSink := new(consumertest.TracesSink)
 	processor, err := factory.CreateTracesProcessor(
 		context.Background(),
-		component.ProcessorCreateParams{Logger: zap.NewNop()},
+		component.ComponentSettings{Logger: zap.NewNop()},
 		cfg,
 		nextSink,
 	)

component/exporter.go

@@ -17,8 +17,6 @@ package component
 import (
 	"context"
 
-	"go.uber.org/zap"
-
 	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/consumer"
 )
@@ -46,18 +44,8 @@ type LogsExporter interface {
 	consumer.Logs
 }
 
-// ExporterCreateParams configures Exporter creators.
-type ExporterCreateParams struct {
-	// Logger that the factory can use during creation and can pass to the created
-	// component to be used later as well.
-	Logger *zap.Logger
-
-	// BuildInfo can be used by components for informational purposes
-	BuildInfo BuildInfo
-}
-
-// ExporterFactory can create MetricsExporter, TracesExporter and
-// LogsExporter. This is the new preferred factory type to create exporters.
+// ExporterFactory can create TracesExporter and MetricsExporter. This is the
+// new factory type that can create new style exporters.
 type ExporterFactory interface {
 	Factory
 
@@ -73,18 +61,27 @@ type ExporterFactory interface {
 	// CreateTracesExporter creates a trace exporter based on this config.
 	// If the exporter type does not support tracing or if the config is not valid
 	// error will be returned instead.
-	CreateTracesExporter(ctx context.Context, params ExporterCreateParams,
-		cfg config.Exporter) (TracesExporter, error)
+	CreateTracesExporter(
+		ctx context.Context,
+		settings ComponentSettings,
+		cfg config.Exporter,
+	) (TracesExporter, error)
 
 	// CreateMetricsExporter creates a metrics exporter based on this config.
 	// If the exporter type does not support metrics or if the config is not valid
 	// error will be returned instead.
-	CreateMetricsExporter(ctx context.Context, params ExporterCreateParams,
-		cfg config.Exporter) (MetricsExporter, error)
+	CreateMetricsExporter(
+		ctx context.Context,
+		settings ComponentSettings,
+		cfg config.Exporter,
+	) (MetricsExporter, error)
 
 	// CreateLogsExporter creates an exporter based on the config.
 	// If the exporter type does not support logs or if the config is not valid
 	// error will be returned instead.
-	CreateLogsExporter(ctx context.Context, params ExporterCreateParams,
-		cfg config.Exporter) (LogsExporter, error)
+	CreateLogsExporter(
+		ctx context.Context,
+		settings ComponentSettings,
+		cfg config.Exporter,
+	) (LogsExporter, error)
 }

component/exporter_test.go

@@ -39,17 +39,17 @@ func (f *TestExporterFactory) CreateDefaultConfig() config.Exporter {
 }
 
 // CreateTracesExporter creates a trace exporter based on this config.
-func (f *TestExporterFactory) CreateTracesExporter(context.Context, ExporterCreateParams, config.Exporter) (TracesExporter, error) {
+func (f *TestExporterFactory) CreateTracesExporter(context.Context, ComponentSettings, config.Exporter) (TracesExporter, error) {
 	return nil, componenterror.ErrDataTypeIsNotSupported
 }
 
 // CreateMetricsExporter creates a metrics exporter based on this config.
-func (f *TestExporterFactory) CreateMetricsExporter(context.Context, ExporterCreateParams, config.Exporter) (MetricsExporter, error) {
+func (f *TestExporterFactory) CreateMetricsExporter(context.Context, ComponentSettings, config.Exporter) (MetricsExporter, error) {
 	return nil, componenterror.ErrDataTypeIsNotSupported
 }
 
 // CreateMetricsExporter creates a logs exporter based on this config.
-func (f *TestExporterFactory) CreateLogsExporter(context.Context, ExporterCreateParams, config.Exporter) (LogsExporter, error) {
+func (f *TestExporterFactory) CreateLogsExporter(context.Context, ComponentSettings, config.Exporter) (LogsExporter, error) {
 	return nil, componenterror.ErrDataTypeIsNotSupported
 }
 

component/extension.go

@@ -17,8 +17,6 @@ package component
 import (
 	"context"
 
-	"go.uber.org/zap"
-
 	"go.opentelemetry.io/collector/config"
 )
 
@@ -46,16 +44,6 @@ type PipelineWatcher interface {
 	NotReady() error
 }
 
-// ExtensionCreateParams is passed to ExtensionFactory.Create* functions.
-type ExtensionCreateParams struct {
-	// Logger that the factory can use during creation and can pass to the created
-	// component to be used later as well.
-	Logger *zap.Logger
-
-	// BuildInfo can be used by components for informational purposes
-	BuildInfo BuildInfo
-}
-
 // ExtensionFactory is a factory interface for extensions to the service.
 type ExtensionFactory interface {
 	Factory
@@ -70,5 +58,9 @@ type ExtensionFactory interface {
 	CreateDefaultConfig() config.Extension
 
 	// CreateExtension creates a service extension based on the given config.
-	CreateExtension(ctx context.Context, params ExtensionCreateParams, cfg config.Extension) (Extension, error)
+	CreateExtension(
+		ctx context.Context,
+		settings ComponentSettings,
+		cfg config.Extension,
+	) (Extension, error)
 }