exception_handling 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba22d4665ccfec321d2f12cd3dbf965aa470ce0f
-  data.tar.gz: 59d92855f4428b245ccafdab96ae2690a8df4be4
+  metadata.gz: de8ca845a02baac1f3d11d1c1e3ff419698ed239
+  data.tar.gz: 57789ae890ab9c9cc2c8f1bce947ca7b58660082
 SHA512:
-  metadata.gz: ac10edb35d2d2e7ee25fe17aa7df89137452a368c5e95b599ed62a780c02bdf9e5cd9a0bbc334d7cb410dc8320ae8aaf3afbfc995ad489018a1b9e016c9b2a1c
-  data.tar.gz: 85c0eb7988d28e5fcbcb6f2e8e66f9a13b25dc8a174f4dff6ab6b414df4eb5dfbe3dfa2a01abaaf8a7e5f05d2416d4f1fc62024e4afc9d58f3340c4f771af94b
+  metadata.gz: 5450a2e7753d4e34927f25d0fe21929b5e1670eba9e88e8a2add7e6b8f6fc027343b6771e192875e657e7b7734c9bfd20d3551f123293c52ce5355974a1fa844
+  data.tar.gz: dd96400045fec01c3ce1c38d2e8d9f2a800ecfd67713fe23fc3c9d1053dffe6956e2735dece5befe8e0c1dfde66a2e7814e3a80847b3d416868d4fb823f0cd14

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    exception_handling (1.0.4)
+    exception_handling (1.1.0)
       actionmailer (~> 3.2)
       actionpack (~> 3.2)
       activesupport (~> 3.2)
@@ -45,14 +45,14 @@ GEM
     builder (3.0.4)
     coderay (1.1.0)
     erubis (2.7.0)
-    eventmachine (1.0.3)
+    eventmachine (1.0.8)
     hike (1.2.3)
     hobo_support (2.0.1)
       rails (~> 3.2.0)
     i18n (0.6.11)
     invoca-utils (0.0.2)
     journey (1.0.4)
-    json (1.8.1)
+    json (1.8.3)
     mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
@@ -67,12 +67,12 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rack (1.4.5)
+    rack (1.4.7)
     rack-cache (1.2)
       rack (>= 0.4)
     rack-ssl (1.3.4)
       rack
-    rack-test (0.6.2)
+    rack-test (0.6.3)
       rack (>= 1.0)
     rails (3.2.19)
       actionmailer (= 3.2.19)
@@ -101,7 +101,7 @@ GEM
       activesupport (>= 3.0.0)
       bourne (~> 1.3)
     slop (3.6.0)
-    sprockets (2.2.2)
+    sprockets (2.2.3)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
@@ -111,7 +111,7 @@ GEM
     treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.41)
+    tzinfo (0.3.45)
 
 PLATFORMS
   ruby

data/README.md

@@ -36,6 +36,9 @@ For example:
     ExceptionHandling.email_environment       = Rails.env
     ExceptionHandling.eventmachine_safe       = false
     ExceptionHandling.eventmachine_synchrony  = false
+    ExceptionHandling.sensu_host              = "127.0.0.1"
+    ExceptionHandling.sensu_port              = 3030
+    ExceptionHandling.sensu_prefix            = ""
 
 
 ## Usage

data/lib/exception_handling/methods.rb

@@ -47,6 +47,16 @@ module ExceptionHandling
       end
     end
 
+    def alert_warning(*args)
+      ExceptionHandling.alert_warning(*args)
+    end
+
+    def ensure_alert(*args)
+      ExceptionHandling.ensure_alert(*args) do
+        yield
+      end
+    end
+
     # Store aside the current controller when included
     LONG_REQUEST_SECONDS = (defined?(Rails) && Rails.env == 'test' ? 300 : 30)
     def set_current_controller

data/lib/exception_handling/sensu.rb

