Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
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 Migrated to GCP Java client libraries (#21) Mar 18, 2019
gradle/wrapper Migrated to GCP Java client libraries (#21) Mar 18, 2019
lib/logstash/outputs Fix cyclic dependency in path_factory.rb Jun 18, 2019
spec Migrated to GCP Java client libraries (#21) Mar 18, 2019
.gitignore Migrated to GCP Java client libraries (#21) Mar 18, 2019
.travis.yml update matrix to include current targets [ci skip] Feb 13, 2019
CHANGELOG.md Bump up version to 4.0.1, update changelog Jun 18, 2019
CONTRIBUTORS Add configuration option to set `Content-Encoding` to `gzip` (#14) Jun 8, 2018
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 Migrated to GCP Java client libraries (#21) Mar 18, 2019
Rakefile add support for publish_gem rake task Jun 24, 2019
build.gradle Migrated to GCP Java client libraries (#21) Mar 18, 2019
gradle.properties Migrated to GCP Java client libraries (#21) Mar 18, 2019
gradlew Migrated to GCP Java client libraries (#21) Mar 18, 2019
gradlew.bat Migrated to GCP Java client libraries (#21) Mar 18, 2019
logstash-output-google_cloud_storage.gemspec Bump up version to 4.0.1, update changelog Jun 18, 2019

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
bundle exec rake vendor

Test

  • Update your dependencies
bundle install
bundle exec rake vendor
  • 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.