diff --git a/docs/static/breaking-changes.asciidoc b/docs/static/breaking-changes.asciidoc index 5d3629f30..2c751e9f7 100644 --- a/docs/static/breaking-changes.asciidoc +++ b/docs/static/breaking-changes.asciidoc @@ -144,6 +144,14 @@ bin/logstash -f my.conf -w 8 <2> NOTE: None of the short form options have changed! +[float] +==== RSpec testing script + +The `rspec` script is no longer bundled with Logstash release artifacts. This script has been used previously to +run unit tests for validating users Logstash configuration. While this was useful to some users, this mechanism assumed that Logstash users +were familiar with the RSpec framework, which is a Ruby testing framework. + + [float] === Breaking Changes in Plugins @@ -209,10 +217,18 @@ bin/logstash-plugin install --version 4.0.1 logstash-output-kafka The version numbers were found by checking the compatibility matrix for the individual plugins. -Specifically, for the Kafka input plugin, configs have changed a lot. Configuration `topic_id` -is replaced by `topics`. `zk_connect` is replaced by `bootstrap_servers` which are Kafka brokers. `consumer_id` is -replaced by `client_id`. Also, offsets are now stored in Kafka topics instead of Zookeeper. See <> -for more information. +[float] +==== Kafka Input Configuration Changes + +As described in the section <>, Kafka plugin has been updated to bring in new consumer features. +In addition, to the plugin being incompatible with 0.8.x version of Kafka broker, _most_ of the config options have +been changed to match the new consumer configurations from the Kafka Java consumer. Here's a list of important config options that have changed: + +* `topic_id` is renamed to `topics` and accepts an array of topics to consume from. +* `zk_connect` has been dropped; you should use `bootstrap_servers`. There is no need for the consumer to go through ZooKeeper +* `consumer_id` is renamed to `client_id` + +We recommend users of the Kafka plugin to check the documentation for the latest <>. [float] ==== File Input