@@ -0,0 +1,26 @@
+require "socket"
+
+module ExceptionHandling
+  module Sensu
+    LEVELS = {
+        warning:  1,
+        critical: 2
+    }
+
+    class << self
+      def generate_event(name, message, level = :warning)
+        status = LEVELS[level] or raise "Invalid alert level #{level}"
+
+        event = {name: ExceptionHandling.sensu_prefix.to_s + name, output: message, status: status}
+
+        send_event(event)
+      end
+
+      def send_event(event)
+        Socket.tcp(ExceptionHandling.sensu_host, ExceptionHandling.sensu_port) do |sock|
+          sock.send(event.to_json, 0)
+        end
+      end
+    end
+  end
+end

data/lib/exception_handling/version.rb

@@ -1,3 +1,3 @@
 module ExceptionHandling
-  VERSION = "1.0.5"
+  VERSION = "1.1.0"
 end

data/lib/exception_handling.rb

@@ -5,6 +5,7 @@ require 'active_support/core_ext/hash'
 require 'invoca/utils'
 
 require "exception_handling/mailer"
+require "exception_handling/sensu"
 require "exception_handling/methods"
 require "exception_handling/log_stub_error"
 require "exception_handling/exception_description"
@@ -108,12 +109,18 @@ EOF
     attr_accessor :custom_data_hook
     attr_accessor :post_log_error_hook
     attr_accessor :stub_handler
+    attr_accessor :sensu_host
+    attr_accessor :sensu_port
+    attr_accessor :sensu_prefix
 
     @filter_list_filename = "./config/exception_filters.yml"
     @mailer_send_enabled  = true
     @email_environment = ""
     @eventmachine_safe = false
     @eventmachine_synchrony = false
+    @sensu_host = "127.0.0.1"
+    @sensu_port = 3030
+    @sensu_prefix = ""
 
     # set this for operation within an eventmachine reactor
     def eventmachine_safe=(bool)
@@ -302,6 +309,25 @@ EOF
       end
     end
 
+    def alert_warning(exception_or_string, alert_name, exception_context)
+      ex = make_exception(exception_or_string)
+      log_error(ex, exception_context)
+      begin
+        ExceptionHandling::Sensu.generate_event(alert_name, exception_context.to_s + "\n" + ex.message.to_s)
+      rescue => send_ex
+        log_error(send_ex, 'ExceptionHandling.alert_warning')
+      end
+    end
+
+    def ensure_alert(alert_name, exception_context)
+      begin
+        yield
+      rescue => ex
+        alert_warning(ex, alert_name, exception_context)
+        nil
+      end
+    end
+
     def set_log_error_timestamp
       ExceptionHandling.last_exception_timestamp = Time.now.to_i
     end
@@ -467,7 +493,7 @@ EOF
     end
 
     def clean_backtrace(exception)
-      if exception.backtrace.nil?
+      backtrace = if exception.backtrace.nil?
         ['<no backtrace>']
       elsif exception.is_a?(ClientLoggingError)
         exception.backtrace
@@ -476,6 +502,13 @@ EOF
       else
         exception.backtrace
       end
+
+      # The rails backtrace cleaner returns an empty array for a backtrace if the exception was raised outside the app (inside a gem for instance)
+      if backtrace.is_a?(Array) && backtrace.empty?
+        exception.backtrace
+      else
+        backtrace
+      end
     end
 
     def clear_exception_summary

data/test/test_helper.rb

@@ -33,8 +33,33 @@ require 'exception_handling/testing'
     def clear
       @logged = []
     end
+ end
+
+class SocketStub
+  attr_accessor :sent, :connected
+
+  def initialize
+    @connected = true
+    clear
+  end
+
+  def send(message, _flags)
+    sent << message
+  end
+
+  def close
+    @connected = false
   end
 
+  def clear
+    @sent = []
+  end
+
+  def closed?
+    !@connceted
+  end
+end
+
   ExceptionHandling.logger = LoggerStub.new
 
   def dont_stub_log_error
