updated docs for main (#1683)

elastic · Jun 26, 2024 · b975c96 · b975c96
1 parent 25acaf4
commit b975c96
Show file tree

Hide file tree

Showing 13 changed files with 218 additions and 68 deletions.
diff --git a/docs/plugins/codecs/fluent.asciidoc b/docs/plugins/codecs/fluent.asciidoc
@@ -5,9 +5,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v3.4.2
-:release_date: 2023-04-04
-:changelog_url: https://github.com/logstash-plugins/logstash-codec-fluent/blob/v3.4.2/CHANGELOG.md
+:version: v3.4.3
+:release_date: 2024-06-25
+:changelog_url: https://github.com/logstash-plugins/logstash-codec-fluent/blob/v3.4.3/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!

diff --git a/docs/plugins/filters/elastic_integration.asciidoc b/docs/plugins/filters/elastic_integration.asciidoc
@@ -5,9 +5,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v0.1.9
-:release_date: 2024-05-14
-:changelog_url: https://github.com/elastic/logstash-filter-elastic_integration/blob/v0.1.9/CHANGELOG.md
+:version: v0.1.10
+:release_date: 2024-06-18
+:changelog_url: https://github.com/elastic/logstash-filter-elastic_integration/blob/v0.1.10/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!
@@ -337,13 +337,26 @@ By using managed databases you accept and agree to the https://www.maxmind.com/e
 
 You may instead configure this plugin with the path to a local directory containing database files.
 
-Databases are registered by file name, and most integrations rely on databases being present named:
+This plugin will discover all regular files with the `.mmdb` suffix in the provided directory, and make each available by its file name to the GeoIp processors in integration pipelines.
+It expects the files it finds to be in the MaxMind DB format with one of the following database types:
 
-* `GeoLite2-ASN.mmdb`
-* `GeoLite2-City.mmdb`
-* `GeoLite2-Country.mmdb`
+* `AnonymousIp`
+* `ASN`
+* `City`
+* `Country`
+* `ConnectionType`
+* `Domain`
+* `Enterprise`
+* `Isp`
+
+[NOTE]
+====
+Most integrations rely on databases being present named _exactly_:
 
-This plugin will discover any regular file with the `.mmdb` suffix in the provided directory, and expects the files it finds to be in the MaxMind DB format.
+* `GeoLite2-ASN.mmdb`,
+* `GeoLite2-City.mmdb`, or
+* `GeoLite2-Country.mmdb`
+====
 
 [id="plugins-{type}s-{plugin}-hosts"]
 ===== `hosts`

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.1
-:release_date: 2024-01-11
-:changelog_url: https://github.com/logstash-plugins/logstash-filter-http/blob/v1.5.1/CHANGELOG.md
+:version: v1.6.0
+:release_date: 2024-06-19
+:changelog_url: https://github.com/logstash-plugins/logstash-filter-http/blob/v1.6.0/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!
@@ -76,6 +76,7 @@ There are also multiple configuration options related to the HTTP connectivity:
 | <<plugins-{type}s-{plugin}-ssl_certificate>> |<<path,path>>|No
 | <<plugins-{type}s-{plugin}-ssl_certificate_authorities>> |list of <<path,path>>|No
 | <<plugins-{type}s-{plugin}-ssl_cipher_suites>> |list of <<string,string>>|No
+| <<plugins-{type}s-{plugin}-ssl_enabled>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-ssl_keystore_password>> |<<password,password>>|No
 | <<plugins-{type}s-{plugin}-ssl_keystore_path>> |<<path,path>>|No
 | <<plugins-{type}s-{plugin}-ssl_keystore_type>> |<<string,string>>|No
@@ -380,6 +381,15 @@ The .cer or .pem CA files to validate the server's certificate.
 The list of cipher suites to use, listed by priorities.
 Supported cipher suites vary depending on the Java and protocol versions.
 
+[id="plugins-{type}s-{plugin}-ssl_enabled"]
+===== `ssl_enabled`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Enable SSL/TLS secured communication. It must be `true` for other `ssl_` options
+to take effect.
+
 [id="plugins-{type}s-{plugin}-ssl_key"]
 ===== `ssl_key`
 

diff --git a/docs/plugins/inputs/azure_event_hubs.asciidoc b/docs/plugins/inputs/azure_event_hubs.asciidoc
@@ -6,9 +6,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v1.4.6
-:release_date: 2024-05-29
-:changelog_url: https://github.com/logstash-plugins/logstash-input-azure_event_hubs/blob/v1.4.6/CHANGELOG.md
+:version: v1.4.7
+:release_date: 2024-06-07
+:changelog_url: https://github.com/logstash-plugins/logstash-input-azure_event_hubs/blob/v1.4.7/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!
@@ -125,13 +125,24 @@ NOTE: Threads are currently available only as a global setting across all event
 input definition. However if your configuration includes multiple `azure_event_hubs` inputs, the threads setting applies
 independently to each.
 
-**Sample scenarios** 
+**Example: Single event hub**
 
-* Event Hubs = 4. Partitions on each Event Hub = 3.
-Minimum threads is 5 (4 Event Hubs plus one).
-* If you’re collecting activity logs from one event hub instance, 
-then only 2 threads (1 Event Hub plus one) are required.
+If you’re collecting activity logs from one event hub instance, 
+then only 2 threads are required.
 
+* Event hubs = 1
+* Minimum threads = 2 (1 Event Hub + 1)
+
+**Example: Multiple event hubs**
+
+If you are collecting activity logs from more than event hub instance, then at least 1 thread per event hub is required.
+
+* Event hubs = 4 
+* Minimum threads = 5 (4 Event Hubs + 1) 
+
+When you are using multiple partitions per event hub, you may want to assign more threads.
+A good base level is (1 + `number of event hubs * number of partitions`).
+That is, one thread for each partition across all event hubs. 
 
 [id="plugins-{type}s-{plugin}-eh_config_models"]
 ==== Configuration models

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.20.2
-:release_date: 2024-03-05
-:changelog_url: https://github.com/logstash-plugins/logstash-input-elasticsearch/blob/v4.20.2/CHANGELOG.md
+:version: v4.20.3
+:release_date: 2024-06-11
+:changelog_url: https://github.com/logstash-plugins/logstash-input-elasticsearch/blob/v4.20.3/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!
@@ -302,10 +302,10 @@ can be either IP, HOST, IP:port, or HOST:port. The port defaults to
   * Value type is <<string,string>>
   * Default value is `"logstash-*"`
 
-The index or alias to search. See {ref}/multi-index.html[Multi Indices
-documentation] in the Elasticsearch documentation for more information on how to
-reference multiple indices.
-
+The index or alias to search. 
+Check out {ref}/api-conventions.html#api-multi-index[Multi Indices
+documentation] in the Elasticsearch documentation for info on
+referencing multiple indices.
 
 [id="plugins-{type}s-{plugin}-password"]
 ===== `password` 

