Wrap component opts for exporter and processor

Fixes open-telemetry#2787 Fixes open-telemetry#2788
punya · Mar 26, 2021 · b350d8d · b350d8d
1 parent d9b2c4b
commit b350d8d
Show file tree

Hide file tree

Showing 10 changed files with 38 additions and 44 deletions.
diff --git a/exporter/exporterhelper/common.go b/exporter/exporterhelper/common.go
@@ -101,19 +101,11 @@ func fromOptions(options []Option) *baseSettings {
 // Option apply changes to baseSettings.
 type Option func(*baseSettings)
 
-// WithStart overrides the default Start function for an exporter.
-// The default shutdown function does nothing and always returns nil.
-func WithStart(start componenthelper.Start) Option {
+// WithComponentOptions adds options that apply to a generic component
+// (such as start and shutdown hooks).
+func WithComponentOptions(opts ...componenthelper.Option) Option {
 	return func(o *baseSettings) {
-		o.componentOptions = append(o.componentOptions, componenthelper.WithStart(start))
-	}
-}
-
-// WithShutdown overrides the default Shutdown function for an exporter.
-// The default shutdown function does nothing and always returns nil.
-func WithShutdown(shutdown componenthelper.Shutdown) Option {
-	return func(o *baseSettings) {
-		o.componentOptions = append(o.componentOptions, componenthelper.WithShutdown(shutdown))
+		o.componentOptions = append(o.componentOptions, opts...)
 	}
 }
 

diff --git a/exporter/jaegerexporter/exporter.go b/exporter/jaegerexporter/exporter.go
@@ -29,6 +29,7 @@ import (
 	"google.golang.org/grpc/metadata"
 
 	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/component/componenthelper"
 	"go.opentelemetry.io/collector/consumer/consumererror"
 	"go.opentelemetry.io/collector/consumer/pdata"
 	"go.opentelemetry.io/collector/exporter/exporterhelper"
@@ -60,8 +61,10 @@ func newTraceExporter(cfg *Config, logger *zap.Logger) (component.TracesExporter
 	)
 	exp, err := exporterhelper.NewTraceExporter(
 		cfg, logger, s.pushTraceData,
-		exporterhelper.WithStart(s.start),
-		exporterhelper.WithShutdown(s.shutdown),
+		exporterhelper.WithComponentOptions(
+			componenthelper.WithStart(s.start),
+			componenthelper.WithShutdown(s.shutdown),
+		),
 		exporterhelper.WithTimeout(cfg.TimeoutSettings),
 		exporterhelper.WithRetry(cfg.RetrySettings),
 		exporterhelper.WithQueue(cfg.QueueSettings),

diff --git a/exporter/kafkaexporter/factory.go b/exporter/kafkaexporter/factory.go
@@ -19,6 +19,7 @@ import (
 	"time"
 
 	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/component/componenthelper"
 	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/exporter/exporterhelper"
 )
@@ -115,7 +116,7 @@ func (f *kafkaExporterFactory) createTraceExporter(
 		exporterhelper.WithTimeout(exporterhelper.TimeoutSettings{Timeout: 0}),
 		exporterhelper.WithRetry(oCfg.RetrySettings),
 		exporterhelper.WithQueue(oCfg.QueueSettings),
-		exporterhelper.WithShutdown(exp.Close))
+		exporterhelper.WithComponentOptions(componenthelper.WithShutdown(exp.Close)))
 }
 
 func (f *kafkaExporterFactory) createMetricsExporter(
@@ -140,5 +141,5 @@ func (f *kafkaExporterFactory) createMetricsExporter(
 		exporterhelper.WithTimeout(exporterhelper.TimeoutSettings{Timeout: 0}),
 		exporterhelper.WithRetry(oCfg.RetrySettings),
 		exporterhelper.WithQueue(oCfg.QueueSettings),
-		exporterhelper.WithShutdown(exp.Close))
+		exporterhelper.WithComponentOptions(componenthelper.WithShutdown(exp.Close)))
 }
diff --git a/exporter/loggingexporter/logging_exporter.go b/exporter/loggingexporter/logging_exporter.go
@@ -25,6 +25,7 @@ import (
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/component/componenthelper"
 	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/consumer/pdata"
 	"go.opentelemetry.io/collector/exporter/exporterhelper"
@@ -420,7 +421,7 @@ func newTraceExporter(config config.Exporter, level string, logger *zap.Logger)
 		exporterhelper.WithTimeout(exporterhelper.TimeoutSettings{Timeout: 0}),
 		exporterhelper.WithRetry(exporterhelper.RetrySettings{Enabled: false}),
 		exporterhelper.WithQueue(exporterhelper.QueueSettings{Enabled: false}),
-		exporterhelper.WithShutdown(loggerSync(logger)),
+		exporterhelper.WithComponentOptions(componenthelper.WithShutdown(loggerSync(logger))),
 	)
 }
 
