Skip to content
Loads a DB query's result set in memory and uses it as lookup table for events.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ci Update build to gradle and allow for source based testing from multip… Mar 28, 2018
docs Fix text anchor format and bump versions Oct 29, 2018
gradle/wrapper Update build to gradle and allow for source based testing from multip… Mar 28, 2018
lib Implement close rather than stop for plugin shutdown Jun 26, 2018
spec Implement close rather than stop for plugin shutdown Jun 26, 2018
.gitignore Update build to gradle and allow for source based testing from multip… Mar 28, 2018
.travis.yml
CHANGELOG.md Fix text anchor format and bump versions Oct 29, 2018
CONTRIBUTORS
Gemfile Update build to gradle and allow for source based testing from multip… Mar 28, 2018
LICENSE initial doc page (#5) Jan 11, 2018
NOTICE.txt initial doc page (#5) Jan 11, 2018
README.md
Rakefile add devutils rake tasks, change gemspec license text (#23) Apr 20, 2018
build.gradle
gradle.properties
gradlew Update build to gradle and allow for source based testing from multip… Mar 28, 2018
gradlew.bat
logstash-filter-jdbc_static.gemspec

README.md

logstash-filter-jdbc_static

Lookup plugin which overwrites a loader query's result set into a local in-memory db and then lookup queries add records to a target field using properties from the event.

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.

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

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.

You can’t perform that action at this time.