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: make response body decoding errors more informative #36481

Merged
merged 2 commits into from
Sep 4, 2023
Merged

x-pack/filebeat/input/httpjson: make response body decoding errors more informative #36481

merged 2 commits into from
Sep 4, 2023

Conversation

efd6
Copy link
Contributor

@efd6 efd6 commented Aug 31, 2023

Proposed commit message

The default rendering of errors from the json, csv and xml decoders can be a little terse, but the error values themselves contain information that allows the text context of the error to be constructed and returned. It is a common problem that users are unable to decipher the error messages, so add this text context to help.

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 enhancement Filebeat Filebeat Team:Security-External Integrations backport-skip Skip notification from the automated backport with mergify 8.11-candidate labels Aug 31, 2023
@efd6 efd6 self-assigned this Aug 31, 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 Aug 31, 2023
@efd6 efd6 force-pushed the httpjson-decode-errors branch from 445be63 to 049e1ea Compare August 31, 2023 22:48
@efd6 efd6 changed the title x-pack/filebeat/inputs/httpjson: make response body decoding errors more informative x-pack/filebeat/input/httpjson: make response body decoding errors more informative Aug 31, 2023
@efd6 efd6 force-pushed the httpjson-decode-errors branch from 049e1ea to a290dbd Compare August 31, 2023 22:48
@efd6
x-pack/filebeat/input/httpjson: make response body decoding errors mo…
3917f92 
…re informative

The default rendering of errors from the json, csv and xml decoders can
be a little terse, but the error values themselves contain information
that allows the text context of the error to be constructed and
returned. It is a common problem that users are unable to decipher the
error messages, so add this text context to help.
@efd6 efd6 force-pushed the httpjson-decode-errors branch from a290dbd to 3917f92 Compare August 31, 2023 23:19
@elasticmachine
Copy link
Collaborator

elasticmachine commented Aug 31, 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-01T01:21:11.828+0000

  • Duration: 76 min 51 sec

Test stats 🧪

Test Results
Failed 0
Passed 3138
Skipped 176
Total 3314

💚 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 force-pushed the httpjson-decode-errors branch from 1c855ef to 7a88831 Compare August 31, 2023 23:30
@efd6 efd6 force-pushed the httpjson-decode-errors branch from 7a88831 to d326682 Compare September 1, 2023 01:20
@efd6 efd6 marked this pull request as ready for review September 1, 2023 02:41
@efd6 efd6 requested a review from a team as a code owner September 1, 2023 02:41
@elasticmachine
Copy link
Collaborator

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

bhapas
bhapas reviewed Sep 1, 2023
View reviewed changes
Copy link
Contributor

@bhapas bhapas left a comment

Choose a reason for hiding this comment

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

LGTM.
May be need to fix the lint errors.

@efd6
Copy link
Contributor Author

efd6 commented Sep 1, 2023

The lint complaints here are noise.

  • It's not possible to know the number of objects in a JSON stream ahead of time, so we can't preallocate.
  • The error types that are handled in textContextError are returned directly from the standard library's functions that we are calling and are not wrapped. If this ever changes, it will be detected in tests.

bhapas
bhapas approved these changes Sep 1, 2023
View reviewed changes
Copy link
Contributor

@bhapas bhapas left a comment

Choose a reason for hiding this comment

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

LGTM.

May be get another round of review from a more experienced developer in this area.

@efd6 efd6 merged commit ab2f67d into elastic:main Sep 4, 2023
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: make response body decoding errors mo…
c7c7bdb 
…re informative (elastic#36481)

The default rendering of errors from the json, csv and xml decoders can
be a little terse, but the error values themselves contain information
that allows the text context of the error to be constructed and
returned. It is a common problem that users are unable to decipher the
error messages, so add this text context to help.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marc-gr marc-gr marc-gr approved these changes

@bhapas bhapas bhapas 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.
4 participants
@efd6 @elasticmachine @marc-gr @bhapas