Skip to content

Commit

Permalink
Operators with silent errors will log errors as debug and won't retur…
Browse files Browse the repository at this point in the history
…n an error (#35010)

An operator configured with silent errors shouldn't log errors while
processing log entries.

**Description:** 
Operators that are expected to sometimes fail, can result in error logs
that are quite verbose.
This aims to address this issue by getting rid of error logs that the
user wishes to silence (debug logs instead).
By making sure no error is returned, there won't be any need to worry
about other components logging error logs.

**Link to tracking Issue:** [Issue
#35008](#35008)

**Testing:** 
Manually tested as this is a matter of logs.
  • Loading branch information
SamerJ authored Sep 6, 2024
1 parent d5595bb commit f970421
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 3 deletions.
27 changes: 27 additions & 0 deletions .chloggen/operator-silent-error.yaml
Original file line number Diff line number Diff line change
@@ -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. filelogreceiver)
component: pkg/stanza

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: An operator configured with silent errors shouldn't log errors while processing log entries.

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [35008]

# (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:

# 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.
# 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: []
7 changes: 6 additions & 1 deletion pkg/stanza/operator/helper/transformer.go
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,14 @@ func (t *TransformerOperator) HandleEntryError(ctx context.Context, entry *entry
if t.OnError == SendOnError || t.OnError == SendOnErrorQuiet {
writeErr := t.Write(ctx, entry)
if writeErr != nil {
return fmt.Errorf("failed to send entry after error: %w", writeErr)
err = fmt.Errorf("failed to send entry after error: %w", writeErr)
}
}

if t.OnError == SendOnErrorQuiet || t.OnError == DropOnErrorQuiet {
return nil
}

return err
}

Expand Down
4 changes: 2 additions & 2 deletions pkg/stanza/operator/helper/transformer_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ func TestTransformerDropOnErrorQuiet(t *testing.T) {
}

err := transformer.ProcessWith(ctx, testEntry, transform)
require.Error(t, err)
require.NoError(t, err)
output.AssertNotCalled(t, "Process", mock.Anything, mock.Anything)

// Test output logs
Expand Down Expand Up @@ -233,7 +233,7 @@ func TestTransformerSendOnErrorQuiet(t *testing.T) {
}

err := transformer.ProcessWith(ctx, testEntry, transform)
require.Error(t, err)
require.NoError(t, err)
output.AssertCalled(t, "Process", mock.Anything, mock.Anything)

// Test output logs
Expand Down

0 comments on commit f970421

Please sign in to comment.