diff --git a/docs/plugins/inputs/http_poller.asciidoc b/docs/plugins/inputs/http_poller.asciidoc
@@ -6,9 +6,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v5.5.1
-:release_date: 2023-11-13
-:changelog_url: https://github.com/logstash-plugins/logstash-input-http_poller/blob/v5.5.1/CHANGELOG.md
+:version: v5.6.0
+:release_date: 2024-06-19
+:changelog_url: https://github.com/logstash-plugins/logstash-input-http_poller/blob/v5.6.0/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!
@@ -150,6 +150,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-ssl_certificate>> |<<path,path>>|No
 | <<plugins-{type}s-{plugin}-ssl_certificate_authorities>> |list of <<path,path>>|No
 | <<plugins-{type}s-{plugin}-ssl_cipher_suites>> |list of <<string,string>>|No
+| <<plugins-{type}s-{plugin}-ssl_enabled>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-ssl_keystore_password>> |<<password,password>>|No
 | <<plugins-{type}s-{plugin}-ssl_keystore_path>> |<<path,path>>|No
 | <<plugins-{type}s-{plugin}-ssl_keystore_type>> |<<string,string>>|No
@@ -456,6 +457,15 @@ The .cer or .pem CA files to validate the server's certificate.
 The list of cipher suites to use, listed by priorities.
 Supported cipher suites vary depending on the Java and protocol versions.
 
+[id="plugins-{type}s-{plugin}-ssl_enabled"]
+===== `ssl_enabled`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Enable SSL/TLS secured communication. It must be `true` for other `ssl_` options
+to take effect.
+
 [id="plugins-{type}s-{plugin}-ssl_key"]
 ===== `ssl_key`
 

diff --git a/docs/plugins/inputs/snmp.asciidoc b/docs/plugins/inputs/snmp.asciidoc
@@ -7,9 +7,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v4.0.2
-:release_date: 2024-05-20
-:changelog_url: https://github.com/logstash-plugins/logstash-integration-snmp/blob/v4.0.2/CHANGELOG.md
+:version: v4.0.3
+:release_date: 2024-06-11
+:changelog_url: https://github.com/logstash-plugins/logstash-integration-snmp/blob/v4.0.3/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!
@@ -51,8 +51,6 @@ easier package maintenance, and a smaller installation footprint.
 Before you install the new integration, be aware of link:{logstash-ref}/plugins-integrations-snmp.html#plugins-integrations-snmp-migration[behavioral and mapping differences] between current stand-alone plugins and the new versions included in `integration-snmp`. 
 **** 
 
-// ToDo: link:{logstash-ref}/plugins-input-snmp.html[Importing MIBs]
-
 
 [id="plugins-{type}s-{plugin}-ecs"]
 ==== Compatibility with the Elastic Common Schema (ECS)
