Skip to content

Commit 997ba9f

Browse files
111andre111andsel
andauthored
[DOC] described executor_threads configuration parameter (#421)
[DOC] described `executor_threads` configuration parameter Co-authored-by: andsel <[email protected]>
1 parent 4e1a2a7 commit 997ba9f

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
## x.y.z
2+
- [DOC] described `executor_threads` configuration parameter [#421](https://github.com/logstash-plugins/logstash-input-beats/pull/421)
3+
14
## 6.2.0
25
- ECS compatibility enablement: Adds alias to support upcoming ECS v8 with the existing ECS v1 implementation
36

docs/index.asciidoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
163163
| <<plugins-{type}s-{plugin}-cipher_suites>> |<<array,array>>|No
164164
| <<plugins-{type}s-{plugin}-client_inactivity_timeout>> |<<number,number>>|No
165165
| <<plugins-{type}s-{plugin}-ecs_compatibility>> | <<string,string>>|No
166+
| <<plugins-{type}s-{plugin}-executor_threads>> |<<number,number>>|No
166167
| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
167168
| <<plugins-{type}s-{plugin}-include_codec_tag>> |<<boolean,boolean>>|No
168169
| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|Yes
@@ -224,6 +225,24 @@ Close Idle clients after X seconds of inactivity.
224225

225226
Refer to <<plugins-{type}s-{plugin}-ecs_metadata,ECS mapping>> for detailed information.
226227

228+
[id="plugins-{type}s-{plugin}-executor_threads"]
229+
===== `executor_threads`
230+
231+
* Value type is <<number,number>>
232+
* Default value is 1 executor thread per CPU core
233+
234+
The number of threads to be used to process incoming beats requests.
235+
By default Beats input will create a number of threads equals to 2*CPU cores to handle incoming connections,
236+
reading from the established sockets and execute most of the tasks related to network connection managements,
237+
except the parsing of Lumberjack protocol that's offloaded to a dedicated thread pool.
238+
239+
Generally you don't need to touch this setting.
240+
In case you are sending very large events and observing "OutOfDirectMemory" exceptions,
241+
you may want to reduce this number to half or 1/4 of the CPU cores.
242+
This will reduce the number of threads decompressing batches of data into direct memory.
243+
However, this will only be a mitigating tweak, as the proper solution may require resizing your Logstash deployment,
244+
either by increasing number of Logstash nodes or increasing the JVM's Direct Memory.
245+
227246
[id="plugins-{type}s-{plugin}-host"]
228247
===== `host`
229248

@@ -355,3 +374,4 @@ The minimum TLS version allowed for the encrypted connections. The value must be
355374
include::{include_path}/{type}.asciidoc[]
356375

357376
:default_codec!:
377+

0 commit comments

Comments
 (0)