Re-enable zap fileds for the default service configuration

Signed-off-by: Bogdan Drutu <[email protected]>

Author: bogdandrutu

.chloggen/reenable-logging-attributes.yaml

@@ -0,0 +1,25 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: bug_fix
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: telemetry
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Re-enable zap fileds for the default service configuration
+
+# One or more tracking issues or pull requests related to the change
+issues: [12869]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: [user]

internal/telemetry/componentattribute/logger.go

@@ -0,0 +1,46 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package componentattribute // import "go.opentelemetry.io/collector/internal/telemetry/componentattribute"
+
+import (
+	"go.opentelemetry.io/otel/attribute"
+	"go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
+)
+
+var _ zapcore.Core = (*coreWithout)(nil)
+
+type coreWithout struct {
+	zapcore.Core
+	from   zapcore.Core
+	fields []zap.Field
+}
+
+func NewLogger(logger *zap.Logger, attrs *attribute.Set) *zap.Logger {
+	var fields []zap.Field
+	for _, kv := range attrs.ToSlice() {
+		fields = append(fields, zap.String(string(kv.Key), kv.Value.AsString()))
+	}
+	return logger.WithOptions(
+		zap.WrapCore(func(core zapcore.Core) zapcore.Core {
+			return &coreWithout{Core: core.With(fields), from: core, fields: fields}
+		}),
+	)
+}
+
+func (l *coreWithout) Without(keys ...string) zapcore.Core {
+	excludeKeys := make(map[string]struct{})
+	for _, key := range keys {
+		excludeKeys[key] = struct{}{}
+	}
+
+	var fieldsWithout []zap.Field
+	for _, field := range l.fields {
+		if _, excluded := excludeKeys[field.Key]; !excluded {
+			fieldsWithout = append(fieldsWithout, field)
+		}
+	}
+
+	return &coreWithout{Core: l.from.With(fieldsWithout), from: l.from, fields: fieldsWithout}
+}

internal/telemetry/componentattribute/logger_test.go

@@ -132,3 +132,55 @@ func TestCore(t *testing.T) {
 		})
 	}
 }
+
+type loggerCore interface {
+	Without(fields ...string) zapcore.Core
+}
+
+func TestLegacyCore(t *testing.T) {
+	core, observed := observer.New(zap.DebugLevel)
+	logger := zap.New(core).With(zap.String("preexisting", "value"))
+
+	attrs := attribute.NewSet(
+		attribute.String(componentattribute.SignalKey, pipeline.SignalLogs.String()),
+		attribute.String(componentattribute.ComponentIDKey, "filelog"),
+	)
+
+	parent := componentattribute.NewLogger(logger, &attrs)
+	parent.Info("test parent before child")
+	childCore := parent.Core().(loggerCore).Without(string(componentattribute.SignalKey))
+	child := zap.New(childCore)
+	child.Info("test child")
+	parent.Info("test parent after child")
+
+	observedLogs := observed.All()
+	require.Len(t, observedLogs, 3)
+
+	parentContext := map[string]string{
+		"preexisting":                     "value",
+		componentattribute.SignalKey:      pipeline.SignalLogs.String(),
+		componentattribute.ComponentIDKey: "filelog",
+	}
+	childContext := map[string]string{
+		"preexisting":                     "value",
+		componentattribute.ComponentIDKey: "filelog",
+	}
+
+	require.Equal(t, "test parent before child", observedLogs[0].Message)
+	require.Len(t, observedLogs[0].Context, len(parentContext))
+	for _, field := range observedLogs[0].Context {
+		require.Equal(t, parentContext[field.Key], field.String)
+	}
+
+	require.Equal(t, "test child", observedLogs[1].Message)
+	require.Len(t, observedLogs[1].Context, len(childContext))
+	for _, field := range observedLogs[1].Context {
+		require.Equal(t, childContext[field.Key], field.String)
+	}
+
+	require.Equal(t, "test parent after child", observedLogs[2].Message)
+	require.Len(t, observedLogs[2].Context, len(parentContext))
+	for _, field := range observedLogs[2].Context {
+		require.Equal(t, parentContext[field.Key], field.String)
+	}
+}

service/internal/graph/connector.go