@@ -440,7 +441,7 @@ func newMetricsExporter(config config.Exporter, level string, logger *zap.Logger
 		exporterhelper.WithTimeout(exporterhelper.TimeoutSettings{Timeout: 0}),
 		exporterhelper.WithRetry(exporterhelper.RetrySettings{Enabled: false}),
 		exporterhelper.WithQueue(exporterhelper.QueueSettings{Enabled: false}),
-		exporterhelper.WithShutdown(loggerSync(logger)),
+		exporterhelper.WithComponentOptions(componenthelper.WithShutdown(loggerSync(logger))),
 	)
 }
 
@@ -460,7 +461,7 @@ func newLogsExporter(config config.Exporter, level string, logger *zap.Logger) (
 		exporterhelper.WithTimeout(exporterhelper.TimeoutSettings{Timeout: 0}),
 		exporterhelper.WithRetry(exporterhelper.RetrySettings{Enabled: false}),
 		exporterhelper.WithQueue(exporterhelper.QueueSettings{Enabled: false}),
-		exporterhelper.WithShutdown(loggerSync(logger)),
+		exporterhelper.WithComponentOptions(componenthelper.WithShutdown(loggerSync(logger))),
 	)
 }
 

diff --git a/exporter/opencensusexporter/factory.go b/exporter/opencensusexporter/factory.go
@@ -18,6 +18,7 @@ import (
 	"context"
 
 	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/component/componenthelper"
 	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/config/configgrpc"
 	"go.opentelemetry.io/collector/exporter/exporterhelper"
@@ -65,7 +66,7 @@ func createTraceExporter(ctx context.Context, params component.ExporterCreatePar
 		oce.pushTraceData,
 		exporterhelper.WithRetry(oCfg.RetrySettings),
 		exporterhelper.WithQueue(oCfg.QueueSettings),
-		exporterhelper.WithShutdown(oce.shutdown))
+		exporterhelper.WithComponentOptions(componenthelper.WithShutdown(oce.shutdown)))
 }
 
 func createMetricsExporter(ctx context.Context, params component.ExporterCreateParams, cfg config.Exporter) (component.MetricsExporter, error) {
@@ -81,5 +82,5 @@ func createMetricsExporter(ctx context.Context, params component.ExporterCreateP
 		oce.pushMetricsData,
 		exporterhelper.WithRetry(oCfg.RetrySettings),
 		exporterhelper.WithQueue(oCfg.QueueSettings),
-		exporterhelper.WithShutdown(oce.shutdown))
+		exporterhelper.WithComponentOptions(componenthelper.WithShutdown(oce.shutdown)))
 }
diff --git a/exporter/otlpexporter/factory.go b/exporter/otlpexporter/factory.go
@@ -18,6 +18,7 @@ import (
 	"context"
 
 	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/component/componenthelper"
 	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/config/configgrpc"
 	"go.opentelemetry.io/collector/exporter/exporterhelper"
@@ -72,7 +73,7 @@ func createTraceExporter(
 		exporterhelper.WithTimeout(oCfg.TimeoutSettings),
 		exporterhelper.WithRetry(oCfg.RetrySettings),
 		exporterhelper.WithQueue(oCfg.QueueSettings),
-		exporterhelper.WithShutdown(oce.shutdown))
+		exporterhelper.WithComponentOptions(componenthelper.WithShutdown(oce.shutdown)))
 	if err != nil {
 		return nil, err
 	}