@@ -67,6 +92,9 @@ class ActiveSupport::TestCase
     ExceptionHandling.filter_list_filename    = "./config/exception_filters.yml"
     ExceptionHandling.eventmachine_safe       = false
     ExceptionHandling.eventmachine_synchrony  = false
+    ExceptionHandling.sensu_host              = "127.0.0.1"
+    ExceptionHandling.sensu_port              = 3030
+    ExceptionHandling.sensu_prefix            = ""
   end
 
   teardown do

data/test/unit/exception_handling/exception_description_test.rb

@@ -65,6 +65,15 @@ module ExceptionHandling
         assert_equal expected, exception_description.exception_data
       end
 
+      should "match multiple email addresses" do
+        mobi = "ExceptionHandling::Warning: LoginAttempt::IPAddressLocked: failed login for 'mcc@mobistreak.com'"
+        credit = "ExceptionHandling::Warning: LoginAttempt::IPAddressLocked: failed login for 'damon@thecreditpros.com'"
+
+        exception_description = ExceptionDescription.new(:filter1, error: "ExceptionHandling::Warning: LoginAttempt::IPAddressLocked: failed login for '(mcc\@mobistreak|damon\@thecreditpros).com'" )
+        assert exception_description.match?(error: mobi), "does not match mobi"
+        assert exception_description.match?(error: credit), "does not match credit"
+      end
+
     end
 
   end

data/test/unit/exception_handling/sensu_test.rb

@@ -0,0 +1,50 @@
+require File.expand_path('../../../test_helper',  __FILE__)
+
+module ExceptionHandling
+  class SensuTest < ActiveSupport::TestCase
+    context "#generate_event" do
+      should "create an event" do
+        mock(ExceptionHandling::Sensu).send_event({ name: "world_is_ending", output: "stick head between knees and kiss ass goodbye", status: 1 })
+
+        ExceptionHandling::Sensu.generate_event("world_is_ending", "stick head between knees and kiss ass goodbye")
+      end
+
+      should "add the sensu prefix" do
+        ExceptionHandling.sensu_prefix = "cnn_"
+
+        mock(ExceptionHandling::Sensu).send_event({ name: "cnn_world_is_ending", output: "stick head between knees and kiss ass goodbye", status: 1 })
+
+        ExceptionHandling::Sensu.generate_event("world_is_ending", "stick head between knees and kiss ass goodbye")
+      end
+
+      should "allow the level to be set to critical" do
+        mock(ExceptionHandling::Sensu).send_event({ name: "world_is_ending", output: "stick head between knees and kiss ass goodbye", status: 2 })
+
+        ExceptionHandling::Sensu.generate_event("world_is_ending", "stick head between knees and kiss ass goodbye", :critical)
+      end
+
+      should "error if an invalid level is supplied" do
+        dont_allow(ExceptionHandling::Sensu).send_event
+
+        assert_raise(RuntimeError, "Invalid alert level") do
+          ExceptionHandling::Sensu.generate_event("world_is_ending", "stick head between knees and kiss ass goodbye", :hair_on_fire)
+        end
+      end
+    end
+
+    context "#send_event" do
+      setup do
+        @event = { name: "world_is_ending", output: "stick head between knees and kiss ass goodbye", status: 1 }
+        @socket = SocketStub.new
+      end
+
+      should "send event json to sensu client" do
+        mock.any_instance_of(Addrinfo).connect.with_any_args { @socket }
+
+        ExceptionHandling::Sensu.send_event(@event)
+
+        assert_equal @event.to_json, @socket.sent.first
+      end
+    end
+  end
+end

data/test/unit/exception_handling_test.rb

@@ -228,6 +228,29 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
       end
     end
 
