diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 7d7d0fbf..2086a8aa 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -1,6 +1,7 @@ :plugin: kafka :type: integration :no_codec: +:kafka_client: 2.4 /////////////////////////////////////////// START - GENERATED VARIABLES, DO NOT EDIT! @@ -21,11 +22,15 @@ include::{include_path}/plugin_header.asciidoc[] ==== Description -The Kafka Integration Plugin provides integrated plugins for working with the https://kafka.apache.org/[Kafka] distributed streaming platform. +The Kafka Integration Plugin provides integrated plugins for working with the +https://kafka.apache.org/[Kafka] distributed streaming platform. - {logstash-ref}/plugins-inputs-kafka.html[Kafka Input Plugin] - {logstash-ref}/plugins-outputs-kafka.html[Kafka Output Plugin] -This plugin uses Kafka Client 2.4. For broker compatibility, see the official https://cwiki.apache.org/confluence/display/KAFKA/Compatibility+Matrix[Kafka compatibility reference]. If the linked compatibility wiki is not up-to-date, please contact Kafka support/community to confirm compatibility. +This plugin uses Kafka Client {kafka_client}. For broker compatibility, see the official +https://cwiki.apache.org/confluence/display/KAFKA/Compatibility+Matrix[Kafka +compatibility reference]. If the linked compatibility wiki is not up-to-date, +please contact Kafka support/community to confirm compatibility. :no_codec!: diff --git a/docs/input-kafka.asciidoc b/docs/input-kafka.asciidoc index 2e47b933..1f256213 100644 --- a/docs/input-kafka.asciidoc +++ b/docs/input-kafka.asciidoc @@ -1,6 +1,8 @@ :plugin: kafka :type: input :default_codec: plain +:kafka_client: 2.4 +:kafka_client_doc: 24 /////////////////////////////////////////// START - GENERATED VARIABLES, DO NOT EDIT! @@ -23,9 +25,14 @@ include::{include_path}/plugin_header.asciidoc[] This input will read events from a Kafka topic. -This plugin uses Kafka Client 2.4. For broker compatibility, see the official https://cwiki.apache.org/confluence/display/KAFKA/Compatibility+Matrix[Kafka compatibility reference]. If the linked compatibility wiki is not up-to-date, please contact Kafka support/community to confirm compatibility. +This plugin uses Kafka Client {kafka_client}. For broker compatibility, see the +official +https://cwiki.apache.org/confluence/display/KAFKA/Compatibility+Matrix[Kafka +compatibility reference]. If the linked compatibility wiki is not up-to-date, +please contact Kafka support/community to confirm compatibility. -If you require features not yet available in this plugin (including client version upgrades), please file an issue with details about what you need. +If you require features not yet available in this plugin (including client +version upgrades), please file an issue with details about what you need. This input supports connecting to Kafka over: @@ -46,9 +53,9 @@ the same `group_id`. Ideally you should have as many threads as the number of partitions for a perfect balance -- more threads than partitions means that some threads will be idle -For more information see https://kafka.apache.org/24/documentation.html#theconsumer +For more information see https://kafka.apache.org/{kafka_client_doc}/documentation.html#theconsumer -Kafka consumer configuration: https://kafka.apache.org/24/documentation.html#consumerconfigs +Kafka consumer configuration: https://kafka.apache.org/{kafka_client_doc}/documentation.html#consumerconfigs ==== Metadata fields @@ -59,7 +66,11 @@ The following metadata from Kafka broker are added under the `[@metadata]` field * `[@metadata][kafka][partition]`: Partition info for this message. * `[@metadata][kafka][offset]`: Original record offset for this message. * `[@metadata][kafka][key]`: Record key, if any. -* `[@metadata][kafka][timestamp]`: Timestamp in the Record. Depending on your broker configuration, this can be either when the record was created (default) or when it was received by the broker. See more about property log.message.timestamp.type at https://kafka.apache.org/10/documentation.html#brokerconfigs +* `[@metadata][kafka][timestamp]`: Timestamp in the Record. +Depending on your broker configuration, this can be +either when the record was created (default) or when it was received by the +broker. See more about property log.message.timestamp.type at +https://kafka.apache.org/{kafka_client_doc}/documentation.html#brokerconfigs Metadata is only added to the event if the `decorate_events` option is set to true (it defaults to false). @@ -73,7 +84,7 @@ This plugin supports these configuration options plus the <