@@ -97,7 +98,7 @@ func createMetricsExporter(
 		exporterhelper.WithTimeout(oCfg.TimeoutSettings),
 		exporterhelper.WithRetry(oCfg.RetrySettings),
 		exporterhelper.WithQueue(oCfg.QueueSettings),
-		exporterhelper.WithShutdown(oce.shutdown),
+		exporterhelper.WithComponentOptions(componenthelper.WithShutdown(oce.shutdown)),
 	)
 	if err != nil {
 		return nil, err
@@ -123,7 +124,7 @@ func createLogsExporter(
 		exporterhelper.WithTimeout(oCfg.TimeoutSettings),
 		exporterhelper.WithRetry(oCfg.RetrySettings),
 		exporterhelper.WithQueue(oCfg.QueueSettings),
-		exporterhelper.WithShutdown(oce.shutdown),
+		exporterhelper.WithComponentOptions(componenthelper.WithShutdown(oce.shutdown)),
 	)
 	if err != nil {
 		return nil, err

diff --git a/exporter/prometheusremotewriteexporter/factory.go b/exporter/prometheusremotewriteexporter/factory.go
@@ -19,6 +19,7 @@ import (
 	"errors"
 
 	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/component/componenthelper"
 	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/config/confighttp"
 	"go.opentelemetry.io/collector/exporter/exporterhelper"
@@ -61,7 +62,7 @@ func createMetricsExporter(_ context.Context, params component.ExporterCreatePar
 		exporterhelper.WithTimeout(prwCfg.TimeoutSettings),
 		exporterhelper.WithQueue(prwCfg.QueueSettings),
 		exporterhelper.WithRetry(prwCfg.RetrySettings),
-		exporterhelper.WithShutdown(prwe.Shutdown),
+		exporterhelper.WithComponentOptions(componenthelper.WithShutdown(prwe.Shutdown)),
 	)
 
 	return prwexp, err

diff --git a/processor/memorylimiter/factory.go b/processor/memorylimiter/factory.go
@@ -18,6 +18,7 @@ import (
 	"context"
 
 	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/component/componenthelper"
 	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/consumer"
 	"go.opentelemetry.io/collector/processor/processorhelper"
@@ -66,7 +67,7 @@ func createTraceProcessor(
 		nextConsumer,
 		ml,
 		processorhelper.WithCapabilities(processorCapabilities),
-		processorhelper.WithShutdown(ml.shutdown))
+		processorhelper.WithComponentOptions(componenthelper.WithShutdown(ml.shutdown)))
 }
 
 func createMetricsProcessor(
@@ -84,7 +85,7 @@ func createMetricsProcessor(
 		nextConsumer,
 		ml,
 		processorhelper.WithCapabilities(processorCapabilities),
-		processorhelper.WithShutdown(ml.shutdown))
+		processorhelper.WithComponentOptions(componenthelper.WithShutdown(ml.shutdown)))
 }
 
 func createLogsProcessor(
@@ -102,5 +103,5 @@ func createLogsProcessor(
 		nextConsumer,
 		ml,
 		processorhelper.WithCapabilities(processorCapabilities),
-		processorhelper.WithShutdown(ml.shutdown))
+		processorhelper.WithComponentOptions(componenthelper.WithShutdown(ml.shutdown)))
 }
diff --git a/processor/memorylimiter/memorylimiter_test.go b/processor/memorylimiter/memorylimiter_test.go
@@ -24,6 +24,7 @@ import (
 	"github.com/stretchr/testify/require"
 	"go.uber.org/zap"
 
+	"go.opentelemetry.io/collector/component/componenthelper"
 	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/config/configtelemetry"
 	"go.opentelemetry.io/collector/consumer"
@@ -127,7 +128,7 @@ func TestMetricsMemoryPressureResponse(t *testing.T) {
 		consumertest.NewMetricsNop(),
 		ml,
 		processorhelper.WithCapabilities(processorCapabilities),
-		processorhelper.WithShutdown(ml.shutdown))
+		processorhelper.WithComponentOptions(componenthelper.WithShutdown(ml.shutdown)))
 	require.NoError(t, err)
 
 	ctx := context.Background()
@@ -201,7 +202,7 @@ func TestTraceMemoryPressureResponse(t *testing.T) {
 		consumertest.NewTracesNop(),
 		ml,
 		processorhelper.WithCapabilities(processorCapabilities),
-		processorhelper.WithShutdown(ml.shutdown))
+		processorhelper.WithComponentOptions(componenthelper.WithShutdown(ml.shutdown)))
 	require.NoError(t, err)
 
 	ctx := context.Background()
@@ -275,7 +276,7 @@ func TestLogMemoryPressureResponse(t *testing.T) {
 		consumertest.NewLogsNop(),
 		ml,
 		processorhelper.WithCapabilities(processorCapabilities),
-		processorhelper.WithShutdown(ml.shutdown))
+		processorhelper.WithComponentOptions(componenthelper.WithShutdown(ml.shutdown)))
 	require.NoError(t, err)
 
 	ctx := context.Background()

diff --git a/processor/processorhelper/processor.go b/processor/processorhelper/processor.go
@@ -58,23 +58,15 @@ type LProcessor interface {
 // Option apply changes to internalOptions.
 type Option func(*baseSettings)
 
-// WithStart overrides the default Start function for an processor.
-// The default shutdown function does nothing and always returns nil.
-func WithStart(start componenthelper.Start) Option {
+// WithComponentOption adds options that apply to a generic component
+// (such as start and shutdown hooks).
+func WithComponentOptions(opts ...componenthelper.Option) Option {
 	return func(o *baseSettings) {
-		o.componentOptions = append(o.componentOptions, componenthelper.WithStart(start))
+		o.componentOptions = append(o.componentOptions, opts...)
 	}
 }
 
-// WithShutdown overrides the default Shutdown function for an processor.
-// The default shutdown function does nothing and always returns nil.
-func WithShutdown(shutdown componenthelper.Shutdown) Option {
-	return func(o *baseSettings) {
-		o.componentOptions = append(o.componentOptions, componenthelper.WithShutdown(shutdown))
-	}
-}
-
-// WithShutdown overrides the default GetCapabilities function for an processor.
+// WithCapabilities overrides the default GetCapabilities function for an processor.
 // The default GetCapabilities function returns mutable capabilities.
 func WithCapabilities(capabilities component.ProcessorCapabilities) Option {
 	return func(o *baseSettings) {