Example filter plugin. This should help bootstrap your effort to write your own filter plugin!
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github License 2016 and new plugin installing command Apr 20, 2016
ci Adjusting the build scripts to correctly load the logstash source and… May 31, 2017
docs
lib/logstash/filters Updated to use the get set Event API (#6) Jun 2, 2016
spec Updated to use the get set Event API (#6) Jun 2, 2016
.gitignore Initial commit Jan 12, 2015
.travis.yml Travis - add 6.0 build, remove default JRuby 1.7 build, bump RVM vers… Oct 27, 2017
CHANGELOG.md Update example plugin to include doc example Feb 14, 2018
CONTRIBUTORS
DEVELOPER.md New Readme Jan 20, 2015
Gemfile Adjusting the build scripts to correctly load the logstash source and… May 31, 2017
LICENSE [skip ci] update license to 2018 Jan 8, 2018
NOTICE.TXT Adding NOTICE.txt Jun 19, 2015
README.md Update example plugin to include doc example Feb 14, 2018
Rakefile
logstash-filter-example.gemspec Update example plugin to include doc example Feb 14, 2018

README.md

Logstash Plugin

Travis Build Status

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.

Documentation

Logstash provides infrastructure to automatically build documentation for this plugin. We provide a template file, index.asciidoc, where you can add documentation. The contents of this file will be converted into html and then placed with other plugin documentation in a central location.

Need Help?

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

Developing

1. Plugin Developement and Testing

Code

  • 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. We also provide example plugins.

  • Install dependencies

bundle install

Test

  • Update your dependencies
bundle install
  • Run tests
bundle exec rspec

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:
gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
  • Install plugin
# Logstash 2.3 and higher
bin/logstash-plugin install --no-verify

# Prior to Logstash 2.3
bin/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.

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
gem build logstash-filter-awesome.gemspec
  • Install the plugin from the Logstash home
# Logstash 2.3 and higher
bin/logstash-plugin install --no-verify

# Prior to Logstash 2.3
bin/plugin install --no-verify
  • Start Logstash and proceed to test the plugin

Contributing

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 the CONTRIBUTING file.