logstash-output-airbrake 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 438a6c7c1d4fe1068cbbcb429556765886344e5b
+  data.tar.gz: 6a4d572f4768c81554b668dd76788f8d1577f3ae
+SHA512:
+  metadata.gz: dd2a7c869bd78cfb27f86fe1c2bcaadcefa8e607e74520053dd4b91712ee93be1b2ae06039cbb1a4c74f8e0edd6a4aa28b105d568ae017cd9ffd8d4ae1cb1618
+  data.tar.gz: 62fe4f1d39f35323445cfe4384a2d8378d0498cc3d13ef7dcec890e52dc6db69e661d3cc7982963911b28b10bcb6680645cfe45795aa534442f0d6eb88226e5c

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+Gemfile.lock
+.bundle

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README-TEA.md

@@ -0,0 +1,52 @@
+logstash-output-airbrake
+========================
+
+## Installation de l'environnement de développement
+
+Les plugins logstash sont écrit en ruby mais Logstash nécessite JRuby. La
+première étape consiste donc à l'installer :
+
+```bash
+rbenv install jruby-9.0.0.0.pre1 # la version peut changer
+rbenv global jruby-9.0.0.0.pre1
+```
+
+On doit ensuite installer bundler pour cette version de ruby :
+
+```bash
+gem install bundler
+```
+
+## Tester le plugin sur un serveur logstash local
+
+Dans le répertoire du plugin, installer les dépendances :
+
+```bash
+bundle install
+```
+
+Puis construire la gem du plugin (si on compte la distribuer, sinon pas besoin) :
+
+```bash
+gem build logstash-output-airbrake.gemspec
+```
+
+Exécuter le plugin avec une installation de Logstash *depuis les sources* :
+
+- Éditer le `Gemfile` de Logstash pour y ajouter le plugin :
+```ruby
+gem "logstash-output-airbrake", :path => "/home/kevin/sandbox/logstash-output-airbrake"
+```
+
+- Installer le plugin :
+```sh
+bin/plugin install --no-verify
+```
+
+- Exécuter Logstash avec le plugin :
+```sh
+./bin/logstash --verbose -e 'input { stdin {} } output { airbrake{ api_key => "joe la frite" } }'
+```
+
+Les modifications faites au plugin seront partagées avec l'installation faite
+dans Logstash, il suffit de le redémarrer pour qu'elles soient prises en compte.

data/README.md

@@ -0,0 +1,98 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/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](http://www.elasticsearch.org/guide/en/logstash/current/).
+
+- 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
+
+## 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](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.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/Rakefile

@@ -0,0 +1 @@
+require "logstash/devutils/rake"

data/lib/logstash/outputs/airbrake.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+require "logstash/namespace"
+require "logstash/outputs/base"
+
+require "airbrake"
+
+# This output lets you send logs to Airbrake.
+class LogStash::Outputs::Airbrake < LogStash::Outputs::Base
+  milestone 1
+
+  config_name "airbrake"
+
+  # The API Key to use to send notifications to Airbrake.
+  config :api_key, :validate => :string, :required => true
+
+  # The error type to use when sending notifications.
+  # Defaults to "RuntimeError"
+  config :error_type, :validate => :string, :default => "RuntimeError"
+
+  # The environment name.
+  # Defaults to "logstash"
+  config :environment, :validate => :string, :default => "logstash"
+
+  # Host of the Airbrake server.
+  config :host, :validate => :string
+
+  # Port of the Airbrake server.
+  config :port, :validate => :number
+
+  public
+  def register
+    Airbrake.configure do |c|
+      c.api_key          = @api_key
+      c.environment_name = @environment
+
+      c.host   = @host if @host
+      c.port   = @port if @port
+      c.secure = @port.to_i == 443
+    end
+  end # def register
+
+  public
+  def receive(event)
+    return unless output?(event)
+
+    Airbrake.notify(
+      :error_class   => @error_type,
+      :error_message => event['message'],
+      :parameters    => event.to_hash
+    )
+  end # def receive
+
+end # class LogStash::Outputs::Airbrake

data/logstash-output-airbrake.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+  s.name            = "logstash-output-airbrake"
+  s.version         = "0.1.0"
+  s.licenses        = ["MIT"]
+  s.summary         = "Logstash Output to Airbrake"
+  s.description     = "Output events to Airbrake"
+  s.authors         = ["TEA"]
+  s.email           = 'technique@tea-ebook.com'
+  s.homepage        = "http://www.tea-ebook.com/"
+  s.require_paths   = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)
+
+  # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", ">= 1.4.0", "< 2.0.0"
+
+  s.add_runtime_dependency "airbrake", ['~> 4.0']
+
+  s.add_development_dependency "logstash-input-generator"
+  s.add_development_dependency "logstash-devutils"
+end

data/spec/outputs/airbrake_spec.rb

@@ -0,0 +1,55 @@
+require "logstash/devutils/rspec/spec_helper"
+
+require "logstash/pipeline"
+require "logstash/outputs/airbrake"
+
+describe LogStash::Outputs::Airbrake do
+  subject { klass.new(settings) }
+
+  let(:klass) { LogStash::Outputs::Airbrake }
+
+  let(:api_key) { "dummy api key" }
+  let(:error_type) { "some error_type" }
+  let(:environment) { "some environment" }
+  let(:host) { "airbrake host" }
+  let(:port) { 4242 }
+  let(:settings) {
+    {
+      "api_key"     => api_key,
+      "error_type"  => error_type,
+      "environment" => environment,
+      "host"        => host,
+      "port"        => port
+    }
+  }
+
+  before do
+    allow(Airbrake).to receive(:configure)
+
+    subject.register
+  end
+
+  describe "#register" do
+    it "should create cleanly" do
+      expect(subject).to be_a(klass)
+    end
+
+    it "should configure airbrake" do
+      expect(Airbrake).to have_received(:configure).once
+    end
+  end
+
+  describe "#receive" do
+    let(:event) { LogStash::Event.new("foo" => "bar") }
+
+    before do
+      allow(Airbrake).to receive(:notify)
+
+      subject.receive(event)
+    end
+
+    it "should forward the event to Airbrake" do
+      expect(Airbrake).to have_received(:notify).once
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-airbrake
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TEA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: airbrake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: logstash-input-generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Output events to Airbrake
+email: technique@tea-ebook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README-TEA.md
+- README.md
+- Rakefile
+- lib/logstash/outputs/airbrake.rb
+- logstash-output-airbrake.gemspec
+- spec/outputs/airbrake_spec.rb
+homepage: http://www.tea-ebook.com/
+licenses:
+- MIT
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Logstash Output to Airbrake
+test_files:
+- spec/outputs/airbrake_spec.rb
+has_rdoc: