logging-appenders-airbrake 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e929ba30042809af24030e50fced5b64859fc26b
-  data.tar.gz: 94880fe8ac8fed00c0cffd06b9a46a7c111afe35
+  metadata.gz: 97f073a81dd1862e5c006694dbb3504a141f1a62
+  data.tar.gz: b208c5332f9065293128d65dfb62357d455525d9
 SHA512:
-  metadata.gz: eb14162f105a6cfaaa72388662bf2050b95773c0cd66ae1f4ac4545b37d5cd3272269e7655f401566edca5212f9246a3da07855d128fffb617b289d53f5cfcc6
-  data.tar.gz: 81da15b60be0f1909fbf6e745d9b8070ae672c54be98c74e89a4baa81373caeb4e3d42183cce95c6c66ff85a5be3c4c6facc5df5d765ac92e164ceb3b19379b7
+  metadata.gz: 1f5b049f21615fbf3e913fb845d1a2f4bbd7a04ba4d4f48631797b4e1ed0a96ad1250c03484d04cc5cd65fd89bc8f765b11079de51eb8f07be0bac120f081098
+  data.tar.gz: 6ca6d8a69d741182206c717edd31e33aa292f75d9adfe1356b22806d2d487f76359e792c3e89ea0a2909af5a21097aa8cf23a4582dfb3531c639106cddffba51

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - 2.0
+  - 2.1
+  - 2.2
+
+notifications:
+  email: false

data/Changes

@@ -0,0 +1,5 @@
+v0.0.2    2015-03-21
+--------------------
+Bug fixes:
+* Ignore error/fatal calls from the Airbrake sender
+* Under Rails, prevent exceptions caught by the Airbrake middleware from being sent twice

data/README.md

@@ -1,6 +1,8 @@
 # Logging::Appenders::Airbrake
 
