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

[8.12](backport #40231) update max_number_of_messages parameter description #40339

Closed
wants to merge 2 commits into from

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Jul 24, 2024

Proposed commit message

This PR is to update the documentation for max_number_of_messages to inform users to be cautious when using a large value for this var.

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.

This is an automatic backport of pull request #40231 done by [Mergify](https://mergify.com).

@mergify mergify bot added the backport label Jul 24, 2024
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Jul 24, 2024
@botelastic
Copy link

botelastic bot commented Jul 24, 2024

This pull request doesn't have a Team:<team> label.

Copy link
Contributor Author

mergify bot commented Jul 29, 2024

This pull request has not been merged yet. Could you please review and merge it @kaiyan-sheng? 🙏

@kaiyan-sheng kaiyan-sheng requested a review from a team as a code owner July 29, 2024 15:37
@kaiyan-sheng kaiyan-sheng requested review from leehinman, VihasMakwana, v1v and pazone and removed request for a team July 29, 2024 15:37
@v1v
Copy link
Member

v1v commented Aug 1, 2024

@kaiyan-sheng , AFAIR, backports from Mergify only need approval from the former owner. I don't know if that policy has changed since I'm not actively involved in Beats, cc @pazone

Copy link
Contributor Author

mergify bot commented Aug 5, 2024

This pull request has not been merged yet. Could you please review and merge it @kaiyan-sheng? 🙏

.buildkite/pipeline.py Show resolved Hide resolved
@@ -261,7 +261,13 @@ The default is `10 MiB`.
==== `max_number_of_messages`

The maximum number of SQS messages that can be inflight at any time. Defaults
to 5.
to 5. When processing large amount of large size S3 objects and each object has
large amount of events, if this parameter sets too high, it can cause the input
Copy link
Contributor

Choose a reason for hiding this comment

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

When processing large amount of large size S3 objects and each object has large amount of events, if this parameter sets too high, it can cause the input to process too many messages concurrently, overload the agent and cause ingest failure.

Perhaps something like:
Setting this parameter too high can overload Elastic Agent and cause ingest failures in situations where the SQS messages contain many S3 objects or the S3 objects themselves contain large numbers of messages.

Or minimally:

When processing a large number of large size S3 objects that each have a large number of events, if this parameter is set too high, it can cause the input to process too many messages concurrently, overloading the agent and causing ingest failure.

Copy link
Contributor

Choose a reason for hiding this comment

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

@strawgate Thanks for the review!! Ugh sorry this is a backup PR. Let me change it in a main branch in a separate PR and backport it into these branches.

to process too many messages concurrently, overload the agent and cause ingest failure.
We recommend to keep the default value 5 and use the
{fleet-guide}/es-output-settings.html#es-output-settings-performance-tuning-settings[preset]
option to tune your Elastic Agent performance. You can optimize for throughput,
Copy link
Contributor

Choose a reason for hiding this comment

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

We should specifically recommend either Balanced or Throughput for this use-case

pazone
pazone previously approved these changes Aug 6, 2024
@pazone pazone dismissed their stale review August 6, 2024 23:39

The approval is not relevant to the changes

Copy link
Contributor Author

mergify bot commented Aug 12, 2024

This pull request has not been merged yet. Could you please review and merge it @kaiyan-sheng? 🙏

@kaiyan-sheng
Copy link
Contributor

closing this PR with #40513

@kaiyan-sheng kaiyan-sheng deleted the mergify/bp/8.12/pr-40231 branch August 14, 2024 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport needs_team Indicates that the issue/PR needs a Team:* label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants