Skip to content
Logstash input for consuming events from Azure Event Hubs
Branch: master
Clone or download
Latest commit 7859b02 May 29, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ci
docs Add guidelines for setting number of threads Aug 9, 2018
gradle/wrapper Re-implement with event processor host API. Jun 26, 2018
lib Workaround to avoid errors that cause plugin to crash on Java 11 May 28, 2019
spec/inputs Re-implement with event processor host API. Jun 26, 2018
.gitignore Re-implement with event processor host API. Jun 26, 2018
.travis.yml Remove distribution specifier May 15, 2019
CHANGELOG.md Version bump and changelog entry May 28, 2019
CONTRIBUTORS Re-implement with event processor host API. Jun 26, 2018
Gemfile Re-implement with event processor host API. Jun 26, 2018
LICENSE Initial commit Apr 25, 2018
README.md Re-implement with event processor host API. Jun 26, 2018
Rakefile Re-implement with event processor host API. Jun 26, 2018
VERSION Version bump and changelog entry May 28, 2019
build.gradle Update Azure library dependencies May 15, 2019
gradle.properties Re-implement with event processor host API. Jun 26, 2018
gradlew Re-implement with event processor host API. Jun 26, 2018
gradlew.bat Re-implement with event processor host API. Jun 26, 2018
logstash-input-azure_event_hubs.gemspec Re-implement with event processor host API. Jun 26, 2018

README.md

Logstash Plugin

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

Need Help?

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

Developing

1. Plugin Development 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

./gradlew vendor
bundle install

Test

  • Update your dependencies
bundle install
  • Run tests
gem install rspec
bundle exec rspec --pattern spec/**/*_spec.rb

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
bin/logstash-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
bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
  • 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.

You can’t perform that action at this time.