Propagate telemetry.resource to the internal logs. open-telemetry#12582

Signed-off-by: Israel Blancas <[email protected]>

Author: iblancasa

.chloggen/iblancasa_fix-resource-attributes-internal-logs.yaml

@@ -0,0 +1,27 @@
+# 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: "internal telemetry"
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: "Add resource attributes from telemetry.resource to the logger"
+
+# One or more tracking issues or pull requests related to the change
+issues: [12582]
+
+# (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: |
+  Resource attributes from telemetry.resource were not added to the internal
+  logs but to metrics and traces. This fix ensures they are added to the logs.
+
+# 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: []

service/telemetry/logger.go

@@ -37,23 +37,34 @@ func newLogger(set Settings, cfg Config) (*zap.Logger, log.LoggerProvider, error
 		return nil, nil, err
 	}
 
+	fields := []zap.Field{}
+	for k, v := range cfg.Resource {
+		if v != nil {
+			f := zap.Field{Key: k, Type: zapcore.StringType, String: *v}
+			fields = append(fields, f)
+		}
+	}
+
 	var lp log.LoggerProvider
 
 	if len(cfg.Logs.Processors) > 0 && set.SDK != nil {
 		lp = set.SDK.LoggerProvider()
 
-		logger = logger.WithOptions(zap.WrapCore(func(c zapcore.Core) zapcore.Core {
-			core, err := zapcore.NewIncreaseLevelCore(zapcore.NewTee(
-				c,
-				otelzap.NewCore("go.opentelemetry.io/collector/service/telemetry",
-					otelzap.WithLoggerProvider(lp),
-				),
-			), zap.NewAtomicLevelAt(cfg.Logs.Level))
-			if err != nil {
-				panic(err)
-			}
-			return core
-		}))
+		logger = logger.WithOptions(
+			zap.WrapCore(func(c zapcore.Core) zapcore.Core {
+				core, err := zapcore.NewIncreaseLevelCore(zapcore.NewTee(
+					c,
+					otelzap.NewCore("go.opentelemetry.io/collector/service/telemetry",
+						otelzap.WithLoggerProvider(lp),
+					),
+				), zap.NewAtomicLevelAt(cfg.Logs.Level))
+				if err != nil {
+					panic(err)
+				}
+				return core
+			}),
+			zap.Fields(fields...),
+		)
 	}
 
 	if cfg.Logs.Sampling != nil && cfg.Logs.Sampling.Enabled {

service/telemetry/logger_test.go

@@ -6,12 +6,19 @@ package telemetry // import "go.opentelemetry.io/collector/service/telemetry"
 import (
 	"context"
 	"errors"
+	"io"
+	"net/http"
+	"net/http/httptest"
 	"reflect"
 	"testing"
 
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	config "go.opentelemetry.io/contrib/otelconf/v0.3.0"
 	"go.uber.org/zap/zapcore"
+
+	"go.opentelemetry.io/collector/pdata/plog/plogotlp"
+	semconv "go.opentelemetry.io/collector/semconv/v1.18.0"
 )
 
 func TestNewLogger(t *testing.T) {
@@ -79,13 +86,114 @@ func TestNewLogger(t *testing.T) {
 				require.NoError(t, err)
 				gotType := reflect.TypeOf(l.Core()).String()
 				require.Equal(t, tt.wantCoreType, gotType)
-				type shutdownable interface {
-					Shutdown(context.Context) error
-				}
 				if prov, ok := lp.(shutdownable); ok {
 					require.NoError(t, prov.Shutdown(context.Background()))
 				}
 			}
 		})
 	}
 }
+
+func TestOTELZapIntegration(t *testing.T) {
+	version := "1.2.3"
+	service := "test-service"
+	testAttribute := "test-attribute"
+
+	receivedLogs := 0
+	totalLogs := 10
+
+	// Create a backend to receive the logs and assert the content
+	srv := createBackend("/v1/logs", func(writer http.ResponseWriter, request *http.Request) {
+		body, err := io.ReadAll(request.Body)
+		require.NoError(t, err)
+		defer request.Body.Close()
+
+		// Unmarshal the protobuf body into logs
+		req := plogotlp.NewExportRequest()
+		err = req.UnmarshalProto(body)
+		require.NoError(t, err)
+
+		logs := req.Logs()
+		rl := logs.ResourceLogs().At(0)
+		sl := rl.ScopeLogs().At(0)
+		logRecord := sl.LogRecords().At(0)
+		attrs := logRecord.Attributes().AsRaw()
+
+		assert.Contains(t, attrs, semconv.AttributeServiceName)
+		assert.Contains(t, attrs, semconv.AttributeServiceVersion)
+		assert.Contains(t, attrs, testAttribute)
+		receivedLogs++
+
+		writer.WriteHeader(http.StatusOK)
+	})
+	defer srv.Close()
+
+	processors := []config.LogRecordProcessor{
+		{
+			Simple: &config.SimpleLogRecordProcessor{
+				Exporter: config.LogRecordExporter{
+					OTLP: &config.OTLP{
+						Endpoint: ptr(srv.URL),
+						Protocol: ptr("http/protobuf"),
+						Insecure: ptr(true),
+					},
+				},
+			},
+		},
+	}
+
+	sdk, _ := config.NewSDK(
+		config.WithOpenTelemetryConfiguration(
+			config.OpenTelemetryConfiguration{
+				LoggerProvider: &config.LoggerProvider{
+					Processors: processors,
+				},
+			},
+		),
+	)
+
+	cfg := Config{
+		Logs: LogsConfig{
+			Level:       zapcore.DebugLevel,
+			Development: true,
+			Encoding:    "json",
+			Processors:  processors,
+		},
+		Resource: map[string]*string{
+			semconv.AttributeServiceName:    ptr(service),
+			semconv.AttributeServiceVersion: ptr(version),
+			testAttribute:                   ptr("test-value"),
+		},
+	}
+	l, lp, err := newLogger(Settings{SDK: &sdk}, cfg)
+	require.NoError(t, err)
+	require.NotNil(t, l)
+	require.NotNil(t, lp)
+
+	defer func() {
+		if prov, ok := lp.(shutdownable); ok {
+			require.NoError(t, prov.Shutdown(context.Background()))
+		}
+	}()
+
+	// Generate some logs to send to the backend
+	for i := 0; i < totalLogs; i++ {
+		l.Info("Test log message")
+	}
+
+	// Ensure the correct number of logs were received
+	assert.Equal(t, totalLogs, receivedLogs)
+}
+
+type shutdownable interface {
+	Shutdown(context.Context) error
+}
+
+func createBackend(endpoint string, handler func(writer http.ResponseWriter, request *http.Request)) *httptest.Server {
+	mux := http.NewServeMux()
+	mux.HandleFunc(endpoint, handler)
+
+	srv := httptest.NewServer(mux)
+
+	return srv
+}