Repository files navigation

This is a plugin forLogstash.

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 onecentral location.

• For formatting code or config example, you can use the asciidoc[source,ruby] directive
• For more asciidoc formatting tips, see the excellent reference herehttps://github.com/elastic/docs#asciidoc-guide

Need help? Try #logstash on freenode IRC or thehttps://discuss.elastic.co/c/logstash discussion forum.

• To get started, you'll need JRuby with the Bundler gem installed.

• Create a new plugin or clone and existing from the GitHublogstash-plugins organization. We also provideexample plugins.

• Install dependencies

bundle install

• Update your dependencies

bundle install

• Run tests

bundleexec rspec

• Edit LogstashGemfile and add the local plugin path, for example:

gem"logstash-filter-awesome",:path=>"/your/local/logstash-filter-awesome"

• Install plugin

# Logstash 2.3 and higherbin/logstash-plugin install --no-verify# Prior to Logstash 2.3bin/plugin install --no-verify

• 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.

You can use the same2.1 method to run your plugin in an installed Logstash by editing itsGemfile and pointing the:path to your local plugin development directory or you can build the gem and install it using:

• Build your plugin gem

gem build logstash-filter-awesome.gemspec

• Install the plugin from the Logstash home

# Logstash 2.3 and higherbin/logstash-plugin install --no-verify# Prior to Logstash 2.3bin/plugin install --no-verify

• Start Logstash and proceed to test the plugin

All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.

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 theCONTRIBUTING file.