log4r-exceptionable 0.5.2 → 0.5.3

data/CHANGELOG

@@ -1,3 +1,10 @@
+0.5.3 (06/15/2012)
+------------------
+
+add in controller/action names from rails as custom attributes <a83c1f5>
+delegate exception formatting to log4r by passing exception object to logger instead of creating message manually <d9526d3>
+store exception line as an int not string <9de126a>
+
 0.5.2 (06/15/2012)
 ------------------
 

data/lib/log4r-exceptionable/rack_failure_handler.rb

@@ -40,24 +40,13 @@ module Log4rExceptionable
         original_mdc = mdc.get_context
         
         begin
-          message = "#{exception.class}: #{exception.message}"
-          
-          mdc.put('rack_exception', exception.class.name)
-          trace = Array(exception.backtrace)
-          if trace.size > 0
-            message << "\n"
-            message << trace.join("\n")
 
-            file, line = trace[0].split(":")
-            mdc.put('rack_exception_file', file)
-            mdc.put('rack_exception_line', line)
-          end
-    
           if env and env.size > 0
             env.each do |k, v|
               begin
                 mdc.put("rack_env_#{k}", v.inspect)
               rescue
+                puts "Log4r Exceptionable could not extract a rack env item: " + e.message
               end
             end
           end
@@ -65,13 +54,19 @@ module Log4rExceptionable
           controller = env['action_controller.instance']
           if controller && controller.respond_to?(:logger) && controller.logger.instance_of?(Log4r::Logger)
             error_logger = controller.logger 
+            begin
+              mdc.put("rack_controller_name", controller.controller_name.to_s)
+              mdc.put("rack_action_name", controller.action_name.to_s)
+            rescue => e
+              puts "Log4r Exceptionable could not extract controller names: " + e.message
+            end
           elsif env['rack.logger'] && env['rack.logger'].instance_of?(Log4r::Logger)
             error_logger = env['rack.logger']
           else
             error_logger = Log4rExceptionable::Configuration.rack_failure_logger
           end
           
-          error_logger.error(message)
+          error_logger.error(exception)
         ensure
           # Since this is somewhat of a global map, clean the keys
           # we put in so other log messages don't see them

data/lib/log4r-exceptionable/resque_failure_handler.rb

@@ -12,23 +12,18 @@ module Log4rExceptionable
         original_mdc = mdc.get_context
         
         begin
-          message = "#{exception.class}: #{exception.message}"
-          
-          mdc.put('resque_exception', exception.class.name)
-          trace = Array(exception.backtrace)
-          if trace.size > 0
-            message << "\n"
-            message << trace.join("\n")
-            
-            file, line = trace[0].split(":")
-            mdc.put('resque_exception_file', file)
-            mdc.put('resque_exception_line', line)
-          end
-          
+             
+          data = payload.clone
           mdc.put("resque_worker", worker.to_s)
           mdc.put("resque_queue", queue.to_s)
-          mdc.put("resque_class", payload['class'].to_s)
-          mdc.put("resque_args", payload['args'].inspect.to_s)
+          mdc.put("resque_class", data.delete('class').to_s)
+          mdc.put("resque_args", data.delete('args').inspect.to_s)
+          
+          # add in any extra payload data, in case resque plugins have
+          # added to it (e.g. resque-lifecycle)
+          data.each do |k, v|
+            mdc.put("resque_payload_#{k}", v.inspect.to_s)
+          end
 
           payload_class = Resque.constantize(payload['class']) rescue nil
           if payload_class && payload_class.respond_to?(:logger) && payload_class.logger.instance_of?(Log4r::Logger)
@@ -37,7 +32,7 @@ module Log4rExceptionable
             error_logger = Log4rExceptionable::Configuration.resque_failure_logger
           end
           
-          error_logger.error(message)
+          error_logger.error(exception)
         ensure
           # Since this is somewhat of a global map, clean the keys
           # we put in so other log messages don't see them

data/lib/log4r-exceptionable/version.rb

@@ -1,3 +1,3 @@
 module Log4rExceptionable
-  VERSION = "0.5.2"
+  VERSION = "0.5.3"
 end

data/spec/rack_failure_handler_spec.rb

@@ -10,6 +10,12 @@ describe Log4rExceptionable::RackFailureHandler do
     def logger
       self.class.logger
     end
+    def controller_name
+      "foo"
+    end
+    def action_name
+      "bar"
+    end
   end
   
   class TestApp
@@ -65,10 +71,9 @@ describe Log4rExceptionable::RackFailureHandler do
     
     it "triggers failure handler" do
       Log4r::Logger['racklogger'].should_receive(:error) do |msg|
-        msg.should =~ /^RuntimeError: I failed/
-        msg.should =~ /rack_failure_handler_spec.rb/
-        Log4r::MDC.get('rack_exception_line').should =~ /\d+/
-        Log4r::MDC.get('rack_exception_file').should =~ /rack_failure_handler_spec.rb/
+        msg.should be_instance_of RuntimeError
+        msg.message.should == "I failed"
+        msg.backtrace.first.should =~ /rack_failure_handler_spec.rb/
         Log4r::MDC.get('rack_env_PATH_INFO').should == '"/error"'
       end
       
@@ -80,7 +85,8 @@ describe Log4rExceptionable::RackFailureHandler do
     it "uses default logger if controller logger is nil" do
       
       Log4r::Logger['racklogger'].should_receive(:error) do |msg|