@@ -75,10 +73,8 @@ Metadata fields follow a specific naming convention when <<plugins-{type}s-{plug
 
 This plugin already includes the IETF MIBs (management information bases), and you do not need to import them.
 If you need additional MIBs, you need to import them.  
-Check out "Importing MIBs" for instructions.
+Check out link:{logstash-ref}/plugins-integrations-snmp.html#plugins-integrations-snmp-import-mibs[Importing MIBs] for info.
 
-// link:{logstash-ref}/plugins-input-snmp.html[Importing MIBs]
-// ToDo: Add link to MIBs content after generated file exists.
 
 [id="plugins-{type}s-{plugin}-options"]
 ==== SNMP Input Configuration Options

diff --git a/docs/plugins/inputs/snmptrap.asciidoc b/docs/plugins/inputs/snmptrap.asciidoc
@@ -7,9 +7,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v4.0.2
-:release_date: 2024-05-20
-:changelog_url: https://github.com/logstash-plugins/logstash-integration-snmp/blob/v4.0.2/CHANGELOG.md
+:version: v4.0.3
+:release_date: 2024-06-11
+:changelog_url: https://github.com/logstash-plugins/logstash-integration-snmp/blob/v4.0.3/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!
@@ -91,10 +91,7 @@ which variable binding in the list caused the error
 
 This plugin already includes the IETF MIBs (management information bases), and you do not need to import them.
 If you need additional MIBs, you need to import them.  
-Check out "Importing MIBs" for instructions.
-
-// link:{logstash-ref}/plugins-input-snmp.html[Importing MIBs]
-// ToDo: Add link to MIBs content after generated file exists.
+Check out link:{logstash-ref}/plugins-integrations-snmp.html#plugins-integrations-snmp-import-mibs[Importing MIBs] for info.
 
 [id="plugins-{type}s-{plugin}-options"]
 ==== SNMP Trap Input Configuration Options

diff --git a/docs/plugins/integrations/snmp.asciidoc b/docs/plugins/integrations/snmp.asciidoc
@@ -6,9 +6,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v4.0.2
-:release_date: 2024-05-20
-:changelog_url: https://github.com/logstash-plugins/logstash-integration-snmp/blob/v4.0.2/CHANGELOG.md
+:version: v4.0.3
+:release_date: 2024-06-11
+:changelog_url: https://github.com/logstash-plugins/logstash-integration-snmp/blob/v4.0.3/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!

diff --git a/docs/plugins/outputs/elasticsearch.asciidoc b/docs/plugins/outputs/elasticsearch.asciidoc
@@ -6,9 +6,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v11.22.6
-:release_date: 2024-04-30
-:changelog_url: https://github.com/logstash-plugins/logstash-output-elasticsearch/blob/v11.22.6/CHANGELOG.md
+:version: v11.22.7
+:release_date: 2024-06-25
+:changelog_url: https://github.com/logstash-plugins/logstash-output-elasticsearch/blob/v11.22.7/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!
@@ -1102,7 +1102,15 @@ If no explicit protocol is specified plain HTTP will be used.
   * Value type is <<path,path>>
   * There is no default value for this setting.
 
-OpenSSL-style RSA private key that corresponds to the <<plugins-{type}s-{plugin}-ssl_certificate>>.
+SSL key to use.
+This key must be in the PKCS8 format and PEM encoded.
+You can use the https://www.openssl.org/docs/man1.1.1/man1/openssl-pkcs8.html[openssl pkcs8] command to complete the conversion.
+For example, the command to convert a PEM encoded PKCS1 private key to a PEM encoded, non-encrypted PKCS8 key is:
+
+[source,sh]
+-----
+openssl pkcs8 -inform PEM -in path/to/logstash.key -topk8 -nocrypt -outform PEM -out path/to/logstash.pkcs8.key
+-----
 
 NOTE: This setting can be used only if <<plugins-{type}s-{plugin}-ssl_certificate>> is set.
 

diff --git a/docs/plugins/outputs/http.asciidoc b/docs/plugins/outputs/http.asciidoc
@@ -6,9 +6,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v5.6.0
-:release_date: 2023-09-01
-:changelog_url: https://github.com/logstash-plugins/logstash-output-http/blob/v5.6.0/CHANGELOG.md
+:version: v5.7.0
+:release_date: 2024-06-19
+:changelog_url: https://github.com/logstash-plugins/logstash-output-http/blob/v5.7.0/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!
@@ -104,6 +104,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-ssl_certificate>> |<<path,path>>|No
 | <<plugins-{type}s-{plugin}-ssl_certificate_authorities>> |list of <<path,path>>|No
 | <<plugins-{type}s-{plugin}-ssl_cipher_suites>> |list of <<string,string>>|No
+| <<plugins-{type}s-{plugin}-ssl_enabled>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-ssl_keystore_password>> |<<password,password>>|No
 | <<plugins-{type}s-{plugin}-ssl_keystore_path>> |<<path,path>>|No
 | <<plugins-{type}s-{plugin}-ssl_keystore_type>> |<<string,string>>|No
@@ -421,6 +422,15 @@ The .cer or .pem CA files to validate the server's certificate.
 The list of cipher suites to use, listed by priorities.
 Supported cipher suites vary depending on the Java and protocol versions.
 
+[id="plugins-{type}s-{plugin}-ssl_enabled"]
+===== `ssl_enabled`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Enable SSL/TLS secured communication. It must be `true` for other `ssl_` options
+to take effect.
+
 [id="plugins-{type}s-{plugin}-ssl_key"]
 ===== `ssl_key`