updated docs for main (#1598)

elastic · Jan 25, 2024 · 0e7030a · 0e7030a
1 parent 843ca4a
commit 0e7030a
Show file tree

Hide file tree

Showing 10 changed files with 76 additions and 32 deletions.
diff --git a/docs/plugins/filters/http.asciidoc b/docs/plugins/filters/http.asciidoc
@@ -5,9 +5,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v1.5.0
-:release_date: 2023-09-01
-:changelog_url: https://github.com/logstash-plugins/logstash-filter-http/blob/v1.5.0/CHANGELOG.md
+:version: v1.5.1
+:release_date: 2024-01-11
+:changelog_url: https://github.com/logstash-plugins/logstash-filter-http/blob/v1.5.1/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!

diff --git a/docs/plugins/filters/syslog_pri.asciidoc b/docs/plugins/filters/syslog_pri.asciidoc
@@ -5,9 +5,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v3.2.0
-:release_date: 2023-01-11
-:changelog_url: https://github.com/logstash-plugins/logstash-filter-syslog_pri/blob/v3.2.0/CHANGELOG.md
+:version: v3.2.1
+:release_date: 2024-01-17
+:changelog_url: https://github.com/logstash-plugins/logstash-filter-syslog_pri/blob/v3.2.1/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!
@@ -96,10 +96,9 @@ Name of field which passes in the extracted PRI part of the syslog message
   * Value type is <<boolean,boolean>>
   * Default value is `true`
 
-set the status to experimental/beta/stable
 Add human-readable names after parsing severity and facility from PRI
 
 
 
 [id="plugins-{type}s-{plugin}-common-options"]
-include::{include_path}/{type}.asciidoc[]
+include::{include_path}/{type}.asciidoc[]
diff --git a/docs/plugins/inputs/beats.asciidoc b/docs/plugins/inputs/beats.asciidoc
@@ -8,9 +8,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v6.7.2
-:release_date: 2023-11-20
-:changelog_url: https://github.com/logstash-plugins/logstash-input-beats/blob/v6.7.2/CHANGELOG.md
+:version: v6.8.0
+:release_date: 2024-01-23
+:changelog_url: https://github.com/logstash-plugins/logstash-input-beats/blob/v6.8.0/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!
@@ -218,6 +218,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-client_inactivity_timeout>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-ecs_compatibility>> | <<string,string>>|No
 | <<plugins-{type}s-{plugin}-enrich>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-event_loop_threads>> |<<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>>|__Deprecated__
@@ -340,6 +341,20 @@ input {
 }
 --------------------------------------------------
 
+[id="plugins-{type}s-{plugin}-event_loop_threads"]
+===== `event_loop_threads`
+
+* Value type is <<number,number>>
+* Defaults to 0.
+
+When setting `0`, the actual default is `available_processors * 2`
+
+This is an expert-level setting, and generally should not need to be set
+{plugin-uc} plugin is implemented based on a non-blocking mechanism, requiring a number of event loop and executor threads.
+The event loop threads are responsible to communicate with clients (accept incoming connections, enqueue/dequeue tasks and respond) and executor threads handle tasks.
+This configuration intends to limit or increase the number of threads to be created for the event loop.
+See <<plugins-{type}s-{plugin}-executor_threads>> configuration if you need to set executor threads count.
+
 [id="plugins-{type}s-{plugin}-executor_threads"]
 ===== `executor_threads`
 

diff --git a/docs/plugins/inputs/elastic_agent.asciidoc b/docs/plugins/inputs/elastic_agent.asciidoc
@@ -8,9 +8,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v6.7.2
-:release_date: 2023-11-20
-:changelog_url: https://github.com/logstash-plugins/logstash-input-beats/blob/v6.7.2/CHANGELOG.md
+:version: v6.8.0
+:release_date: 2024-01-23
+:changelog_url: https://github.com/logstash-plugins/logstash-input-beats/blob/v6.8.0/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!
@@ -218,6 +218,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-client_inactivity_timeout>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-ecs_compatibility>> | <<string,string>>|No
 | <<plugins-{type}s-{plugin}-enrich>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-event_loop_threads>> |<<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>>|__Deprecated__
@@ -340,6 +341,20 @@ input {
 }
 --------------------------------------------------
 
+[id="plugins-{type}s-{plugin}-event_loop_threads"]
+===== `event_loop_threads`
+
+* Value type is <<number,number>>
+* Defaults to 0.
+
+When setting `0`, the actual default is `available_processors * 2`
+
+This is an expert-level setting, and generally should not need to be set
+{plugin-uc} plugin is implemented based on a non-blocking mechanism, requiring a number of event loop and executor threads.
+The event loop threads are responsible to communicate with clients (accept incoming connections, enqueue/dequeue tasks and respond) and executor threads handle tasks.
+This configuration intends to limit or increase the number of threads to be created for the event loop.
+See <<plugins-{type}s-{plugin}-executor_threads>> configuration if you need to set executor threads count.
+
 [id="plugins-{type}s-{plugin}-executor_threads"]
 ===== `executor_threads`
 

diff --git a/docs/plugins/inputs/elasticsearch.asciidoc b/docs/plugins/inputs/elasticsearch.asciidoc
@@ -6,9 +6,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v4.19.1
-:release_date: 2023-12-04
-:changelog_url: https://github.com/logstash-plugins/logstash-input-elasticsearch/blob/v4.19.1/CHANGELOG.md
+:version: v4.20.0
+:release_date: 2024-01-24
+:changelog_url: https://github.com/logstash-plugins/logstash-input-elasticsearch/blob/v4.20.0/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!
@@ -116,6 +116,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-password>> |<<password,password>>|No
 | <<plugins-{type}s-{plugin}-proxy>> |<<uri,uri>>|No
 | <<plugins-{type}s-{plugin}-query>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-response_type>> |<<string,string>>, one of `["hits","aggregations"]`|No
 | <<plugins-{type}s-{plugin}-request_timeout_seconds>> | <<number,number>>|No
 | <<plugins-{type}s-{plugin}-schedule>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-scroll>> |<<string,string>>|No
@@ -338,6 +339,20 @@ documentation] for more information.
 When <<plugins-{type}s-{plugin}-search_api>> resolves to `search_after` and the query does not specify `sort`,
 the default sort `'{ "sort": { "_shard_doc": "asc" } }'` will be added to the query. Please refer to the {ref}/paginate-search-results.html#search-after[Elasticsearch search_after] parameter to know more.
 
