No description, website, or topics provided.
Ruby Java Shell
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 allow changing the default target field for host and headers data May 10, 2018
gradle/wrapper replace Puma with Netty Apr 26, 2018
lib allow changing the default target field for host and headers data May 10, 2018
spec/inputs allow changing the default target field for host and headers data May 10, 2018
src/main/java/org/logstash/plugins/inputs/http move most message handling code to java (#85) May 10, 2018
.gitignore gitignore idea Sep 21, 2017
.travis.yml Travis - add 6.0 build, remove default JRuby 1.7 build, bump RVM vers… Oct 27, 2017
CHANGELOG.md add changelog for 3.2.0 May 10, 2018
DEVELOPER.md basic funcionality + ssl May 4, 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 Fix a typo in the command Apr 20, 2016
Rakefile add missing rake devutils tasks May 10, 2018
VERSION allow changing the default target field for host and headers data May 10, 2018
build.gradle replace Puma with Netty Apr 26, 2018
gradlew replace Puma with Netty Apr 26, 2018
gradlew.bat replace Puma with Netty Apr 26, 2018
logstash-input-http.gemspec replace Puma with Netty Apr 26, 2018
settings.gradle replace Puma with Netty Apr 26, 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 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 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.