This is a plugin for Logstash.
Provide the build script for the project to generate the gem file, just run
./build.sh
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.
- 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/elastic/docs#asciidoc-guide
Need help? Contact the developer.
-
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- Update your dependencies
bundle install- Run tests
bundle exec rspec- Edit Logstash
Gemfileand add the local plugin path, for example:
gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"- Install plugin
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.
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
bin/plugin install /your/local/plugin/logstash-filter-awesome.gem- Start Logstash and proceed to test the plugin