Add TelemetrySettings.LoggerWithout for streamlined usage

Author: djaglowski

Diff for: component/componentattribute/logger.go

@@ -9,44 +9,46 @@ import (
 	"go.uber.org/zap/zapcore"
 )
 
-var _ zapcore.Core = (*Core)(nil)
+var _ zapcore.Core = (*coreWithout)(nil)
 
-type Core struct {
+type coreWithout struct {
 	zapcore.Core
 	from  *zap.Logger
 	attrs attribute.Set
 }
 
 func NewLogger(from *zap.Logger, attrs *attribute.Set) *zap.Logger {
-	withAttributes := from
+	fields := []zap.Field{}
 	for _, kv := range attrs.ToSlice() {
-		withAttributes = withAttributes.With(zap.String(string(kv.Key), kv.Value.AsString()))
+		fields = append(fields, zap.String(string(kv.Key), kv.Value.AsString()))
 	}
-	return zap.New(&Core{
-		Core:  withAttributes.Core(),
-		from:  from,
-		attrs: *attrs,
-	})
+	return from.WithOptions(
+		zap.Fields(fields...),
+		zap.WrapCore(func(core zapcore.Core) zapcore.Core {
+			return &coreWithout{Core: core, from: from, attrs: *attrs}
+		}),
+	)
 }
 
-func (l *Core) Without(keys ...string) *zap.Logger {
+func (l *coreWithout) Without(keys ...string) *zap.Logger {
 	excludeKeys := make(map[string]struct{})
 	for _, key := range keys {
 		excludeKeys[key] = struct{}{}
 	}
 
 	newAttrs := []attribute.KeyValue{}
-	withAttributes := l.from
+	fields := []zap.Field{}
 	for _, kv := range l.attrs.ToSlice() {
 		if _, excluded := excludeKeys[string(kv.Key)]; !excluded {
 			newAttrs = append(newAttrs, kv)
-			withAttributes = withAttributes.With(zap.String(string(kv.Key), kv.Value.AsString()))
+			fields = append(fields, zap.String(string(kv.Key), kv.Value.AsString()))
 		}
 	}
 
-	return zap.New(&Core{
-		Core:  withAttributes.Core(),
-		from:  l.from,
-		attrs: attribute.NewSet(newAttrs...),
-	})
+	return l.from.WithOptions(
+		zap.Fields(fields...),
+		zap.WrapCore(func(core zapcore.Core) zapcore.Core {
+			return &coreWithout{Core: core, from: l.from, attrs: attribute.NewSet(newAttrs...)}
+		}),
+	)
 }

Diff for: component/componentattribute/logger_test.go

@@ -9,12 +9,18 @@ import (
 	"github.com/stretchr/testify/require"
 	"go.opentelemetry.io/otel/attribute"
 	"go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
 	"go.uber.org/zap/zaptest/observer"
 
 	"go.opentelemetry.io/collector/component/componentattribute"
 	"go.opentelemetry.io/collector/pipeline"
 )
 
+type loggerCore interface {
+	zapcore.Core
+	Without(fields ...string) *zap.Logger
+}
+
 func TestLogger(t *testing.T) {
 	core, observed := observer.New(zap.DebugLevel)
 	logger := zap.New(core).With(zap.String("preexisting", "value"))
@@ -26,7 +32,7 @@ func TestLogger(t *testing.T) {
 
 	parent := componentattribute.NewLogger(logger, &attrs)
 	parent.Info("test parent before child")
-	child := parent.Core().(*componentattribute.Core).Without(string(componentattribute.SignalKey))
+	child := parent.Core().(loggerCore).Without(string(componentattribute.SignalKey))
 	child.Info("test child")
 	parent.Info("test parent after child")
 

Diff for: component/telemetry.go

@@ -7,6 +7,7 @@ import (
 	"go.opentelemetry.io/otel/metric"
 	"go.opentelemetry.io/otel/trace"
 	"go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
 
 	"go.opentelemetry.io/collector/pdata/pcommon"
 )
@@ -26,3 +27,14 @@ type TelemetrySettings struct {
 	// Resource contains the resource attributes for the collector's telemetry.
 	Resource pcommon.Resource
 }
+
+func (ts *TelemetrySettings) LoggerWithout(fields ...string) *zap.Logger {
+	type loggerCore interface {
+		zapcore.Core
+		Without(fields ...string) *zap.Logger
+	}
+	if _, ok := ts.Logger.Core().(loggerCore); !ok {
+		return ts.Logger
+	}
+	return ts.Logger.Core().(loggerCore).Without(fields...)
+}

Diff for: processor/memorylimiterprocessor/factory.go

@@ -106,14 +106,12 @@ func (f *factory) getMemoryLimiter(set processor.Settings, cfg component.Config)
 		return memLimiter, nil
 	}
 
-	if c, ok := set.Logger.Core().(*componentattribute.Core); ok {
-		set.Logger = c.Without(
-			componentattribute.SignalKey,
-			componentattribute.PipelineIDKey,
-			componentattribute.ComponentIDKey,
-		)
-		set.Logger.Debug("created singleton logger")
-	}
+	set.Logger = set.TelemetrySettings.LoggerWithout(
+		componentattribute.SignalKey,
+		componentattribute.PipelineIDKey,
+		componentattribute.ComponentIDKey,
+	)
+	set.Logger.Debug("created singleton logger")
 
 	memLimiter, err := newMemoryLimiterProcessor(set, cfg.(*Config))
 	if err != nil {

Diff for: receiver/otlpreceiver/otlp.go

@@ -53,10 +53,8 @@ type otlpReceiver struct {
 // responsibility to invoke the respective Start*Reception methods as well
 // as the various Stop*Reception methods to end it.
 func newOtlpReceiver(cfg *Config, set *receiver.Settings) (*otlpReceiver, error) {
-	if c, ok := set.Logger.Core().(*componentattribute.Core); ok {
-		set.Logger = c.Without(componentattribute.SignalKey)
-		set.Logger.Debug("created signal-agnostic logger")
-	}
+	set.Logger = set.TelemetrySettings.LoggerWithout(componentattribute.SignalKey)
+	set.Logger.Debug("created signal-agnostic logger")
 	r := &otlpReceiver{
 		cfg:          cfg,
 		nextTraces:   nil,