Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

x-pack/filebeat/input/httpjson: improve error logging #36529

Merged
merged 2 commits into from
Sep 11, 2023
Merged

x-pack/filebeat/input/httpjson: improve error logging #36529

merged 2 commits into from
Sep 11, 2023

Conversation

efd6
Copy link
Contributor

@efd6 efd6 commented Sep 6, 2023 •
edited
Loading

Proposed commit message

Improves the friendliness and utility of error logging in the HTTPJSON input by

  • making errors relate to behaviour rather than implementation
  • removing duplicated wrapping
  • making use of textContextError for JSON decoding failures
  • improving consistency of error formatting and typography

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

@efd6 efd6 added Filebeat Filebeat Team:Security-External Integrations backport-skip Skip notification from the automated backport with mergify 8.11-candidate labels Sep 6, 2023
@efd6 efd6 self-assigned this Sep 6, 2023
@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Sep 6, 2023
@elasticmachine
Copy link
Collaborator

elasticmachine commented Sep 6, 2023 •
edited by jenkins-beats-ci bot
Loading

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-09-11T10:37:01.652+0000

  • Duration: 73 min 18 sec

Test stats 🧪

Test Results
Failed 0
Passed 3177
Skipped 174
Total 3351

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@efd6 efd6 marked this pull request as ready for review September 6, 2023 23:25
@efd6 efd6 requested a review from a team as a code owner September 6, 2023 23:25
@elasticmachine
Copy link
Collaborator

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

@mergify

This comment was marked as outdated.

Sign in to view
@efd6
x-pack/filebeat/input/httpjson: improve error logging
7ecfe2d 
* make errors relate to behaviour rather than implementation
* remove duplicated wrapping
* make use of textContextError for JSON decoding failures
* improve consistency of error formatting and typography
kcreddy
kcreddy approved these changes Sep 11, 2023
View reviewed changes
Copy link
Contributor

@kcreddy kcreddy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍🏼

x-pack/filebeat/input/httpjson/request.go Outdated
@@ -660,21 +663,21 @@ func (r *requester) processChainPaginationEvents(ctx context.Context, trCtx *tra
// reformat urls of requestFactory using ids
rf.url, err = generateNewUrl(rf.replace, urlString, id)
if err != nil {
return -1, fmt.Errorf("failed to generate new URL: %w", err)
return -1, fmt.Errorf("failed to generate new url: %w", err)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The error message seems to be same as https://github.com/elastic/beats/pull/36529/files#diff-ffe24395246b343e8006e4eaef52c2d3bf68c20497ac96ef1e626d4351258047R155. Since this is specific for chain requests, should we change it to failed to generate new url for chain pagination request? Ofcourse, we also have the line number inside the error trace. Just checking..

Copy link
Contributor Author

@efd6 efd6 Sep 11, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll differentiate this. Thanks, I was trying to make them all searchably unique. Line numbers are OK, but error message strings are far more robust, and in this case the error is generated at a different site to where the log call will be made.

@efd6 efd6 merged commit 95be378 into elastic:main Sep 11, 2023
8 checks passed
Scholar-Li pushed a commit to Scholar-Li/beats that referenced this pull request Feb 5, 2024
@efd6 @Scholar-Li
x-pack/filebeat/input/httpjson: improve error logging (elastic#36529)
c70214a 
* make errors relate to behaviour rather than implementation
* remove duplicated wrapping
* make use of textContextError for JSON decoding failures
* improve consistency of error formatting and typography
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kcreddy kcreddy kcreddy approved these changes

Assignees

@efd6 efd6

Labels
8.11-candidate backport-skip Skip notification from the automated backport with mergify enhancement Filebeat Filebeat
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@efd6 @elasticmachine @kcreddy