From d0e2b3ff16bcc7ccc28ce324c186786f2b776644 Mon Sep 17 00:00:00 2001 From: Samer Jalaleddine Date: Wed, 16 Oct 2024 16:48:54 +0200 Subject: [PATCH] [pkg/stanza] Fix - Operators with DropOnErrorQuiet should drop log entries on error --- .chloggen/operator-silent-errors.yaml | 29 ++++++++++++++ pkg/stanza/operator/helper/parser.go | 4 ++ pkg/stanza/operator/helper/parser_test.go | 39 +++++++++++++++++++ pkg/stanza/operator/helper/transformer.go | 4 -- .../operator/helper/transformer_test.go | 4 +- 5 files changed, 74 insertions(+), 6 deletions(-) create mode 100644 .chloggen/operator-silent-errors.yaml diff --git a/.chloggen/operator-silent-errors.yaml b/.chloggen/operator-silent-errors.yaml new file mode 100644 index 000000000000..7db3d80b7ab1 --- /dev/null +++ b/.chloggen/operator-silent-errors.yaml @@ -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: [] \ No newline at end of file diff --git a/pkg/stanza/operator/helper/parser.go b/pkg/stanza/operator/helper/parser.go index 56b2eaccd106..e5fa686f7ddc 100644 --- a/pkg/stanza/operator/helper/parser.go +++ b/pkg/stanza/operator/helper/parser.go @@ -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 { diff --git a/pkg/stanza/operator/helper/parser_test.go b/pkg/stanza/operator/helper/parser_test.go index 36a5fbb37f91..f8b69985a611 100644 --- a/pkg/stanza/operator/helper/parser_test.go +++ b/pkg/stanza/operator/helper/parser_test.go @@ -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{ @@ -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{ diff --git a/pkg/stanza/operator/helper/transformer.go b/pkg/stanza/operator/helper/transformer.go index e1b9faf69c22..a8b5a8709bfd 100644 --- a/pkg/stanza/operator/helper/transformer.go +++ b/pkg/stanza/operator/helper/transformer.go @@ -106,10 +106,6 @@ func (t *TransformerOperator) HandleEntryError(ctx context.Context, entry *entry } } - if t.OnError == SendOnErrorQuiet || t.OnError == DropOnErrorQuiet { - return nil - } - return err } diff --git a/pkg/stanza/operator/helper/transformer_test.go b/pkg/stanza/operator/helper/transformer_test.go index 9bacf0fd6e7f..f03c02dbefcc 100644 --- a/pkg/stanza/operator/helper/transformer_test.go +++ b/pkg/stanza/operator/helper/transformer_test.go @@ -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 @@ -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