From 05eae8157162296ec62a225952138673e0a7c01e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andre=CC=81=20Letterer?= Date: Fri, 23 Apr 2021 11:43:26 +0200 Subject: [PATCH 1/4] added documentation for executor_threads --- docs/index.asciidoc | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 649b433d..673b0a61 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -162,7 +162,11 @@ This plugin supports the following configuration options plus the <> |<>|No | <> |<>|No | <> |<>|No +<<<<<<< HEAD | <> | <>|No +======= +| <> |<>|No +>>>>>>> added documentation for executor_threads | <> |<>|No | <> |<>|No | <> |<>|Yes @@ -210,6 +214,7 @@ The list of ciphers suite to use, listed by priorities. Close Idle clients after X seconds of inactivity. +<<<<<<< HEAD [id="plugins-{type}s-{plugin}-ecs_compatibility"] ===== `ecs_compatibility` @@ -223,6 +228,15 @@ Close Idle clients after X seconds of inactivity. ** Otherwise, the default value is `disabled`. 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 parallel executor threads. +>>>>>>> added documentation for executor_threads [id="plugins-{type}s-{plugin}-host"] ===== `host` From ab349943f3b03151cc5df6a147eea287b56aa6f7 Mon Sep 17 00:00:00 2001 From: andsel Date: Wed, 28 Jul 2021 08:58:11 +0200 Subject: [PATCH 2/4] Put the description in correct order plus little extension to the description --- CHANGELOG.md | 3 +++ docs/index.asciidoc | 16 ++++++++++++++++ 2 files changed, 19 insertions(+) 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 673b0a61..786b7f29 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -163,10 +163,15 @@ This plugin supports the following configuration options plus the <> |<>|No | <> |<>|No <<<<<<< HEAD +<<<<<<< HEAD | <> | <>|No ======= | <> |<>|No >>>>>>> added documentation for executor_threads +======= +| <> | <>|No +| <> |<>|No +>>>>>>> Put the description in correct order plus little extension to the description | <> |<>|No | <> |<>|No | <> |<>|Yes @@ -215,6 +220,9 @@ The list of ciphers suite to use, listed by priorities. Close Idle clients after X seconds of inactivity. <<<<<<< HEAD +<<<<<<< HEAD +======= +>>>>>>> Put the description in correct order plus little extension to the description [id="plugins-{type}s-{plugin}-ecs_compatibility"] ===== `ecs_compatibility` @@ -238,6 +246,14 @@ Refer to <> for detailed info The number of parallel executor threads. >>>>>>> added documentation for executor_threads +[id="plugins-{type}s-{plugin}-executor_threads"] +===== `executor_threads` + + * Value type is <> + * Default value is 1 executor thread per CPU core + +The number of parallel executor threads to be used to process incoming beats requests. + [id="plugins-{type}s-{plugin}-host"] ===== `host` From d7dc1f1080286ac5815e72168f7b9241d062fc31 Mon Sep 17 00:00:00 2001 From: andsel Date: Thu, 29 Jul 2021 09:08:29 +0200 Subject: [PATCH 3/4] Aligned to master --- docs/index.asciidoc | 22 +--------------------- 1 file changed, 1 insertion(+), 21 deletions(-) diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 786b7f29..15ec58db 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -162,16 +162,8 @@ This plugin supports the following configuration options plus the <> |<>|No | <> |<>|No | <> |<>|No -<<<<<<< HEAD -<<<<<<< HEAD | <> | <>|No -======= | <> |<>|No ->>>>>>> added documentation for executor_threads -======= -| <> | <>|No -| <> |<>|No ->>>>>>> Put the description in correct order plus little extension to the description | <> |<>|No | <> |<>|No | <> |<>|Yes @@ -219,10 +211,6 @@ The list of ciphers suite to use, listed by priorities. Close Idle clients after X seconds of inactivity. -<<<<<<< HEAD -<<<<<<< HEAD -======= ->>>>>>> Put the description in correct order plus little extension to the description [id="plugins-{type}s-{plugin}-ecs_compatibility"] ===== `ecs_compatibility` @@ -236,15 +224,6 @@ Close Idle clients after X seconds of inactivity. ** Otherwise, the default value is `disabled`. 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 parallel executor threads. ->>>>>>> added documentation for executor_threads [id="plugins-{type}s-{plugin}-executor_threads"] ===== `executor_threads` @@ -385,3 +364,4 @@ The minimum TLS version allowed for the encrypted connections. The value must be include::{include_path}/{type}.asciidoc[] :default_codec!: + From 17beb0d063fe6524333264e89e18369bee0d3102 Mon Sep 17 00:00:00 2001 From: andsel Date: Thu, 29 Jul 2021 09:19:46 +0200 Subject: [PATCH 4/4] Improved 'executor_threads' description with integrations from #409 --- docs/index.asciidoc | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 15ec58db..98becc4e 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -231,7 +231,17 @@ Refer to <> for detailed info * Value type is <> * Default value is 1 executor thread per CPU core -The number of parallel executor threads to be used to process incoming beats requests. +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`