Skip to content

Latest commit

 

History

History
77 lines (55 loc) · 1.81 KB

DEVELOPER_GUIDE.md

File metadata and controls

77 lines (55 loc) · 1.81 KB

Developer Guide

So you want to contribute code to logstash-input-opensearch? Excellent! We're glad you're here. Here's what you need to do.

1. Plugin Developement and Testing

Code

Example:

    git clone https://github.com/[your username]/logstash-input-opensearch.git.
  • 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-input-opensearch", :path => "/your/local/logstash-input-opensearch"
  • 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 'input {opensearch {}}'

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