Skip to content

Commit

Permalink
[pkg/stanza] Fix - Operators with DropOnErrorQuiet should drop log en… (
Browse files Browse the repository at this point in the history
open-telemetry#35834)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
Fixed issue in which Operators with DropOnErrorQuiet are not dropping
log entries on error.

Note: This issue was introduced by a bug fix meant to ensure Silent
Operators are not logging errors (open-telemetry#35010). With this fix,
this side effect bug has been resolved.

<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes 35010

<!--Describe what testing was performed and which tests were added.-->
#### Testing
Added UT
  • Loading branch information
SamerJ authored and jpbarto committed Oct 29, 2024
1 parent f52152c commit 355189a
Show file tree
Hide file tree
Showing 5 changed files with 74 additions and 6 deletions.
29 changes: 29 additions & 0 deletions .chloggen/operator-silent-errors.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 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: Fixed bug causing Operators with DropOnErrorQuiet to send log entries to the next operator.

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

# (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: |
This issue was introduced by a bug fix meant to ensure Silent Operators are not logging errors (#35010). With this fix,
this side effect bug has been resolved.
# 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: []
4 changes: 4 additions & 0 deletions pkg/stanza/operator/helper/parser.go
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,10 @@ func (p *ParserOperator) ProcessWithCallback(ctx context.Context, entry *entry.E
}

if err = p.ParseWith(ctx, entry, parse); err != nil {
if p.OnError == DropOnErrorQuiet || p.OnError == SendOnErrorQuiet {
return nil
}

return err
}
if cb != nil {
Expand Down
39 changes: 39 additions & 0 deletions pkg/stanza/operator/helper/parser_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,25 @@ func TestParserInvalidParseDrop(t *testing.T) {
fakeOut.ExpectNoEntry(t, 100*time.Millisecond)
}

func TestParserInvalidParseDropQuiet(t *testing.T) {
writer, fakeOut := writerWithFakeOut(t)
parser := ParserOperator{
TransformerOperator: TransformerOperator{
WriterOperator: *writer,
OnError: DropOnErrorQuiet,
},
ParseFrom: entry.NewBodyField(),
}
parse := func(i any) (any, error) {
return i, fmt.Errorf("parse failure")
}
ctx := context.Background()
testEntry := entry.New()
err := parser.ProcessWith(ctx, testEntry, parse)
require.NoError(t, err, "error should be silent")
fakeOut.ExpectNoEntry(t, 100*time.Millisecond) // Entry should be dropped
}

func TestParserInvalidParseSend(t *testing.T) {
writer, fakeOut := writerWithFakeOut(t)
parser := ParserOperator{
Expand All @@ -162,6 +181,26 @@ func TestParserInvalidParseSend(t *testing.T) {
fakeOut.ExpectNoEntry(t, 100*time.Millisecond)
}

func TestParserInvalidParseSendQuiet(t *testing.T) {
writer, fakeOut := writerWithFakeOut(t)
parser := ParserOperator{
TransformerOperator: TransformerOperator{
WriterOperator: *writer,
OnError: SendOnErrorQuiet,
},
ParseFrom: entry.NewBodyField(),
}
parse := func(i any) (any, error) {
return i, fmt.Errorf("parse failure")
}
ctx := context.Background()
testEntry := entry.New()
err := parser.ProcessWith(ctx, testEntry, parse)
require.NoError(t, err, "error should be silent")
fakeOut.ExpectEntry(t, testEntry)
fakeOut.ExpectNoEntry(t, 100*time.Millisecond)
}

func TestParserInvalidTimeParseDrop(t *testing.T) {
writer, fakeOut := writerWithFakeOut(t)
parser := ParserOperator{
Expand Down
4 changes: 0 additions & 4 deletions pkg/stanza/operator/helper/transformer.go
Original file line number Diff line number Diff line change
Expand Up @@ -106,10 +106,6 @@ func (t *TransformerOperator) HandleEntryError(ctx context.Context, entry *entry
}
}

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 @@ -141,7 +141,7 @@ func TestTransformerDropOnErrorQuiet(t *testing.T) {
}

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

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

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

// Test output logs
Expand Down

0 comments on commit 355189a

Please sign in to comment.