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.

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

x-pack/filebeat/input/httpjson: drop response bodies at end of execution #38116

Merged
merged 1 commit into from
Feb 23, 2024

Conversation

efd6
Copy link
Contributor

@efd6 efd6 commented Feb 22, 2024

Proposed commit message

The response bodies of the first and last responses were being held in a closed-over variable resulting in high static memory loads in some situations. The bodies are not used between periodic executions with the documentation stating that only cursor values are persisted across restarts. The difference in behaviour between using the body field over a restart versus over a sequence of executions in the same run make them unsafe, so clarify the persistence behaviour in the documentation and free the bodies at the end of an execution.

A survey of integrations that use the httpjson input did not identify any that are using behaviour that is being removed, but we will need to keep an eye on cases that may have been missed. In general, if persistence is being depended on, the cursor should be being used.

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 bugfix backport-v8.12.0 Automated backport with mergify Team:Security-Service Integrations Security Service Integrations Team 8.13-candidate labels Feb 22, 2024
@efd6 efd6 self-assigned this Feb 22, 2024
@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 Feb 22, 2024
The response bodies of the first and last responses were being held in a
closed-over variable resulting in high static memory loads in some
situations. The bodies are not used between periodic executions with the
documentation stating that only cursor values are persisted across
restarts. The difference in behaviour between using the body field over
a restart versus over a sequence of executions in the same run make them
unsafe, so clarify the persistence behaviour in the documentation and
free the bodies at the end of an execution.

A survey of integrations that use the httpjson input did not identify
any that are using behaviour that is being removed, but we will need to
keep an eye on cases that may have been missed. In general, if
persistence is being depended on, the cursor should be being used.
@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

cc @efd6

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

cc @efd6

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

cc @efd6

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

cc @efd6

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

cc @efd6

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

cc @efd6

@efd6 efd6 marked this pull request as ready for review February 23, 2024 01:03
@efd6 efd6 requested a review from a team as a code owner February 23, 2024 01:03
@elasticmachine
Copy link
Collaborator

Pinging @elastic/security-service-integrations (Team:Security-Service Integrations)

@elasticmachine
Copy link
Collaborator

💚 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

  • Duration: 137 min 33 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 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 merged commit 353dab3 into elastic:main Feb 23, 2024
37 of 39 checks passed
mergify bot pushed a commit that referenced this pull request Feb 23, 2024
…ion (#38116)

The response bodies of the first and last responses were being held in a
closed-over variable resulting in high static memory loads in some
situations. The bodies are not used between periodic executions with the
documentation stating that only cursor values are persisted across
restarts. The difference in behaviour between using the body field over
a restart versus over a sequence of executions in the same run make them
unsafe, so clarify the persistence behaviour in the documentation and
free the bodies at the end of an execution.

A survey of integrations that use the httpjson input did not identify
any that are using behaviour that is being removed, but we will need to
keep an eye on cases that may have been missed. In general, if
persistence is being depended on, the cursor should be being used.

(cherry picked from commit 353dab3)
efd6 added a commit that referenced this pull request Feb 23, 2024
… bodies at end of execution (#38128)

* x-pack/filebeat/input/httpjson: drop response bodies at end of execution (#38116)

The response bodies of the first and last responses were being held in a
closed-over variable resulting in high static memory loads in some
situations. The bodies are not used between periodic executions with the
documentation stating that only cursor values are persisted across
restarts. The difference in behaviour between using the body field over
a restart versus over a sequence of executions in the same run make them
unsafe, so clarify the persistence behaviour in the documentation and
free the bodies at the end of an execution.

A survey of integrations that use the httpjson input did not identify
any that are using behaviour that is being removed, but we will need to
keep an eye on cases that may have been missed. In general, if
persistence is being depended on, the cursor should be being used.

(cherry picked from commit 353dab3)

* remove irrelevant changelog entries

---------

Co-authored-by: Dan Kortschak <90160302+efd6@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.13-candidate backport-v8.12.0 Automated backport with mergify bugfix Filebeat Filebeat Team:Security-Service Integrations Security Service Integrations Team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Filebeat] httpjson - possible memory leak
3 participants