diff --git a/CHANGELOG.md b/CHANGELOG.md index 4329a61c..dad634d5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,6 @@ +## x.y.z + - [DOC] described `executor_threads` configuration parameter [#421](https://github.com/logstash-plugins/logstash-input-beats/pull/421) + ## 6.2.0 - ECS compatibility enablement: Adds alias to support upcoming ECS v8 with the existing ECS v1 implementation diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 649b433d..98becc4e 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -163,6 +163,7 @@ This plugin supports the following configuration options plus the <> |<>|No | <> |<>|No | <> | <>|No +| <> |<>|No | <> |<>|No | <> |<>|No | <> |<>|Yes @@ -224,6 +225,24 @@ Close Idle clients after X seconds of inactivity. Refer to <> for detailed information. +[id="plugins-{type}s-{plugin}-executor_threads"] +===== `executor_threads` + + * Value type is <> + * Default value is 1 executor thread per CPU core + +The number of threads to be used to process incoming beats requests. +By default Beats input will create a number of threads equals to 2*CPU cores to handle incoming connections, +reading from the established sockets and execute most of the tasks related to network connection managements, +except the parsing of Lumberjack protocol that's offloaded to a dedicated thread pool. + +Generally you don't need to touch this setting. +In case 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` @@ -355,3 +374,4 @@ The minimum TLS version allowed for the encrypted connections. The value must be include::{include_path}/{type}.asciidoc[] :default_codec!: +