Standarize Settings instead of Params and Parameters

Fixes #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

Author: pmatyjasek-sumo

cmd/otelcol/main.go

@@ -37,12 +37,16 @@ func main() {
 		Version: version.Version,
 	}
 
-	if err := run(service.Parameters{ApplicationStartInfo: info, Factories: factories}); err != nil {
+	componentSettings := component.ComponentSettings{
+		ApplicationStartInfo: 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 extension.
@@ -60,6 +61,16 @@ type Component interface {
 	Shutdown(ctx context.Context) error
 }
 
+// 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
+
+	// ApplicationStartInfo can be used by components for informational purposes
+	ApplicationStartInfo ApplicationStartInfo
+}
+
 // Kind specified one of the 4 components kinds, see consts below.
 type Kind int
 

component/componenttest/nop_exporter.go

@@ -48,7 +48,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
@@ -57,7 +57,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
@@ -66,7 +66,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, &config.ExporterSettings{TypeVal: factory.Type()}, 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

@@ -47,7 +47,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, &config.ExtensionSettings{TypeVal: factory.Type()}, 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

@@ -51,7 +51,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) {
@@ -61,7 +61,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) {
@@ -71,7 +71,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, &config.ProcessorSettings{TypeVal: factory.Type()}, 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

@@ -48,7 +48,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) {
@@ -58,7 +58,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) {
@@ -68,7 +68,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) {