-Airbrake appender for [the logging gem](https://github.com/TwP/logging).
+[![Build Status](https://travis-ci.org/sshaw/logging-appenders-airbrake.svg?branch=master)](https://travis-ci.org/sshaw/logging-appenders-airbrake)
+
+Airbrake appender for [the Logging gem](https://github.com/TwP/logging).
 
 ## Overview
 
@@ -19,10 +21,10 @@ Airbrake appender for [the logging gem](https://github.com/TwP/logging).
     end
 
 	log.add_appenders(Logging.appenders.airbrake)
-	
+
 	log.info  "Not sent to airbrake"
 	log.error "Airbrake here I come!"
-	log.error SomeError.new("See you @ airbrake.io!")	
+	log.error SomeError.new("See you @ airbrake.io!")
 
 ## Description
 
@@ -34,8 +36,9 @@ to the `airbrake` method:
 
     Logging.appenders.airbrake("another_name", options)
 
-Airbrake configuration can be done via `Airbrake.configure` or via `Logging.appenders.airbrake`. 
-All Airbrake options can be passed to the latter.
+Airbrake configuration can be done via `Airbrake.configure` or via `Logging.appenders.airbrake`.
+All [`Airbrake::Configuration` options](http://www.rubydoc.info/gems/airbrake/Airbrake/Configuration) can be passed
+to the latter.
 
 ## Using With `logging-rails`
 

data/lib/logging/appenders/airbrake.rb

@@ -1,5 +1,5 @@
 require "airbrake"
-require "logging/appender"
+require "logging"
 
 module Logging::Appenders
   def self.airbrake(*args)
@@ -11,53 +11,59 @@ module Logging::Appenders
   end
 
   class Airbrake < Logging::Appender
-    FILTER = lambda do |line|
+    VERSION = "0.0.2"
+
+    # Ignore errors logged by an Airbrake sender
+    INTERNAL_BT_FILTER = %r{:in\s+`send_to_airbrake'}.freeze
+
+    # Remove calls to this class in the stacktrace sent to Airbrake
+    AIRBRAKE_BT_FILTER = lambda do |line|
       line =~ %r{/logging-[^/]+/lib/logging/} ? nil : line
     end
 
-    attr :options
-
     def initialize(*args)
-      args.compact!
-
-      name = args.first.is_a?(String) ? args.shift : "airbrake"
-      super(name, :level => :error)
-
       cfg = ::Airbrake.configuration
       cfg.framework = "Logging #{Logging.version}"
 
-      @options = args.shift || {}
-      @options[:backtrace_filters] ||= []
-      @options[:backtrace_filters] << FILTER
+      appender = { :level => :error }
+
+      args.compact!
+      name = args.first.is_a?(String) ? args.shift : "airbrake"
+      airbrake = args.last.is_a?(Hash) ? args.pop : {}
 
-      @options.each do |k,v|
-        unless ::Airbrake::Configuration::OPTIONS.include?(k)
-          raise ArgumentError, "unknown Airbrake configuration option #{k}"
+      airbrake[:backtrace_filters] ||= []
+      airbrake[:backtrace_filters] << AIRBRAKE_BT_FILTER
+
+      airbrake.keys.each do |name|
+        unless ::Airbrake::Configuration::OPTIONS.include?(name)
+          appender[name] = airbrake.delete(name)
+          next
         end
 
         # Airbrake array attributes have no setter
-        if cfg[k].is_a?(Array)
-          cfg[k].concat(Array(v))
+        if cfg[name].is_a?(Array)
+          cfg[name].concat(Array(airbrake[name]))
         else
-          cfg.method("#{k}=")[v]
+          cfg.public_send("#{name}=", airbrake[name])
         end
       end
+
+      super(name, appender)
     end
 
     private
 
     def write(event)
-      if ::Airbrake.configuration.configured?
-        # Docs say event can be a String too, not sure when/how but we'll check anyways
-        error = event.is_a?(Logging::LogEvent) ? event.data : event
-        error = { :error_message => error } if error.is_a?(String)
-
-        ::Airbrake.notify_or_ignore(error)
-      else
-        # TODO: better to just set Airbrake's logger to something so it can log this?
-        Logging.log_internal { 'Not logging #{event.inspect}: Airbrake is not configured' }
-      end
+      return self if caller.any? { |bt| bt =~ INTERNAL_BT_FILTER }
+
+      # Docs say event can be a String too, not sure when/how but we'll check anyways
+      error = event.is_a?(Logging::LogEvent) ? event.data : event
+      error = { :error_message => error } if error.is_a?(String)
+
+      ::Airbrake.notify_or_ignore(error)
       self
     end
   end
 end
+
+require "logging/appenders/airbrake/railtie" if defined?(Rails::Railtie)

data/lib/logging/appenders/airbrake/railtie.rb

@@ -0,0 +1,26 @@
+require "rails"
+require "logging/appenders/airbrake"
+
+module Logging
+  module Appenders
+    class Airbrake
+      class Railtie < ::Rails::Railtie
+        config.after_initialize do |app|
+          next unless defined?(::Airbrake::Rails::Middleware) && app.middleware.include?(::Airbrake::Rails::Middleware)
+
+          log = app.env_config["action_dispatch.logger"]
+          next unless log.is_a?(Logging::Logger)
+
+          # After sending an exception to Airbrake its middleware passes the exception (`raise`es) it up
+          # the stack. Rails' middleware (DebugException, ShowExceptions) ends up logging these as fatal,
+          # which triggers the Airbrake appender. To avoid sending the exception twice we remove the appender.
+          log.appenders = Logging.logger.root.appenders if log.appenders.none?
+          log.appenders = log.appenders.reject { |a| a.is_a?(Logging::Appenders::Airbrake) }
+          log.additive = false
+
+          app.env_config["action_dispatch.logger"] = log
+        end
+      end
+    end
+  end
+end

data/logging-appenders-airbrake.gemspec

@@ -4,11 +4,11 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "logging-appenders-airbrake"
-  spec.version       = "0.0.1"
+  spec.version       = "0.0.2"
   spec.authors       = ["Skye Shaw"]
   spec.email         = ["skye.shaw@gmail.com"]
-  spec.summary       = %q{Airbrake appender for the logging gem}
-  spec.description   = %q{An appender for the logging gem that will send all messages logged at the :error level to Airbrake}
+  spec.summary       = %q{Airbrake appender for the Logging gem}
+  spec.description   = %q{An appender for the Logging gem that sends all messages logged at the :error level to Airbrake}
   spec.homepage      = "https://github.com/sshaw/logging-appenders-airbrake"
   spec.license       = "MIT"
 
@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = "> 1.8.7"
 
   spec.add_dependency "airbrake"
   spec.add_dependency "logging"

data/test/test_airbrake.rb

@@ -5,7 +5,20 @@ require "minitest/mock"
 require "logging"
 require "logging/appenders/airbrake"
 
+class FailingSender < Airbrake::Sender
+  def send_to_airbrake(notice)
+    logger.error("error!")
+    logger.fatal("fatal!")
+  end
+end
+
 class TestAirbrake < MiniTest::Unit::TestCase
+  CFG = Airbrake.configuration
+
+  def setup
+    Airbrake.configuration = CFG
+  end
+
   def test_configuration_without_appender_name
     app = appender(config)
 
@@ -32,16 +45,12 @@ class TestAirbrake < MiniTest::Unit::TestCase
     end
   end
 
-  def test_invalid_configuration
-    assert_raises(ArgumentError, /unknown/) { appender(:ass => "bass") }
-  end
-
   def test_only_error_level_logged
     count = 0
     app = appender
     app.define_singleton_method(:write) { |e| count += 1 }
 
-    log = Logging.logger[self]
+    log = Logging.logger[__method__]
     log.add_appenders(app)
 
     log.info("Hi")
@@ -53,6 +62,18 @@ class TestAirbrake < MiniTest::Unit::TestCase
     assert_equal 2, count
   end
 
+  def test_errors_from_airbrake_sender_ignored
+    log = Logging.logger[__method__]
+    log.add_appenders(appender)
+
+    Airbrake.configuration.logger = log
+    Airbrake.sender = FailingSender.new
+
+    log.info("info")
+    # If the test fails this will trigger a SystemStackError
+    log.error("some error")
+  end
+
   private
   def config
     @config ||= {
@@ -62,6 +83,7 @@ class TestAirbrake < MiniTest::Unit::TestCase
     }
   end
 
+  # With this the appender is created only once unless there's a name
   def appender(*args)
     args << { :api_key => "X123" } unless args.last.is_a?(Hash)
     Logging.appenders.airbrake(*args)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logging-appenders-airbrake
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Skye Shaw
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-09 00:00:00.000000000 Z
+date: 2015-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: airbrake
@@ -66,8 +66,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: An appender for the logging gem that will send all messages logged at
-  the :error level to Airbrake
+description: An appender for the Logging gem that sends all messages logged at the
+  :error level to Airbrake
 email:
 - skye.shaw@gmail.com
 executables: []
@@ -75,10 +75,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- Changes
 - Gemfile
 - README.md
 - Rakefile
 - lib/logging/appenders/airbrake.rb
+- lib/logging/appenders/airbrake/railtie.rb
 - logging-appenders-airbrake.gemspec
 - test/test_airbrake.rb
 homepage: https://github.com/sshaw/logging-appenders-airbrake
@@ -91,9 +94,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -101,9 +104,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Airbrake appender for the logging gem
+summary: Airbrake appender for the Logging gem
 test_files:
 - test/test_airbrake.rb