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

Add documentation for executor_threads #409

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add documentation for executor_threads #409

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
| <<plugins-{type}s-{plugin}-add_hostname>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-cipher_suites>> |<<array,array>>|No
| <<plugins-{type}s-{plugin}-client_inactivity_timeout>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-executor_threads>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-include_codec_tag>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|Yes
Expand Down Expand Up @@ -144,6 +145,24 @@ The list of ciphers suite to use, listed by priorities.

Close Idle clients after X seconds of inactivity.

[id="plugins-{type}s-{plugin}-executor_threads"]
===== `executor_threads`

* Value type is <<number,number>>
* Default value is the number of CPU cores

Number of threads used to handle beats data.
The Beats input will create a threadpool of size 2*CPU cores to handle incoming connections,
reading from the established sockets and execute most of the tasks such as SSL/idle state detection/batch acking.
Parsing of the lumberjack protocol frames is however done by a separate threadpool of size "CPU cores".

By default you don't need to touch this setting.
If you are sending very large events and observing "OutOfDirectMemory" exceptions,
you may want to reduce this number to half or 1/4 of the CPU cores.
This will reduce the number of threads decompressing batches of data into direct memory.
However, this will only be a mitigating tweak, as the proper solution may require resizing your Logstash deployment,
either by increasing number of Logstash nodes or increasing the JVM's Direct Memory.

[id="plugins-{type}s-{plugin}-host"]
===== `host`

Expand Down