This is a plugin for 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.
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 reference.
- 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
Need help? Try #logstash on freenode irc or the logstash-users@googlegroups.com mailing list.
-
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 organization.
-
Install dependencies
bundle installbundle exec rspec
bundle exec rspec --order randThe Logstash code required to run the tests/specs is specified in the Gemfile by the line similar to:
gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"To test agains another version or a local Logstash, edit the Gemfile to specify an alternative location, for example:
gem "logstash", :github => "elasticsearch/logstash", :ref => "master"gem "logstash", :path => "/your/local/logstash"Then update your dependencies and run your tests:
bundle install
bundle exec rspec- Edit Logstash
tools/Gemfileand add the local plugin path, for example:
gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"- Update Logstash dependencies
rake vendor:gems- Run Logstash with your plugin
bin/logstash -e 'filter {awesome {}}' At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
TBD