+[id="plugins-{type}s-{plugin}-response_type"]
+===== `response_type`
+
+  * Value can be any of: `hits`, `aggregations`
+  * Default value is `hits`
+
+Which part of the result to transform into Logstash events when processing the
+response from the query.
+The default `hits` will generate one event per returned document (i.e. "hit").
+When set to `aggregations`, a single Logstash event will be generated with the
+contents of the `aggregations` object of the query's response. In this case the
+`hits` object will be ignored. The parameter `size` will be always be set to
+0 regardless of the default or user-defined value set in this plugin.
+
 [id="plugins-{type}s-{plugin}-request_timeout_seconds"]
 ===== `request_timeout_seconds`
 

diff --git a/docs/plugins/inputs/logstash.asciidoc b/docs/plugins/inputs/logstash.asciidoc
@@ -7,9 +7,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v1.0.1
-:release_date: 2023-11-16
-:changelog_url: https://github.com/logstash-plugins/logstash-integration-logstash/blob/v1.0.1/CHANGELOG.md
+:version: v1.0.2
+:release_date: 2024-01-23
+:changelog_url: https://github.com/logstash-plugins/logstash-integration-logstash/blob/v1.0.2/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!

diff --git a/docs/plugins/integrations/logstash.asciidoc b/docs/plugins/integrations/logstash.asciidoc
@@ -6,9 +6,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v1.0.1
-:release_date: 2023-11-16
-:changelog_url: https://github.com/logstash-plugins/logstash-integration-logstash/blob/v1.0.1/CHANGELOG.md
+:version: v1.0.2
+:release_date: 2024-01-23
+:changelog_url: https://github.com/logstash-plugins/logstash-integration-logstash/blob/v1.0.2/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!

diff --git a/docs/plugins/outputs/google_bigquery.asciidoc b/docs/plugins/outputs/google_bigquery.asciidoc
@@ -6,9 +6,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v4.4.0
-:release_date: 2023-08-22
-:changelog_url: https://github.com/logstash-plugins/logstash-output-google_bigquery/blob/v4.4.0/CHANGELOG.md
+:version: v4.5.0
+:release_date: 2024-01-24
+:changelog_url: https://github.com/logstash-plugins/logstash-output-google_bigquery/blob/v4.5.0/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!

diff --git a/docs/plugins/outputs/logstash.asciidoc b/docs/plugins/outputs/logstash.asciidoc
@@ -7,9 +7,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v1.0.1
-:release_date: 2023-11-16
-:changelog_url: https://github.com/logstash-plugins/logstash-integration-logstash/blob/v1.0.1/CHANGELOG.md
+:version: v1.0.2
+:release_date: 2024-01-23
+:changelog_url: https://github.com/logstash-plugins/logstash-integration-logstash/blob/v1.0.2/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!

diff --git a/docs/plugins/outputs/websocket.asciidoc b/docs/plugins/outputs/websocket.asciidoc
@@ -6,9 +6,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v3.0.5
-:release_date: 2018-04-06
-:changelog_url: https://github.com/logstash-plugins/logstash-output-websocket/blob/v3.0.5/CHANGELOG.md
+:version: v3.1.0
+:release_date: 2024-01-11
+:changelog_url: https://github.com/logstash-plugins/logstash-output-websocket/blob/v3.1.0/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!