README.md in logstash-output-kafka-1.0.0 vs README.md in logstash-output-kafka-2.0.0.beta.1

- old
+ new

@@ -1,17 +1,17 @@ # Logstash Plugin -This is a plugin for [Logstash](https://github.com/elasticsearch/logstash). +This is a plugin for [Logstash](https://github.com/elastic/logstash). It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way. ## Documentation -Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/). +Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/). - For formatting code or config example, you can use the asciidoc `[source,ruby]` directive -- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide +- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide ## Need Help? Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum. @@ -23,10 +23,11 @@ - To get started, you'll need JRuby with the Bundler gem installed. - Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example). - Install dependencies + ```sh bundle install ``` #### Test @@ -35,45 +36,56 @@ ```sh bundle install ``` -- Run tests +- Run unit tests ```sh bundle exec rspec ``` +- Run integration tests + +you'll need to have docker available within your test environment before +running the integration tests. The tests depend on a specific Kafka image +found in Docker Hub called `spotify/kafka`. You will need internet connectivity +to pull in this image if it does not already exist locally. + +```sh +bundle exec rspec --tag integration +``` + ### 2. Running your unpublished Plugin in Logstash #### 2.1 Run in a local Logstash clone - Edit Logstash `Gemfile` and add the local plugin path, for example: ```ruby -gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome" +gem "logstash-output-kafka", :path => "/your/local/logstash-output-kafka" ``` - Install plugin ```sh bin/plugin install --no-verify ``` - Run Logstash with your plugin ```sh -bin/logstash -e 'filter {awesome {}}' +bin/logstash -e 'output { kafka { topic_id => "kafka_topic" }}' ``` At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash. #### 2.2 Run in an installed Logstash You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using: - Build your plugin gem ```sh -gem build logstash-filter-awesome.gemspec +gem build logstash-output-kafka.gemspec ``` - Install the plugin from the Logstash home ```sh -bin/plugin install /your/local/plugin/logstash-filter-awesome.gem +bin/plugin install /your/local/plugin/logstash-output-kafka.gem ``` - Start Logstash and proceed to test the plugin ## Contributing @@ -81,6 +93,6 @@ Programming is not a required skill. Whatever you've seen about open source and maintainers or community members saying "send patches or die" - you will not see that here. It is more important to the community that you are able to contribute. -For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file. \ No newline at end of file +For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.