Skip to content

Commit

Permalink
Version Information for kafka-output unclear (elastic#9032)
Browse files Browse the repository at this point in the history
In the paragraph "compatibility" it is mentioned that versions 0.11 to 2.00 are supported.
In the description of the parameter "version" it is mentioned that all versions from 0.8.2.0 to 2.0.0 are valid.
It would be useful to mention the supported versions. This would avoid misinterpretations.
I assume that the information in the paragraph "compatibility" is correct.
  • Loading branch information
gigallucci authored and jsoriano committed Nov 19, 2018
1 parent fcff182 commit 0fd7203
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions libbeat/docs/outputconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -789,6 +789,7 @@ output.kafka:

NOTE: Events bigger than <<kafka-max_message_bytes,`max_message_bytes`>> will be dropped. To avoid this problem, make sure {beatname_uc} does not generate events bigger than <<kafka-max_message_bytes,`max_message_bytes`>>.

[[kafka-compatibility]]
==== Compatibility

This output works with all Kafka versions in between 0.11 and 2.0.0. Older versions
Expand All @@ -812,11 +813,13 @@ The cluster metadata contain the actual Kafka brokers events are published to.

===== `version`

Kafka version ${beatname_lc} is assumed to run against. Defaults to 1.0.0.
Kafka version {beatname_lc} is assumed to run against. Defaults to 1.0.0.

Event timestamps will be added, if version 0.10.0.0+ is enabled.

Valid values are all kafka releases in between `0.8.2.0` and `1.1.1`.
Valid values are all kafka releases in between `0.8.2.0` and `2.0.0`.

See <<kafka-compatibility>> for information on supported versions.

===== `username`

Expand Down

0 comments on commit 0fd7203

Please sign in to comment.