+    context "ExceptionHandling.ensure_alert" do
+      should "log the exception as usual and fire a sensu event" do
+        mock(ExceptionHandling::Sensu).generate_event("Favorite Feature", "test context\nblah")
+        mock(ExceptionHandling.logger).fatal(/\(blah\):\n.*exception_handling_test\.rb/)
+        ExceptionHandling.ensure_alert('Favorite Feature', 'test context') { raise ArgumentError.new("blah") }
+      end
+
+      should "should not send sensu event if an exception is not raised." do
+        dont_allow(ExceptionHandling.logger).fatal
+        dont_allow(ExceptionHandling::Sensu).generate_event
+        ExceptionHandling.ensure_alert('Ignored', 'test context') { ; }
+      end
+
+      should "log if the sensu event could not be sent" do
+        mock(ExceptionHandling::Sensu).send_event(anything) { raise "Failed to send" }
+        mock(ExceptionHandling.logger) do |logger|
+          logger.fatal(/first_test_exception/)
+          logger.fatal(/Failed to send/)
+        end
+        ExceptionHandling.ensure_alert("Not Used", 'test context') { raise ArgumentError.new("first_test_exception") }
+      end
+    end
+
     context "exception timestamp" do
       setup do
         Time.now_override = Time.parse( '1986-5-21 4:17 am UTC' )
@@ -609,37 +632,52 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
     end
 
     should "return entire backtrace if cleaned is emtpy" do
