Remove entry body logging, use timestamp instead

Author: douglascamata

.chloggen/improve-log-transformers-logs.yaml

@@ -7,7 +7,7 @@ change_type: enhancement
 component: pkg/stanza
 
 # A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
-note: Add log file path and original record to errors logs from log transformers processors
+note: Add log file path and entry timestamp to errors logs from log transformers processors
 
 # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
 issues: [37285]
@@ -16,8 +16,8 @@ issues: [37285]
 # These lines will be padded with 2 spaces and then inserted directly into the document.
 # Use pipe (|) for multiline entries.
 subtext: |
-  When a log transformer processor fails to process an log entry it will include the log file path and the entry's body in its own logs.
-  This makes it easier to debug why certain log entries are causing issues in the processors. 
+  When a log transformer processor fails to process an log entry it will include the log file path and the entry's timestamp in its own logs.
+  With this information the user can access the log file and find the entry that's having issues.
 
 # If your change doesn't affect end users or the exported elements of any package,
 # you should instead start your pull request title with [chore] or use the "Skip Changelog" label.

pkg/stanza/fileconsumer/attrs/attrs.go

@@ -18,7 +18,6 @@ const (
 	LogFileOwnerName      = "log.file.owner.name"
 	LogFileOwnerGroupName = "log.file.owner.group.name"
 	LogFileRecordNumber   = "log.file.record_number"
-	LogRecordOriginal     = "log.record.original"
 )
 
 type Resolver struct {

pkg/stanza/operator/helper/transformer.go

@@ -101,7 +101,7 @@ func (t *TransformerOperator) HandleEntryError(ctx context.Context, entry *entry
 		zap.Any("action", t.OnError),
 	}
 	if entry != nil {
-		toAddFields := []zap.Field{zap.Any(attrs.LogRecordOriginal, entry.Body)}
+		toAddFields := []zap.Field{zap.Any("entry.timestamp", entry.Timestamp)}
 		if logFilePath, ok := entry.Attributes[attrs.LogFilePath]; ok {
 			toAddFields = slices.Insert(toAddFields, 0, zap.Any(attrs.LogFilePath, logFilePath))
 		}

pkg/stanza/operator/helper/transformer_test.go

@@ -7,6 +7,7 @@ import (
 	"context"
 	"fmt"
 	"testing"
+	"time"
 
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
@@ -92,7 +93,8 @@ func TestTransformerDropOnError(t *testing.T) {
 	}
 	ctx := context.Background()
 	testEntry := entry.New()
-	testEntry.Body = "test"
+	now := time.Now()
+	testEntry.Timestamp = now
 	testEntry.AddAttribute(attrs.LogFilePath, "/test/file")
 	transform := func(_ *entry.Entry) error {
 		return fmt.Errorf("Failure")
@@ -108,7 +110,7 @@ func TestTransformerDropOnError(t *testing.T) {
 			Entry: zapcore.Entry{Level: zap.ErrorLevel, Message: "Failed to process entry"},
 			Context: []zapcore.Field{
 				zap.Any(attrs.LogFilePath, "/test/file"),
-				zap.Any(attrs.LogRecordOriginal, "test"),
+				zap.Any("entry.timestamp", now),
 				{Key: "error", Type: zapcore.ErrorType, Interface: fmt.Errorf("Failure")},
 				zap.Any("action", "drop"),
 			},
@@ -141,7 +143,8 @@ func TestTransformerDropOnErrorQuiet(t *testing.T) {
 	}
 	ctx := context.Background()
 	testEntry := entry.New()
-	testEntry.Body = "test"
+	now := time.Now()
+	testEntry.Timestamp = now
 	testEntry.AddAttribute(attrs.LogFilePath, "/test/file")
 	transform := func(_ *entry.Entry) error {
 		return fmt.Errorf("Failure")
@@ -157,7 +160,7 @@ func TestTransformerDropOnErrorQuiet(t *testing.T) {
 			Entry: zapcore.Entry{Level: zap.DebugLevel, Message: "Failed to process entry"},
 			Context: []zapcore.Field{
 				zap.Any(attrs.LogFilePath, "/test/file"),
-				zap.Any(attrs.LogRecordOriginal, "test"),
+				zap.Any("entry.timestamp", now),
 				{Key: "error", Type: 26, Interface: fmt.Errorf("Failure")},
 				zap.Any("action", "drop_quiet"),
 			},
@@ -190,7 +193,8 @@ func TestTransformerSendOnError(t *testing.T) {
 	}
 	ctx := context.Background()
 	testEntry := entry.New()
-	testEntry.Body = "test"
+	now := time.Now()
+	testEntry.Timestamp = now
 	testEntry.AddAttribute(attrs.LogFilePath, "/test/file")
 	transform := func(_ *entry.Entry) error {
 		return fmt.Errorf("Failure")
@@ -206,7 +210,7 @@ func TestTransformerSendOnError(t *testing.T) {
 			Entry: zapcore.Entry{Level: zap.ErrorLevel, Message: "Failed to process entry"},
 			Context: []zapcore.Field{
 				zap.Any(attrs.LogFilePath, "/test/file"),
-				zap.Any(attrs.LogRecordOriginal, "test"),
+				zap.Any("entry.timestamp", now),
 				{Key: "error", Type: 26, Interface: fmt.Errorf("Failure")},
 				zap.Any("action", "send"),
 			},
@@ -239,7 +243,8 @@ func TestTransformerSendOnErrorQuiet(t *testing.T) {
 	}
 	ctx := context.Background()
 	testEntry := entry.New()
-	testEntry.Body = "test"
+	now := time.Now()
+	testEntry.Timestamp = now
 	testEntry.AddAttribute(attrs.LogFilePath, "/test/file")
 	transform := func(_ *entry.Entry) error {
 		return fmt.Errorf("Failure")
@@ -255,7 +260,7 @@ func TestTransformerSendOnErrorQuiet(t *testing.T) {
 			Entry: zapcore.Entry{Level: zap.DebugLevel, Message: "Failed to process entry"},
 			Context: []zapcore.Field{
 				zap.Any(attrs.LogFilePath, "/test/file"),
-				zap.Any(attrs.LogRecordOriginal, "test"),
+				zap.Any("entry.timestamp", now),
 				{Key: "error", Type: 26, Interface: fmt.Errorf("Failure")},
 				zap.Any("action", "send_quiet"),
 			},

pkg/stanza/operator/transformer/router/transformer.go

@@ -43,7 +43,7 @@ func (t *Transformer) Process(ctx context.Context, entry *entry.Entry) error {
 
 	logger := t.Logger()
 	if entry != nil {
-		toAddFields := []zap.Field{zap.Any(attrs.LogRecordOriginal, entry.Body)}
+		toAddFields := []zap.Field{zap.Any("entry.timestamp", entry.Timestamp)}
 		if logFilePath, ok := entry.Attributes[attrs.LogFilePath]; ok {
 			toAddFields = slices.Insert(toAddFields, 0, zap.Any(attrs.LogFilePath, logFilePath))
 		}