logstash-output-airbrake
========================

This plugin adds a new output allowing to send events directly to Airbrake.

## Sample configuration

```ruby
input {
  stdin {}
}

output {
  airbrake {
    api_key => "My awesome API key" # required
    error_type => "RuntimeError" # optional, defaults to: "RuntimeError"
    environment => "logstash" # optional, defaults to: "logstash"
    host => "custom airbrake host" # optional, no default value
    port => 42 # optional, no default value
  }
}
```

## 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.

- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide

## 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](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).

- Install dependencies
```sh
bundle install
```

#### Test

- Update your dependencies

```sh
bundle install
```

- Run unit tests

```sh
bundle exec rspec
```

- Run integration tests

Dependencies: [Docker](http://docker.com)

Before the test suite is run, we will load and run an Elasticsearch instance
within a docker container. This container will be cleaned up when suite has
finished.

```sh
bundle exec rspec --tag integration
```

### 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
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-filter-awesome.gemspec
```
- Install the plugin from the Logstash home
```sh
bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
```
- 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.