Skip to content

Commit

Permalink
[pkg/stanza] Handle entry error of callback function in ProcessWithCa…
Browse files Browse the repository at this point in the history
…llback (#35769)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

Out of the discussions at
#35758
I realized that `ProcessWithCallback` does not handle the error returned
by the callback function. Since the error of the parse function is
handled I think we should handle this of the callback too.

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

<!--Describe what testing was performed and which tests were added.-->
#### Testing

<!--Describe the documentation added.-->
#### Documentation

<!--Please delete paragraphs that you did not use before submitting.-->

---------

Signed-off-by: ChrsMark <[email protected]>
  • Loading branch information
ChrsMark authored Oct 23, 2024
1 parent 088e40c commit e3594d2
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
31 changes: 31 additions & 0 deletions .chloggen/stanza_handle_cb_errors.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# 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: Handle error of callback function of `ParserOperator.ProcessWithCallback`

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

# (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: |
`ProcessWithCallback` of `ParserOperator` first calls the `ParseWith` method
which properly handles errors with `HandleEntryError`.
Then the callback function is called and its returned error should also
be handled by the `HandleEntryError` ensuring a consistent experience.
# 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: [user]
2 changes: 1 addition & 1 deletion pkg/stanza/operator/helper/parser.go
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ func (p *ParserOperator) ProcessWithCallback(ctx context.Context, entry *entry.E
if cb != nil {
err = cb(entry)
if err != nil {
return err
return p.HandleEntryError(ctx, entry, err)
}
}

Expand Down

0 comments on commit e3594d2

Please sign in to comment.