@@ -12,6 +12,7 @@ import (
 	"go.opentelemetry.io/collector/consumer"
 	"go.opentelemetry.io/collector/consumer/xconsumer"
 	"go.opentelemetry.io/collector/internal/telemetry"
+	"go.opentelemetry.io/collector/internal/telemetry/componentattribute"
 	"go.opentelemetry.io/collector/pipeline"
 	"go.opentelemetry.io/collector/pipeline/xpipeline"
 	"go.opentelemetry.io/collector/service/internal/attribute"
@@ -52,6 +53,8 @@ func (n *connectorNode) buildComponent(
 	set := connector.Settings{ID: n.componentID, TelemetrySettings: tel, BuildInfo: info}
 	if telemetry.NewPipelineTelemetryGate.IsEnabled() {
 		set.TelemetrySettings = telemetry.WithAttributeSet(set.TelemetrySettings, *n.Set())
+	} else {
+		set.Logger = componentattribute.NewLogger(tel.Logger, n.Set())
 	}
 	switch n.rcvrPipelineType {
 	case pipeline.SignalTraces:

service/internal/graph/exporter.go

@@ -10,6 +10,7 @@ import (
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/exporter"
 	"go.opentelemetry.io/collector/internal/telemetry"
+	"go.opentelemetry.io/collector/internal/telemetry/componentattribute"
 	"go.opentelemetry.io/collector/pipeline"
 	"go.opentelemetry.io/collector/pipeline/xpipeline"
 	"go.opentelemetry.io/collector/service/internal/attribute"
@@ -48,6 +49,8 @@ func (n *exporterNode) buildComponent(
 	set := exporter.Settings{ID: n.componentID, TelemetrySettings: tel, BuildInfo: info}
 	if telemetry.NewPipelineTelemetryGate.IsEnabled() {
 		set.TelemetrySettings = telemetry.WithAttributeSet(set.TelemetrySettings, *n.Set())
+	} else {
+		set.Logger = componentattribute.NewLogger(tel.Logger, n.Set())
 	}
 	var err error
 	switch n.pipelineType {

service/internal/graph/processor.go

@@ -11,6 +11,7 @@ import (
 	"go.opentelemetry.io/collector/consumer"
 	"go.opentelemetry.io/collector/consumer/xconsumer"
 	"go.opentelemetry.io/collector/internal/telemetry"
+	"go.opentelemetry.io/collector/internal/telemetry/componentattribute"
 	"go.opentelemetry.io/collector/pipeline"
 	"go.opentelemetry.io/collector/pipeline/xpipeline"
 	"go.opentelemetry.io/collector/processor"
@@ -50,6 +51,8 @@ func (n *processorNode) buildComponent(ctx context.Context,
 	set := processor.Settings{ID: n.componentID, TelemetrySettings: tel, BuildInfo: info}
 	if telemetry.NewPipelineTelemetryGate.IsEnabled() {
 		set.TelemetrySettings = telemetry.WithAttributeSet(set.TelemetrySettings, *n.Set())
+	} else {
+		set.Logger = componentattribute.NewLogger(tel.Logger, n.Set())
 	}
 	var err error
 	switch n.pipelineID.Signal() {

service/internal/graph/receiver.go

@@ -12,6 +12,7 @@ import (
 	"go.opentelemetry.io/collector/consumer/xconsumer"
 	"go.opentelemetry.io/collector/internal/fanoutconsumer"
 	"go.opentelemetry.io/collector/internal/telemetry"
+	"go.opentelemetry.io/collector/internal/telemetry/componentattribute"
 	"go.opentelemetry.io/collector/pipeline"
 	"go.opentelemetry.io/collector/pipeline/xpipeline"
 	"go.opentelemetry.io/collector/receiver"
@@ -45,6 +46,8 @@ func (n *receiverNode) buildComponent(ctx context.Context,
 	set := receiver.Settings{ID: n.componentID, TelemetrySettings: tel, BuildInfo: info}
 	if telemetry.NewPipelineTelemetryGate.IsEnabled() {
 		set.TelemetrySettings = telemetry.WithAttributeSet(set.TelemetrySettings, *n.Set())
+	} else {
+		set.Logger = componentattribute.NewLogger(tel.Logger, n.Set())
 	}
 	var err error
 	switch n.pipelineType {