Logstash Plugin

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.

Usage


output {
  splunk {
    url => "https://localhost:8080/services/collector/event/1.0"
    # HTTP Event Collector token
    token => "xxxxxxx-xxxx-xxxx-xxxx-xxxxxx"
    is_batch => true
    mapping => {
     "event" => "%{message}"
    }
  }
}

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: ruby gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
Install plugin ```sh # 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
```sh
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 sh gem build logstash-output-splunk.gemspec
Install the plugin from the Logstash home ```sh # 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