Adds section to describe intended usage of pipeline.buffer.type
#16083
Conversation
andsel
changed the title
pipeline.buffer.type
| @@ -118,6 +118,29 @@ To summarize, we have 3 categories of memory usage, where 2 can be limited by th | |||
|
|
|||
| Keep these memory requirements in mind as you calculate your ideal memory allocation. | |||
|
|
|||
| [[reducing-off-heap-usage]] | |||
There was a problem hiding this comment.
I wonder if we should better highlight this somehow. The use of this setting completely changes the way Logstash works. Also, it would give us the ability to better understand Logstash when troubleshooting.
However, the direct result of this is that will completely impact/affect JVM Heap sizing. So I propose we:
- Bring some more visibility into this setting, maybe say this will be the default in future versions of Logstash.
- Tell users that this is a recommended setting to be set?
- And, in the memory size/performance tuning sections to have references to this setting being turned on??
Any thoughts?
There was a problem hiding this comment.
This feels like troubleshooting information more than guidance on Reducing off-heap usage. I reworked the text a bit to emphasize the troubleshooting angle. I'm wondering if this should move to the troubleshooting section rather than the best practice section.
I know that we have a JVM settings section in Best Practices, but restructuring content could make this work.
Co-authored-by: Karen Metts <[email protected]>
Co-authored-by: Karen Metts <[email protected]>
|
@andsel, I left two suggestions inline. If you apply them both, that should clear the docs-ci issues. :-) |
docs/static/config-details.asciidoc
Outdated
| @@ -118,6 +118,29 @@ To summarize, we have 3 categories of memory usage, where 2 can be limited by th | |||
|
|
|||
| Keep these memory requirements in mind as you calculate your ideal memory allocation. | |||
|
|
|||
| [[reducing-off-heap-usage]] | |||
| ===== Reducing off-heap usage | |||
| Some plugins like Elastic Agent, Beats, TCP and HTTP take advantage of direct memory to get | |||
There was a problem hiding this comment.
| Some plugins like Elastic Agent, Beats, TCP and HTTP take advantage of direct memory to get | |
| Plugins like Elastic Agent, Beats, TCP, and HTTP take advantage of direct memory to achieve |
Co-authored-by: João Duarte <[email protected]>
Co-authored-by: João Duarte <[email protected]>
Release notes
[rn:skip]
PREVIEW: https://logstash_bk_16083.docs-preview.app.elstc.co/guide/en/logstash/master/jvm-settings.html
What does this PR do?
Adds section to describe the intended usage of and impact on memory sizing.
Why is it important/What is the impact to the user?
Give better insights when to use the
pipeline.buffer.typeand which is the expected impact on performance and memory consumption.Checklist
[ ] I have commented my code, particularly in hard-to-understand areas[ ] I have made corresponding change to the default configuration files (and/or docker env variables)[ ] I have added tests that prove my fix is effective or that my feature worksAuthor's Checklist
How to test this PR locally
Related issues