Skip to content
Logstash Filter for ChainKit
Ruby
Branch: master
Clone or download
kumarappan Merge pull request #2 from prashant-pencilDATA/patch-2
Rename chainkit_initial_draft.conf to chainkit_initial.conf
Latest commit 9b942df Oct 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Add Multi-Register based on new API. Jul 30, 2019
lib/logstash/filters Update to newest Controller API. Sep 24, 2019
prebuilt Rename chainkit_initial_draft.conf to chainkit_initial.conf Oct 12, 2019
spec Add Multi-Register based on new API. Jul 30, 2019
.gitignore First Import based on UUID Plugin. Jun 14, 2019
CONTRIBUTORS Change to CK-*. Jul 9, 2019
Gemfile
LICENSE Change to CK-*. Jul 9, 2019
NOTICE Change to CK-*. Jul 9, 2019
README.md
Rakefile First Import based on UUID Plugin. Jun 14, 2019
logstash-filter-ck.gemspec Change to CK-*. Jul 9, 2019

README.md

Logstash CK Filter Plugin

This is a ChainKit filter plugin for Logstash.

It is fully free and fully open source. The license is MIT.

Developing

1. Plugin Developement and Testing

Code

  • To get started, you'll need JRuby with the Bundler gem installed.

  • Clone this code and logstash code

  • Install dependencies

bundle install

Test

  • Install your dependencies
bundle install
  • Run tests
export CKUSER=user
export CKPASS=changeMe
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-ck", :path => "/your-workspace/logstash-filter-ck"
  • 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 this plugin
bin/logstash -e \
'filter { ck { username => "user", password => "changeMe" } ckverify { username => "user", password => "changeMe" } }'

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-ck.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 and fixes are welcome. Contact info@chainkit.com

You can’t perform that action at this time.