-        msg.should =~ /^RuntimeError: I failed/
+        msg.should be_instance_of RuntimeError
+        msg.message.should == "I failed"
       end
       
       lambda {
@@ -91,7 +97,8 @@ describe Log4rExceptionable::RackFailureHandler do
     it "uses default logger if controller logger is not log4r" do
       
       Log4r::Logger['racklogger'].should_receive(:error) do |msg|
-        msg.should =~ /^RuntimeError: I failed/
+        msg.should be_instance_of RuntimeError
+        msg.message.should == "I failed"
       end
       
       lambda {
@@ -103,7 +110,22 @@ describe Log4rExceptionable::RackFailureHandler do
       Log4r::Logger.new('ControllerLogger')
       Log4r::Logger['racklogger'].should_not_receive(:error)
       Log4r::Logger['ControllerLogger'].should_receive(:error) do |msg|
-        msg.should =~ /^RuntimeError: I failed/
+        msg.should be_instance_of RuntimeError
+        msg.message.should == "I failed"
+      end
+      
+      lambda {
+        get "/controller_logger"
+      }.should raise_error("I failed")
+    end
+    
+    it "adds controller names if set" do
+      Log4r::Logger.new('ControllerLogger')
+      Log4r::Logger['ControllerLogger'].should_receive(:error) do |msg|
+        msg.should be_instance_of RuntimeError
+        msg.message.should == "I failed"
+        Log4r::MDC.get('rack_controller_name').should == 'foo'
+        Log4r::MDC.get('rack_action_name').should == 'bar'
       end
       
       lambda {
@@ -114,7 +136,8 @@ describe Log4rExceptionable::RackFailureHandler do
     it "uses default logger if rack logger is nil" do
       
       Log4r::Logger['racklogger'].should_receive(:error) do |msg|
-        msg.should =~ /^RuntimeError: I failed/
+        msg.should be_instance_of RuntimeError
+        msg.message.should == "I failed"
       end
       
       lambda {
@@ -125,7 +148,8 @@ describe Log4rExceptionable::RackFailureHandler do
     it "uses default logger if rack logger is not log4r" do
       
       Log4r::Logger['racklogger'].should_receive(:error) do |msg|
-        msg.should =~ /^RuntimeError: I failed/
+        msg.should be_instance_of RuntimeError
+        msg.message.should == "I failed"
       end
       
       lambda {
@@ -137,7 +161,8 @@ describe Log4rExceptionable::RackFailureHandler do
       Log4r::Logger.new('RackLogger')
       Log4r::Logger['racklogger'].should_not_receive(:error)
       Log4r::Logger['RackLogger'].should_receive(:error) do |msg|
-        msg.should =~ /^RuntimeError: I failed/
+        msg.should be_instance_of RuntimeError
+        msg.message.should == "I failed"
       end
       
       lambda {

data/spec/resque_failure_handler_spec.rb

@@ -52,10 +52,9 @@ describe Log4rExceptionable::ResqueFailureHandler do
     it "triggers failure handler" do
       
       Log4r::Logger['resquelogger'].should_receive(:error) do |msg|
-        msg.should =~ /^RuntimeError: I failed/
-        msg.should =~ /resque_failure_handler_spec.rb/
-        Log4r::MDC.get('resque_exception_line').should =~ /\d+/
-        Log4r::MDC.get('resque_exception_file').should =~ /resque_failure_handler_spec.rb/
+        msg.should be_instance_of RuntimeError
+        msg.message.should == "I failed"
+        msg.backtrace.first.should =~ /resque_failure_handler_spec.rb/
         Log4r::MDC.get('resque_worker').should == ""
         Log4r::MDC.get('resque_queue').should == "somequeue"
         Log4r::MDC.get('resque_class').should == "SomeJob"
@@ -68,7 +67,8 @@ describe Log4rExceptionable::ResqueFailureHandler do
     it "uses default logger if job logger is nil" do
       
       Log4r::Logger['resquelogger'].should_receive(:error) do |msg|
-        msg.should =~ /^RuntimeError: I failed/
+        msg.should be_instance_of RuntimeError
+        msg.message.should == "I failed"
         Log4r::MDC.get('resque_class').should == "SomeJobWithNilLogger"
       end
       
@@ -78,7 +78,8 @@ describe Log4rExceptionable::ResqueFailureHandler do
     it "uses default logger if job logger is not log4r" do
       
       Log4r::Logger['resquelogger'].should_receive(:error) do |msg|
-        msg.should =~ /^RuntimeError: I failed/
+        msg.should be_instance_of RuntimeError
+        msg.message.should == "I failed"
         Log4r::MDC.get('resque_class').should == "SomeJobWithOtherLogger"
       end
       
@@ -89,7 +90,8 @@ describe Log4rExceptionable::ResqueFailureHandler do
       Log4r::Logger.new('SomeJobWithLogger')
       Log4r::Logger['resquelogger'].should_not_receive(:error)
       Log4r::Logger['SomeJobWithLogger'].should_receive(:error) do |msg|
-        msg.should =~ /^RuntimeError: I failed/
+        msg.should be_instance_of RuntimeError
+        msg.message.should == "I failed"
         Log4r::MDC.get('resque_class').should == "SomeJobWithLogger"
       end
       

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: log4r-exceptionable
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
   prerelease: 
 platform: ruby
 authors: