From f0c810490a0f8c0950b4319a14434956204973e7 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 12 Apr 2024 13:22:50 -0400 Subject: [PATCH] updated docs for main (#1627) --- docs/plugins/filters/jdbc_static.asciidoc | 6 ++--- docs/plugins/filters/jdbc_streaming.asciidoc | 6 ++--- docs/plugins/inputs/jdbc.asciidoc | 6 ++--- docs/plugins/inputs/kafka.asciidoc | 6 ++--- docs/plugins/integrations/jdbc.asciidoc | 6 ++--- docs/plugins/integrations/kafka.asciidoc | 6 ++--- docs/plugins/outputs/elasticsearch.asciidoc | 13 ++++++----- docs/plugins/outputs/kafka.asciidoc | 23 +++++++++++++++++--- 8 files changed, 45 insertions(+), 27 deletions(-) diff --git a/docs/plugins/filters/jdbc_static.asciidoc b/docs/plugins/filters/jdbc_static.asciidoc index b5b4859b..b10bb677 100644 --- a/docs/plugins/filters/jdbc_static.asciidoc +++ b/docs/plugins/filters/jdbc_static.asciidoc @@ -6,9 +6,9 @@ /////////////////////////////////////////// START - GENERATED VARIABLES, DO NOT EDIT! /////////////////////////////////////////// -:version: v5.4.8 -:release_date: 2024-02-13 -:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.8/CHANGELOG.md +:version: v5.4.9 +:release_date: 2024-03-21 +:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.9/CHANGELOG.md :include_path: ../../../../logstash/docs/include /////////////////////////////////////////// END - GENERATED VARIABLES, DO NOT EDIT! diff --git a/docs/plugins/filters/jdbc_streaming.asciidoc b/docs/plugins/filters/jdbc_streaming.asciidoc index 068a661e..33873943 100644 --- a/docs/plugins/filters/jdbc_streaming.asciidoc +++ b/docs/plugins/filters/jdbc_streaming.asciidoc @@ -6,9 +6,9 @@ /////////////////////////////////////////// START - GENERATED VARIABLES, DO NOT EDIT! /////////////////////////////////////////// -:version: v5.4.8 -:release_date: 2024-02-13 -:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.8/CHANGELOG.md +:version: v5.4.9 +:release_date: 2024-03-21 +:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.9/CHANGELOG.md :include_path: ../../../../logstash/docs/include /////////////////////////////////////////// END - GENERATED VARIABLES, DO NOT EDIT! diff --git a/docs/plugins/inputs/jdbc.asciidoc b/docs/plugins/inputs/jdbc.asciidoc index 2a7c2480..58616b03 100644 --- a/docs/plugins/inputs/jdbc.asciidoc +++ b/docs/plugins/inputs/jdbc.asciidoc @@ -7,9 +7,9 @@ /////////////////////////////////////////// START - GENERATED VARIABLES, DO NOT EDIT! /////////////////////////////////////////// -:version: v5.4.8 -:release_date: 2024-02-13 -:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.8/CHANGELOG.md +:version: v5.4.9 +:release_date: 2024-03-21 +:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.9/CHANGELOG.md :include_path: ../../../../logstash/docs/include /////////////////////////////////////////// END - GENERATED VARIABLES, DO NOT EDIT! diff --git a/docs/plugins/inputs/kafka.asciidoc b/docs/plugins/inputs/kafka.asciidoc index 2a97498d..937273dc 100644 --- a/docs/plugins/inputs/kafka.asciidoc +++ b/docs/plugins/inputs/kafka.asciidoc @@ -9,9 +9,9 @@ /////////////////////////////////////////// START - GENERATED VARIABLES, DO NOT EDIT! /////////////////////////////////////////// -:version: v11.3.4 -:release_date: 2024-02-06 -:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.3.4/CHANGELOG.md +:version: v11.4.1 +:release_date: 2024-04-10 +:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.4.1/CHANGELOG.md :include_path: ../../../../logstash/docs/include /////////////////////////////////////////// END - GENERATED VARIABLES, DO NOT EDIT! diff --git a/docs/plugins/integrations/jdbc.asciidoc b/docs/plugins/integrations/jdbc.asciidoc index af2670ab..61cbe0fa 100644 --- a/docs/plugins/integrations/jdbc.asciidoc +++ b/docs/plugins/integrations/jdbc.asciidoc @@ -6,9 +6,9 @@ /////////////////////////////////////////// START - GENERATED VARIABLES, DO NOT EDIT! /////////////////////////////////////////// -:version: v5.4.8 -:release_date: 2024-02-13 -:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.8/CHANGELOG.md +:version: v5.4.9 +:release_date: 2024-03-21 +:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.9/CHANGELOG.md :include_path: ../../../../logstash/docs/include /////////////////////////////////////////// END - GENERATED VARIABLES, DO NOT EDIT! diff --git a/docs/plugins/integrations/kafka.asciidoc b/docs/plugins/integrations/kafka.asciidoc index 420ebf40..fb5030d3 100644 --- a/docs/plugins/integrations/kafka.asciidoc +++ b/docs/plugins/integrations/kafka.asciidoc @@ -7,9 +7,9 @@ /////////////////////////////////////////// START - GENERATED VARIABLES, DO NOT EDIT! /////////////////////////////////////////// -:version: v11.3.4 -:release_date: 2024-02-06 -:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.3.4/CHANGELOG.md +:version: v11.4.1 +:release_date: 2024-04-10 +:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.4.1/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 index 0e909534..6cbd071e 100644 --- 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.3 -:release_date: 2024-03-19 -:changelog_url: https://github.com/logstash-plugins/logstash-output-elasticsearch/blob/v11.22.3/CHANGELOG.md +:version: v11.22.5 +:release_date: 2024-04-02 +:changelog_url: https://github.com/logstash-plugins/logstash-output-elasticsearch/blob/v11.22.5/CHANGELOG.md :include_path: ../../../../logstash/docs/include /////////////////////////////////////////// END - GENERATED VARIABLES, DO NOT EDIT! @@ -100,6 +100,8 @@ as logs, metrics, and events) into {es} and {es-serverless}: * <> * <> +IMPORTANT: <> must be enabled (set to `v1` or `v8`) for data streams to work properly. + [id="plugins-{type}s-{plugin}-ds-examples"] ===== Data stream configuration examples @@ -117,7 +119,7 @@ output { This example shows the minimal settings for processing data streams. Events with `data_stream.*`` fields are routed to the appropriate data streams. If the -fields are missing, routing defaults to `logs-generic-logstash`. +fields are missing, routing defaults to `logs-generic-default`. **Example: Customize data stream name** @@ -135,8 +137,6 @@ output { ----- - - ==== Writing to different indices: best practices NOTE: You cannot use dynamic variable substitution when `ilm_enabled` is `true` @@ -512,6 +512,7 @@ The other `data_stream_*` settings will be used only if this setting is enabled. Logstash handles the output as a data stream when the supplied configuration is compatible with data streams and this value is set to `auto`. +Note that <> must be enabled (set to `v1` or `v8`) for data streams to work properly. [id="plugins-{type}s-{plugin}-data_stream_auto_routing"] ===== `data_stream_auto_routing` diff --git a/docs/plugins/outputs/kafka.asciidoc b/docs/plugins/outputs/kafka.asciidoc index 873f35c9..27e0f67a 100644 --- a/docs/plugins/outputs/kafka.asciidoc +++ b/docs/plugins/outputs/kafka.asciidoc @@ -9,9 +9,9 @@ /////////////////////////////////////////// START - GENERATED VARIABLES, DO NOT EDIT! /////////////////////////////////////////// -:version: v11.3.4 -:release_date: 2024-02-06 -:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.3.4/CHANGELOG.md +:version: v11.4.1 +:release_date: 2024-04-10 +:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.4.1/CHANGELOG.md :include_path: ../../../../logstash/docs/include /////////////////////////////////////////// END - GENERATED VARIABLES, DO NOT EDIT! @@ -92,6 +92,7 @@ See the https://kafka.apache.org/{kafka_client_doc}/documentation for more detai | <> |<>|No | <> |<>|No | <> |<>|No +| <> |<>|No | <> |<>|No | <> |<>|No | <> |<>|No @@ -276,6 +277,22 @@ to allow other records to be sent so that the sends can be batched together. The maximum size of a request +[id="plugins-{type}s-{plugin}-message_headers"] +===== `message_headers` + + * Value type is <> + ** Keys are header names, and must be <> + ** Values are header values, and must be <> + ** Values support interpolation from event field values + * There is no default value for this setting. + +A map of key value pairs, each corresponding to a header name and its value respectively. +Example: +[source,ruby] +---------------------------------- + message_headers => { "event_timestamp" => "%{@timestamp}" } +---------------------------------- + [id="plugins-{type}s-{plugin}-message_key"] ===== `message_key`