logstash-output-airbrake 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 438a6c7c1d4fe1068cbbcb429556765886344e5b
-  data.tar.gz: 6a4d572f4768c81554b668dd76788f8d1577f3ae
+  metadata.gz: 7363d10eeb695b51196b0d654973c214df464d74
+  data.tar.gz: f0055a7404f41365126a5871433cf8abaf5df06f
 SHA512:
-  metadata.gz: dd2a7c869bd78cfb27f86fe1c2bcaadcefa8e607e74520053dd4b91712ee93be1b2ae06039cbb1a4c74f8e0edd6a4aa28b105d568ae017cd9ffd8d4ae1cb1618
-  data.tar.gz: 62fe4f1d39f35323445cfe4384a2d8378d0498cc3d13ef7dcec890e52dc6db69e661d3cc7982963911b28b10bcb6680645cfe45795aa534442f0d6eb88226e5c
+  metadata.gz: 390fe82172ece6f45f188b0b9d581c083d2cc2fd91c8a0ccded99304b88f7688f889306a792be3c907b6198b3750c5ba6128685c8276690af50f04f8c22fb969
+  data.tar.gz: d5838f586600a6db164fe880c3c7d094bd06077fd2411f87139d8a90e0fae04df43e74d4eaa8790c7e318d5b3d221b6b409606c97df1a9dda0e650847905b435

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -1,20 +1,35 @@
-# Logstash Plugin
+logstash-output-airbrake
+========================
 
-This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+This plugin adds a new output allowing to send events directly to Airbrake.
 
-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.
+## 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. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+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
 
-## 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
@@ -47,9 +62,9 @@ bundle exec rspec
 
 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.
+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
@@ -71,11 +86,14 @@ bin/plugin install --no-verify
 ```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.
+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:
+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
@@ -89,10 +107,11 @@ bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
 
 ## Contributing
 
-All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+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.
+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/lib/logstash/outputs/airbrake.rb

@@ -3,6 +3,7 @@ require "logstash/namespace"
 require "logstash/outputs/base"
 
 require "airbrake"
+require "zlib"
 
 # This output lets you send logs to Airbrake.
 class LogStash::Outputs::Airbrake < LogStash::Outputs::Base
@@ -43,11 +44,49 @@ class LogStash::Outputs::Airbrake < LogStash::Outputs::Base
   def receive(event)
     return unless output?(event)
 
-    Airbrake.notify(
+    send_notice(build_notice(event))
+  end # def receive
+
+  private
+  def build_notice(event)
+    opts = {
       :error_class   => @error_type,
       :error_message => event['message'],
+      :host          => event['host'],
       :parameters    => event.to_hash
+    }
+
+    LogStash::Outputs::Airbrake::Notice.new(
+      Airbrake.configuration.merge(opts)
     )
-  end # def receive
+  end # def build_notice
+
+  private
+  def send_notice(notice)
+    configuration = Airbrake.configuration
+    sender = Airbrake.sender
+
+    return unless configuration.configured? && configuration.public?
+
+    if configuration.async?
+      configuration.async.call(notice)
+      nil # make sure we never set env["airbrake.error_id"] for async notices
+    else
+      sender.send_to_airbrake(notice)
+    end
+  end
 
 end # class LogStash::Outputs::Airbrake
+
+class LogStash::Outputs::Airbrake::Notice < Airbrake::Notice
+  def initialize(opts = {})
+    super(opts)
+
+    @hostname  = opts[:host] || 'unknown'
+
+    # Airbrake uses the backtrace to aggregate notifications so we cheat and
+    # create a dummy backtrace
+    error_crc32 = Zlib::crc32(opts[:error_message])
+    @backtrace = Airbrake::Backtrace.parse("#{error_crc32}:42:in `#{opts[:error_message]}'")
+  end
+end

data/logstash-output-airbrake.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |s|
   s.name            = "logstash-output-airbrake"
-  s.version         = "0.1.0"
-  s.licenses        = ["MIT"]
+  s.version         = "0.2.0"
+  s.licenses        = ["Apache License (2.0)"]
   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.homepage        = "https://github.com/TEA-ebook/logstash-output-airbrake"
   s.require_paths   = ["lib"]
 
   # Files

data/spec/outputs/airbrake_spec.rb

@@ -25,6 +25,7 @@ describe LogStash::Outputs::Airbrake do
 
   before do
     allow(Airbrake).to receive(:configure)
+    allow(subject).to receive(:send_notice)
 
     subject.register
   end
@@ -40,16 +41,14 @@ describe LogStash::Outputs::Airbrake do
   end
 
   describe "#receive" do
-    let(:event) { LogStash::Event.new("foo" => "bar") }
+    let(:event) { LogStash::Event.new("message" => "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
+      expect(subject).to have_received(:send_notice).once
     end
   end
 end

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-airbrake
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - TEA
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-25 00:00:00.000000000 Z
+date: 2015-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
@@ -20,9 +20,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
@@ -30,48 +28,50 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: airbrake
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: logstash-input-generator
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: logstash-devutils
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  prerelease: false
+  type: :development
 description: Output events to Airbrake
 email: technique@tea-ebook.com
 executables: []
@@ -81,19 +81,19 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
-- README-TEA.md
+- LICENSE
 - README.md
 - Rakefile
 - lib/logstash/outputs/airbrake.rb
 - logstash-output-airbrake.gemspec
 - spec/outputs/airbrake_spec.rb
-homepage: http://www.tea-ebook.com/
+homepage: https://github.com/TEA-ebook/logstash-output-airbrake
 licenses:
-- MIT
+- Apache License (2.0)
 metadata:
   logstash_plugin: 'true'
   logstash_group: output
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,11 +108,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.4.5
+signing_key:
 specification_version: 4
 summary: Logstash Output to Airbrake
 test_files:
 - spec/outputs/airbrake_spec.rb
-has_rdoc: 

data/README-TEA.md

@@ -1,52 +0,0 @@
-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.