-      backtrace = ["/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activerecord/lib/active_record/relation/finder_methods.rb:312:in `find_with_ids'",
-                   "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activerecord/lib/active_record/relation/finder_methods.rb:107:in `find'",
-                   "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activerecord/lib/active_record/querying.rb:5:in `__send__'",
-                   "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activerecord/lib/active_record/querying.rb:5:in `find'",
-                   "/Library/Ruby/Gems/1.8/gems/shoulda-context-1.0.2/lib/shoulda/context/context.rb:398:in `call'",
-                   "/Library/Ruby/Gems/1.8/gems/shoulda-context-1.0.2/lib/shoulda/context/context.rb:398:in `test: Exception mapping should return entire backtrace if cleaned is emtpy. '",
-                   "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/testing/setup_and_teardown.rb:72:in `__send__'",
-                   "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/testing/setup_and_teardown.rb:72:in `run'",
-                   "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/callbacks.rb:447:in `_run__1913317170__setup__4__callbacks'",
-                   "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/callbacks.rb:405:in `send'",
-                   "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/callbacks.rb:405:in `__run_callback'",
-                   "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/callbacks.rb:385:in `_run_setup_callbacks'",
-                   "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/callbacks.rb:81:in `send'",
-                   "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/callbacks.rb:81:in `run_callbacks'",
-                   "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/testing/setup_and_teardown.rb:70:in `run'",
-                   "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/testsuite.rb:34:in `run'",
-                   "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/testsuite.rb:33:in `each'",
-                   "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/testsuite.rb:33:in `run'",
-                   "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/ui/testrunnermediator.rb:46:in `old_run_suite'",
-                   "(eval):12:in `run_suite'",
-                   "/Applications/RubyMine.app/rb/testing/patch/testunit/test/unit/ui/teamcity/testrunner.rb:93:in `send'",
-                   "/Applications/RubyMine.app/rb/testing/patch/testunit/test/unit/ui/teamcity/testrunner.rb:93:in `start_mediator'",
-                   "/Applications/RubyMine.app/rb/testing/patch/testunit/test/unit/ui/teamcity/testrunner.rb:81:in `start'",
-                   "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/ui/testrunnerutilities.rb:29:in `run'",
-                   "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/autorunner.rb:12:in `run'",
-                   "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit.rb:279",
-                   "-e:1"]
-      ex = Exception.new
-      ex.set_backtrace(backtrace)
-      result = ExceptionHandling.send(:clean_backtrace, ex)
-      assert_equal backtrace, result
+      begin
+        backtrace = ["/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activerecord/lib/active_record/relation/finder_methods.rb:312:in `find_with_ids'",
+                     "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activerecord/lib/active_record/relation/finder_methods.rb:107:in `find'",
+                     "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activerecord/lib/active_record/querying.rb:5:in `__send__'",
+                     "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activerecord/lib/active_record/querying.rb:5:in `find'",
+                     "/Library/Ruby/Gems/1.8/gems/shoulda-context-1.0.2/lib/shoulda/context/context.rb:398:in `call'",
+                     "/Library/Ruby/Gems/1.8/gems/shoulda-context-1.0.2/lib/shoulda/context/context.rb:398:in `test: Exception mapping should return entire backtrace if cleaned is emtpy. '",
+                     "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/testing/setup_and_teardown.rb:72:in `__send__'",
+                     "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/testing/setup_and_teardown.rb:72:in `run'",
+                     "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/callbacks.rb:447:in `_run__1913317170__setup__4__callbacks'",
+                     "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/callbacks.rb:405:in `send'",
+                     "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/callbacks.rb:405:in `__run_callback'",
+                     "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/callbacks.rb:385:in `_run_setup_callbacks'",
+                     "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/callbacks.rb:81:in `send'",
+                     "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/callbacks.rb:81:in `run_callbacks'",
+                     "/Users/peter/ringrevenue/web/vendor/rails-3.2.12/activesupport/lib/active_support/testing/setup_and_teardown.rb:70:in `run'",
+                     "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/testsuite.rb:34:in `run'",
+                     "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/testsuite.rb:33:in `each'",
+                     "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/testsuite.rb:33:in `run'",
+                     "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/ui/testrunnermediator.rb:46:in `old_run_suite'",
+                     "(eval):12:in `run_suite'",
+                     "/Applications/RubyMine.app/rb/testing/patch/testunit/test/unit/ui/teamcity/testrunner.rb:93:in `send'",
+                     "/Applications/RubyMine.app/rb/testing/patch/testunit/test/unit/ui/teamcity/testrunner.rb:93:in `start_mediator'",
+                     "/Applications/RubyMine.app/rb/testing/patch/testunit/test/unit/ui/teamcity/testrunner.rb:81:in `start'",
+                     "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/ui/testrunnerutilities.rb:29:in `run'",
+                     "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/autorunner.rb:12:in `run'",
+                     "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit.rb:279",
+                     "-e:1"]
+
+        module ::Rails
+          class BacktraceCleaner
+            def clean(_backtrace)
+              []
+            end
+          end
+        end
+
+        mock(Rails).backtrace_cleaner { Rails::BacktraceCleaner.new }
+
+        ex = Exception.new
+        ex.set_backtrace(backtrace)
+        result = ExceptionHandling.send(:clean_backtrace, ex)
+        assert_equal backtrace, result
+      ensure
+        Object.send(:remove_const, :Rails)
+      end
     end
 
     should "clean params" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_handling
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Colin Kelley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-26 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -172,6 +172,7 @@ files:
 - lib/exception_handling/log_stub_error.rb
 - lib/exception_handling/mailer.rb
 - lib/exception_handling/methods.rb
+- lib/exception_handling/sensu.rb
 - lib/exception_handling/testing.rb
 - lib/exception_handling/version.rb
 - test/test_helper.rb
@@ -180,6 +181,7 @@ files:
 - test/unit/exception_handling/log_error_stub_test.rb
 - test/unit/exception_handling/mailer_test.rb
 - test/unit/exception_handling/methods_test.rb
+- test/unit/exception_handling/sensu_test.rb
 - test/unit/exception_handling_test.rb
 - views/exception_handling/mailer/escalation_notification.html.erb
 - views/exception_handling/mailer/exception_notification.html.erb
@@ -215,5 +217,6 @@ test_files:
 - test/unit/exception_handling/log_error_stub_test.rb
 - test/unit/exception_handling/mailer_test.rb
 - test/unit/exception_handling/methods_test.rb
+- test/unit/exception_handling/sensu_test.rb
 - test/unit/exception_handling_test.rb
 has_rdoc: