Pass a Tracer via construct settings to all the components

bogdandrutu · bogdandrutu · commit 3e854f22bf7f · 2021-07-09T17:10:02.000-07:00
Followup PR will use the passed tracer to construct obsreport.

Signed-off-by: Bogdan Drutu &lt;bogdandrutu@gmail.com&gt;
diff --git a/component/componenttest/nop_exporter.go b/component/componenttest/nop_exporter.go
@@ -17,6 +17,7 @@ package componenttest
 import (
 	"context"
 
+	"go.opentelemetry.io/otel/trace"
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
@@ -29,6 +30,7 @@ import (
 func NewNopExporterCreateSettings() component.ExporterCreateSettings {
 	return component.ExporterCreateSettings{
 		Logger:    zap.NewNop(),
+		Tracer:    trace.NewNoopTracerProvider().Tracer(""),
 		BuildInfo: component.DefaultBuildInfo(),
 	}
 }
diff --git a/component/componenttest/nop_extension.go b/component/componenttest/nop_extension.go
@@ -17,6 +17,7 @@ package componenttest
 import (
 	"context"
 
+	"go.opentelemetry.io/otel/trace"
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
@@ -28,6 +29,7 @@ import (
 func NewNopExtensionCreateSettings() component.ExtensionCreateSettings {
 	return component.ExtensionCreateSettings{
 		Logger:    zap.NewNop(),
+		Tracer:    trace.NewNoopTracerProvider().Tracer(""),
 		BuildInfo: component.DefaultBuildInfo(),
 	}
 }
diff --git a/component/componenttest/nop_processor.go b/component/componenttest/nop_processor.go
@@ -17,6 +17,7 @@ package componenttest
 import (
 	"context"
 
+	"go.opentelemetry.io/otel/trace"
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
@@ -30,6 +31,7 @@ import (
 func NewNopProcessorCreateSettings() component.ProcessorCreateSettings {
 	return component.ProcessorCreateSettings{
 		Logger:    zap.NewNop(),
+		Tracer:    trace.NewNoopTracerProvider().Tracer(""),
 		BuildInfo: component.DefaultBuildInfo(),
 	}
 }
diff --git a/component/componenttest/nop_receiver.go b/component/componenttest/nop_receiver.go
@@ -17,6 +17,7 @@ package componenttest
 import (
 	"context"
 
+	"go.opentelemetry.io/otel/trace"
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
@@ -29,6 +30,7 @@ import (
 func NewNopReceiverCreateSettings() component.ReceiverCreateSettings {
 	return component.ReceiverCreateSettings{
 		Logger:    zap.NewNop(),
+		Tracer:    trace.NewNoopTracerProvider().Tracer(""),
 		BuildInfo: component.DefaultBuildInfo(),
 	}
 }
diff --git a/component/exporter.go b/component/exporter.go
@@ -17,6 +17,7 @@ package component
 import (
 	"context"
 
+	"go.opentelemetry.io/otel/trace"
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/config"
@@ -52,6 +53,10 @@ type ExporterCreateSettings struct {
 	// component to be used later as well.
 	Logger *zap.Logger
 
+	// Tracer that the factory can use during creation and can pass to the created
+	// component to be used later as well.
+	Tracer trace.Tracer
+
 	// BuildInfo can be used by components for informational purposes
 	BuildInfo BuildInfo
 }
diff --git a/component/extension.go b/component/extension.go
@@ -17,6 +17,7 @@ package component
 import (
 	"context"
 
+	"go.opentelemetry.io/otel/trace"
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/config"
@@ -52,6 +53,10 @@ type ExtensionCreateSettings struct {
 	// component to be used later as well.
 	Logger *zap.Logger
 
+	// Tracer that the factory can use during creation and can pass to the created
+	// component to be used later as well.
+	Tracer trace.Tracer
+
 	// BuildInfo can be used by components for informational purposes
 	BuildInfo BuildInfo
 }
diff --git a/component/processor.go b/component/processor.go
@@ -17,6 +17,7 @@ package component
 import (
 	"context"
 
+	"go.opentelemetry.io/otel/trace"
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component/componenterror"
@@ -54,6 +55,10 @@ type ProcessorCreateSettings struct {
 	// component to be used later as well.
 	Logger *zap.Logger
 
+	// Tracer that the factory can use during creation and can pass to the created
+	// component to be used later as well.
+	Tracer trace.Tracer
+
 	// BuildInfo can be used by components for informational purposes
 	BuildInfo BuildInfo
 }
diff --git a/component/receiver.go b/component/receiver.go
@@ -17,6 +17,7 @@ package component
 import (
 	"context"
 
+	"go.opentelemetry.io/otel/trace"
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/config"
@@ -61,6 +62,10 @@ type ReceiverCreateSettings struct {
 	// component to be used later as well.
 	Logger *zap.Logger
 
+	// Tracer that the factory can use during creation and can pass to the created
+	// component to be used later as well.
+	Tracer trace.Tracer
+
 	// BuildInfo can be used by components for informational purposes.
 	BuildInfo BuildInfo
 }
diff --git a/service/internal/builder/exporters_builder.go b/service/internal/builder/exporters_builder.go
@@ -18,6 +18,7 @@ import (
 	"context"
 	"fmt"
 
+	"go.opentelemetry.io/otel/trace"
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
@@ -143,6 +144,7 @@ type exportersRequiredDataTypes map[config.Exporter]dataTypeRequirements
 // BuildExporters builds Exporters from config.
 func BuildExporters(
 	logger *zap.Logger,
+	tracerProvider trace.TracerProvider,
 	buildInfo component.BuildInfo,
 	config *config.Config,
 	factories map[config.Type]component.ExporterFactory,
@@ -155,17 +157,18 @@ func BuildExporters(
 
 	exporters := make(Exporters)
 	// BuildExporters exporters based on configuration and required input data types.
-	for _, cfg := range config.Exporters {
+	for _, expCfg := range config.Exporters {
 		set := component.ExporterCreateSettings{
-			Logger:    logger.With(zap.Stringer(zapNameKey, cfg.ID())),
+			Logger:    logger.With(zap.Stringer(zapNameKey, expCfg.ID())),
+			Tracer:    tracerProvider.Tracer(fmt.Sprintf("%s/%v", zapKindLogExporter, expCfg.ID())),
 			BuildInfo: buildInfo,
 		}
-		exp, err := buildExporter(context.Background(), factories, set, cfg, exporterInputDataTypes)
+		exp, err := buildExporter(context.Background(), factories, set, expCfg, exporterInputDataTypes)
 		if err != nil {
 			return nil, err
 		}
 
-		exporters[cfg] = exp
+		exporters[expCfg] = exp
 	}
 
 	return exporters, nil
diff --git a/service/internal/builder/exporters_builder_test.go b/service/internal/builder/exporters_builder_test.go
@@ -21,6 +21,7 @@ import (
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/otel/trace"
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
@@ -60,7 +61,7 @@ func TestBuildExporters(t *testing.T) {
 		},
 	}
 
-	exporters, err := BuildExporters(zap.NewNop(), component.DefaultBuildInfo(), cfg, factories.Exporters)
+	exporters, err := BuildExporters(zap.NewNop(), trace.NewNoopTracerProvider(), component.DefaultBuildInfo(), cfg, factories.Exporters)
 
 	assert.NoError(t, err)
 	require.NotNil(t, exporters)
@@ -89,7 +90,7 @@ func TestBuildExporters(t *testing.T) {
 	// This should result in creating an exporter that has none of consumption
 	// functions set.
 	delete(cfg.Service.Pipelines, "trace")
-	exporters, err = BuildExporters(zap.NewNop(), component.DefaultBuildInfo(), cfg, factories.Exporters)
+	exporters, err = BuildExporters(zap.NewNop(), trace.NewNoopTracerProvider(), component.DefaultBuildInfo(), cfg, factories.Exporters)
 	assert.NotNil(t, exporters)
 	assert.NoError(t, err)
 
@@ -127,7 +128,7 @@ func TestBuildExporters_BuildLogs(t *testing.T) {
 		},
 	}
 
-	exporters, err := BuildExporters(zap.NewNop(), component.DefaultBuildInfo(), cfg, factories.Exporters)
+	exporters, err := BuildExporters(zap.NewNop(), trace.NewNoopTracerProvider(), component.DefaultBuildInfo(), cfg, factories.Exporters)
 
 	assert.NoError(t, err)
 	require.NotNil(t, exporters)
@@ -152,7 +153,7 @@ func TestBuildExporters_BuildLogs(t *testing.T) {
 	// This should result in creating an exporter that has none of consumption
 	// functions set.
 	delete(cfg.Service.Pipelines, "logs")
-	exporters, err = BuildExporters(zap.NewNop(), component.DefaultBuildInfo(), cfg, factories.Exporters)
+	exporters, err = BuildExporters(zap.NewNop(), trace.NewNoopTracerProvider(), component.DefaultBuildInfo(), cfg, factories.Exporters)
 	assert.NotNil(t, exporters)
 	assert.Nil(t, err)
 
@@ -238,7 +239,7 @@ func TestBuildExporters_NotSupportedDataType(t *testing.T) {
 			cfg, err := configtest.LoadConfigAndValidate(path.Join("testdata", test.configFile), factories)
 			require.Nil(t, err)
 
-			exporters, err := BuildExporters(zap.NewNop(), component.DefaultBuildInfo(), cfg, factories.Exporters)
+			exporters, err := BuildExporters(zap.NewNop(), trace.NewNoopTracerProvider(), component.DefaultBuildInfo(), cfg, factories.Exporters)
 			assert.Error(t, err)
 			assert.Zero(t, len(exporters))
 		})
diff --git a/service/internal/builder/extensions_builder.go b/service/internal/builder/extensions_builder.go
@@ -18,6 +18,7 @@ import (
 	"context"
 	"fmt"
 
+	"go.opentelemetry.io/otel/trace"
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
@@ -113,6 +114,7 @@ func (exts Extensions) ToMap() map[config.ComponentID]component.Extension {
 // BuildExtensions builds Extensions from config.
 func BuildExtensions(
 	logger *zap.Logger,
+	tracerProvider trace.TracerProvider,
 	buildInfo component.BuildInfo,
 	config *config.Config,
 	factories map[config.Type]component.ExtensionFactory,
@@ -127,6 +129,7 @@ func BuildExtensions(
 
 		set := component.ExtensionCreateSettings{
 			Logger:    logger.With(zap.Stringer(zapNameKey, extCfg.ID())),
+			Tracer:    tracerProvider.Tracer(fmt.Sprintf("%s/%v", zapKindExtension, extCfg.ID())),
 			BuildInfo: buildInfo,
 		}
 		ext, err := buildExtension(context.Background(), factories, set, extCfg)
diff --git a/service/internal/builder/extensions_builder_test.go b/service/internal/builder/extensions_builder_test.go
@@ -20,6 +20,7 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	"go.opentelemetry.io/otel/trace"
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
@@ -115,7 +116,7 @@ func TestService_setupExtensions(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			ext, err := BuildExtensions(zap.NewNop(), component.DefaultBuildInfo(), tt.config, tt.factories.Extensions)
+			ext, err := BuildExtensions(zap.NewNop(), trace.NewNoopTracerProvider(), component.DefaultBuildInfo(), tt.config, tt.factories.Extensions)
 
 			assert.Error(t, err)
 			assert.Equal(t, tt.wantErrMsg, err.Error())
diff --git a/service/internal/builder/pipelines_builder.go b/service/internal/builder/pipelines_builder.go
@@ -18,6 +18,7 @@ import (
 	"context"
 	"fmt"
 
+	"go.opentelemetry.io/otel/trace"
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
@@ -81,23 +82,25 @@ func (bps BuiltPipelines) ShutdownProcessors(ctx context.Context) error {
 
 // pipelinesBuilder builds Pipelines from config.
 type pipelinesBuilder struct {
-	logger    *zap.Logger
-	buildInfo component.BuildInfo
-	config    *config.Config
-	exporters Exporters
-	factories map[config.Type]component.ProcessorFactory
+	logger         *zap.Logger
+	tracerProvider trace.TracerProvider
+	buildInfo      component.BuildInfo
+	config         *config.Config
+	exporters      Exporters
+	factories      map[config.Type]component.ProcessorFactory
 }
 
 // BuildPipelines builds pipeline processors from config. Requires exporters to be already
 // built via BuildExporters.
 func BuildPipelines(
 	logger *zap.Logger,
+	tracerProvider trace.TracerProvider,
 	buildInfo component.BuildInfo,
 	config *config.Config,
 	exporters Exporters,
 	factories map[config.Type]component.ProcessorFactory,
 ) (BuiltPipelines, error) {
-	pb := &pipelinesBuilder{logger, buildInfo, config, exporters, factories}
+	pb := &pipelinesBuilder{logger, tracerProvider, buildInfo, config, exporters, factories}
 
 	pipelineProcessors := make(BuiltPipelines)
 	for _, pipeline := range pb.config.Service.Pipelines {
@@ -152,6 +155,7 @@ func (pb *pipelinesBuilder) buildPipeline(ctx context.Context, pipelineCfg *conf
 		var err error
 		set := component.ProcessorCreateSettings{
 			Logger:    pb.logger.With(zap.String(zapKindKey, zapKindProcessor), zap.Stringer(zapNameKey, procCfg.ID())),
+			Tracer:    pb.tracerProvider.Tracer(fmt.Sprintf("%s/%v", zapKindProcessor, procCfg.ID())),
 			BuildInfo: pb.buildInfo,
 		}
 
diff --git a/service/internal/builder/pipelines_builder_test.go b/service/internal/builder/pipelines_builder_test.go
@@ -21,6 +21,7 @@ import (
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/otel/trace"
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
@@ -112,15 +113,15 @@ func TestBuildPipelines_BuildVarious(t *testing.T) {
 			cfg := createExampleConfig(dataType)
 
 			// BuildProcessors the pipeline
-			allExporters, err := BuildExporters(zap.NewNop(), component.DefaultBuildInfo(), cfg, factories.Exporters)
+			allExporters, err := BuildExporters(zap.NewNop(), trace.NewNoopTracerProvider(), component.DefaultBuildInfo(), cfg, factories.Exporters)
 			if test.shouldFail {
 				assert.Error(t, err)
 				return
 			}
 
 			require.NoError(t, err)
 			require.EqualValues(t, 1, len(allExporters))
-			pipelineProcessors, err := BuildPipelines(zap.NewNop(), component.DefaultBuildInfo(), cfg, allExporters, factories.Processors)
+			pipelineProcessors, err := BuildPipelines(zap.NewNop(), trace.NewNoopTracerProvider(), component.DefaultBuildInfo(), cfg, allExporters, factories.Processors)
 
 			assert.NoError(t, err)
 			require.NotNil(t, pipelineProcessors)
@@ -184,9 +185,9 @@ func testPipeline(t *testing.T, pipelineName string, exporterIDs []config.Compon
 	require.Nil(t, err)
 
 	// BuildProcessors the pipeline
-	allExporters, err := BuildExporters(zap.NewNop(), component.DefaultBuildInfo(), cfg, factories.Exporters)
+	allExporters, err := BuildExporters(zap.NewNop(), trace.NewNoopTracerProvider(), component.DefaultBuildInfo(), cfg, factories.Exporters)
 	assert.NoError(t, err)
-	pipelineProcessors, err := BuildPipelines(zap.NewNop(), component.DefaultBuildInfo(), cfg, allExporters, factories.Processors)
+	pipelineProcessors, err := BuildPipelines(zap.NewNop(), trace.NewNoopTracerProvider(), component.DefaultBuildInfo(), cfg, allExporters, factories.Processors)
 
 	assert.NoError(t, err)
 	require.NotNil(t, pipelineProcessors)
@@ -258,10 +259,10 @@ func TestBuildPipelines_NotSupportedDataType(t *testing.T) {
 			cfg, err := configtest.LoadConfigAndValidate(path.Join("testdata", test.configFile), factories)
 			require.Nil(t, err)
 
-			allExporters, err := BuildExporters(zap.NewNop(), component.DefaultBuildInfo(), cfg, factories.Exporters)
+			allExporters, err := BuildExporters(zap.NewNop(), trace.NewNoopTracerProvider(), component.DefaultBuildInfo(), cfg, factories.Exporters)
 			assert.NoError(t, err)
 
-			pipelineProcessors, err := BuildPipelines(zap.NewNop(), component.DefaultBuildInfo(), cfg, allExporters, factories.Processors)
+			pipelineProcessors, err := BuildPipelines(zap.NewNop(), trace.NewNoopTracerProvider(), component.DefaultBuildInfo(), cfg, allExporters, factories.Processors)
 			assert.Error(t, err)
 			assert.Zero(t, len(pipelineProcessors))
 		})
diff --git a/service/internal/builder/receivers_builder.go b/service/internal/builder/receivers_builder.go
diff --git a/service/internal/builder/receivers_builder_test.go b/service/internal/builder/receivers_builder_test.go
diff --git a/service/service.go b/service/service.go

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ package componenttest`
`17`	`17`	`import (`
`18`	`18`	`"context"`
`19`	`19`
	`20`	`+ "go.opentelemetry.io/otel/trace"`
`20`	`21`	`"go.uber.org/zap"`
`21`	`22`
`22`	`23`	`"go.opentelemetry.io/collector/component"`
`@@ -29,6 +30,7 @@ import (`
`29`	`30`	`func NewNopExporterCreateSettings() component.ExporterCreateSettings {`
`30`	`31`	`return component.ExporterCreateSettings{`
`31`	`32`	`Logger: zap.NewNop(),`
	`33`	`+ Tracer: trace.NewNoopTracerProvider().Tracer(""),`
`32`	`34`	`BuildInfo: component.DefaultBuildInfo(),`
`33`	`35`	`}`
`34`	`36`	`}`