oboe 2.7.14.1 → 2.7.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 223f062171770328cbd42cc3347d93ae0b5b9088
-  data.tar.gz: c15ceddbbc662bac762922b63dac89b15d4d5a20
+  metadata.gz: bc92deb9ac321f19e9d9c09e7e0e006ac5be7a33
+  data.tar.gz: 96ad4b07102f381248d58cf5b16fab898d46a047
 SHA512:
-  metadata.gz: ae67053a2e222c1fedfb57592e21df2be3a66a53e0cdf532dc016b76d1e0e357c3a34d34196d3ce07808050fc4aef6c653f313478e10a0fb84505322dd4bbb1a
-  data.tar.gz: e1a440f866617c1c8d08990f3346f0100b8dbd2b03ec009e05be818d5c8c50dbf3e475cc8dc20f20559aca5d2513c4ceabb038d12b06bb5dfe2059000b07af6d
+  metadata.gz: ea591933e96debfd29440da09423b0be74efc130227f6c71c0582844711f6b0c063eb5087dfd38cfd68454acb7fbd2f072e4cb5d22b6cb8a6918e82fdc71a72b
+  data.tar.gz: 8be66d49b04094778610d503b62eb0555fcb44321440a6542956b234b11f21fca5fbc6cf7e3ff449dbaee7e6991cac8a9361ce12985e0d9e4ddd0abe2b6f5847

data/CHANGELOG.md

@@ -4,6 +4,17 @@ https://github.com/appneta/oboe-ruby/releases
 
 Dates in this file are in the format MM/DD/YYYY.
 
+# oboe 2.7.15.1
+
+This patch release includes:
+
+* Rails Instrumentation should respect top-level rescue handlers: #111
+
+Pushed to Rubygems:
+
+https://rubygems.org/gems/oboe/versions/2.7.15.1
+https://rubygems.org/gems/oboe/versions/2.7.15/1-java
+
 # oboe 2.7.14.1
 
 This patch release includes:

data/lib/oboe/config.rb

@@ -101,6 +101,12 @@ module Oboe
       @@config[:dnt_regexp] = "\.(jpg|jpeg|gif|png|ico|css|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|js|flv|swf|ttf|woff|svg|less)$"
       @@config[:dnt_opts]   = Regexp::IGNORECASE
 
+      # In Rails, raised exceptions with rescue handlers via
+      # <tt>rescue_from</tt> are not reported to the TraceView
+      # dashboard by default.  Setting this value to true will
+      # report all raised exception regardless.
+      @@config[:report_rescued_errors] = false
+
       if ENV.key?('OPENSHIFT_TRACEVIEW_TLYZER_IP')
         # We're running on OpenShift
         @@config[:tracing_mode] = 'always'

data/lib/oboe/frameworks/rails/inst/action_controller.rb

@@ -3,7 +3,82 @@
 
 module Oboe
   module Inst
-    module Rails3ActionController
+    #
+    # RailsBase
+    #
+    # This module contains the instrumentation code common to
+    # many Rails versions.
+    #
+    module RailsBase
+      #
+      # has_handler?
+      #
+      # Determins if <tt>exception</tt> has a registered
+      # handler via <tt>rescue_from</tt>
+      #
+      def has_handler?(exception)
+        # Don't log exceptions if they have a rescue handler set
+        has_handler = false
+        rescue_handlers.detect { | klass_name, handler |
+          # Rescue handlers can be specified as strings or constant names
+          klass = self.class.const_get(klass_name) rescue nil
+          klass ||= klass_name.constantize rescue nil
+          has_handler = exception.is_a?(klass) if klass
+        }
+        has_handler
+      rescue => e
+        Oboe.logger.debug "[oboe/debug] Error searching Rails handlers: #{e.message}"
+        return false
+      end
+
+      #
+      # log_rails_error?
+      #
+      # Determins whether we should log a raised exception to the
+      # TraceView dashboard.  This is determined by whether the exception
+      # has a rescue handler setup and the value of
+      # Oboe::Config[:report_rescued_errors]
+      #
+      def log_rails_error?(exception)
+        # As it's perculating up through the layers...  make sure that
+        # we only report it once.
+        return false if exception.instance_variable_get(:@oboe_logged)
+
+        has_handler = has_handler?(exception)
+
+        if !has_handler || (has_handler && Oboe::Config[:report_rescued_errors])
+          return true
+        end
+        false
+      end
+
+      #
+      # render_with_oboe
+      #
+      # Our render wrapper that just times and conditionally
+      # reports raised exceptions
+      #
+      def render_with_oboe(*args)
+        Oboe::API.log_entry('actionview')
+        render_without_oboe(*args)
+
+      rescue Exception => e
+        Oboe::API.log_exception(nil, e) if log_rails_error?(e)
+        raise
+      ensure
+        Oboe::API.log_exit('actionview')
+      end
+    end
+
+    #
+    # ActionController3
+    #
+    # This modules contains the instrumentation code specific
+    # to Rails v3
+    #
+    module ActionController3
+      include ::Oboe::Inst::RailsBase
+
       def self.included(base)
         base.class_eval do
           alias_method_chain :process, :oboe
@@ -13,9 +88,14 @@ module Oboe
       end
 
       def process_with_oboe(*args)
-        Oboe::API.trace('rails', {}) do
-          process_without_oboe *args
-        end
+        Oboe::API.log_entry('rails')
+        process_without_oboe *args
+
+      rescue Exception => e
+        Oboe::API.log_exception(nil, e) if log_rails_error?(e)
+        raise
+      ensure
+        Oboe::API.log_exit('rails')
       end
 
       def process_action_with_oboe(*args)
@@ -31,15 +111,17 @@ module Oboe
         Oboe::API.log(nil, 'info', report_kvs)
         raise
       end
-
-      def render_with_oboe(*args)
-        Oboe::API.trace('actionview', {}) do
-          render_without_oboe *args
-        end
-      end
     end
 
-    module Rails4ActionController
+    #
+    # ActionController4
+    #
+    # This modules contains the instrumentation code specific
+    # to Rails v4
+    #
+    module ActionController4
+      include ::Oboe::Inst::RailsBase
+
       def self.included(base)
         base.class_eval do
           alias_method_chain :process_action, :oboe
@@ -55,15 +137,15 @@ module Oboe
           :Controller   => self.class.name,
           :Action       => self.action_name,
         }
-        Oboe::API.trace('rails', report_kvs) do
-          process_action_without_oboe(method_name, *args)
-        end
-      end
 
-      def render_with_oboe(*args)
-        Oboe::API.trace('actionview', {}) do
-          render_without_oboe(*args)
-        end
+        Oboe::API.log_entry('rails')
+        process_action_without_oboe(method_name, *args)
+
+      rescue Exception => e
+        Oboe::API.log_exception(nil, e) if log_rails_error?(e)
+        raise
+      ensure
+        Oboe::API.log_exit('rails')
       end
     end
   end
@@ -73,27 +155,34 @@ if defined?(ActionController::Base) && Oboe::Config[:action_controller][:enabled
   if ::Rails::VERSION::MAJOR == 4
 
     class ActionController::Base
-      include Oboe::Inst::Rails4ActionController
+      include Oboe::Inst::ActionController4
     end
 
   elsif ::Rails::VERSION::MAJOR == 3
 
     class ActionController::Base
-      include Oboe::Inst::Rails3ActionController
+      include Oboe::Inst::ActionController3
     end
 
   elsif ::Rails::VERSION::MAJOR == 2
 
     ActionController::Base.class_eval do
+      include ::Oboe::Inst::RailsBase
+
       alias :perform_action_without_oboe :perform_action
       alias :rescue_action_without_oboe :rescue_action
       alias :process_without_oboe :process
       alias :render_without_oboe :render
 
       def process(*args)
-        Oboe::API.trace('rails', {}) do
-          process_without_oboe(*args)
-        end
+        Oboe::API.log_entry('rails')
+        process_without_oboe(*args)
+
+      rescue Exception => e
+        Oboe::API.log_exception(nil, e) if log_rails_error?(e)
+        raise
+      ensure
+        Oboe::API.log_exit('rails')
       end
 
       def perform_action(*arguments)
@@ -106,14 +195,19 @@ if defined?(ActionController::Base) && Oboe::Config[:action_controller][:enabled
       end
 
       def rescue_action(exn)
-        Oboe::API.log_exception(nil, exn)
+        Oboe::API.log_exception(nil, exn) if log_rails_error?(exn)
         rescue_action_without_oboe(exn)
       end
 
       def render(options = nil, extra_options = {}, &block)
-        Oboe::API.trace('actionview', {}) do
-          render_without_oboe(options, extra_options, &block)
-        end
+        Oboe::API.log_entry('actionview')
+        render_without_oboe(options, extra_options, &block)
+
+      rescue Exception => e
+        Oboe::API.log_exception(nil, e) if log_rails_error?(e)
+        raise
+      ensure
+        Oboe::API.log_exit('actionview')
       end
     end
   end

data/lib/oboe/version.rb

@@ -8,7 +8,7 @@ module Oboe
   module Version
     MAJOR = 2
     MINOR = 7
-    PATCH = 14
+    PATCH = 15
     BUILD = 1
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/lib/rails/generators/oboe/templates/oboe_initializer.rb

@@ -21,20 +21,6 @@ if defined?(Oboe::Config)
   # Verbose output of instrumentation initialization
   # Oboe::Config[:verbose] = <%= @verbose %>
 
-  #
-  # Resque Options
-  #
-  # :link_workers - associates Resque enqueue operations with the jobs they queue by piggybacking
-  #                 an additional argument on the Redis queue that is stripped prior to job
-  #                 processing
-  #                 !!! Note: Make sure both the enqueue side and the Resque workers are instrumented
-  #                 before enabling this or jobs will fail !!!
-  #                 (Default: false)
-  # Oboe::Config[:resque][:link_workers] = false
-  #
-  # Set to true to disable Resque argument logging (Default: false)
-  # Oboe::Config[:resque][:log_args] = false
-
   # The oboe Ruby client has the ability to sanitize query literals
   # from SQL statements.  By default this is disabled.  Enable to
   # avoid collecting and reporting query literals to TraceView.
@@ -68,6 +54,17 @@ if defined?(Oboe::Config)
   # Oboe::Config[:dnt_regexp] = "\.(jpg|jpeg|gif|png|ico|css|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|js|flv|swf|ttf|woff|svg|less)$"
   # Oboe::Config[:dnt_opts]   = Regexp::IGNORECASE
 
+  #
+  # Rails Exception Logging
+  #
+  # In Rails, raised exceptions with rescue handlers via
+  # <tt>rescue_from</tt> are not reported to the TraceView
+  # dashboard by default.  Setting this value to true will
+  # report all raised exception regardless.
+  #
+  # Oboe::Config[:report_rescued_errors] = false
+  #
+
   #
   # Enabling/Disabling Instrumentation
   #
@@ -80,6 +77,7 @@ if defined?(Oboe::Config)
   # Oboe::Config[:action_view][:enabled] = true
   # Oboe::Config[:cassandra][:enabled] = true
   # Oboe::Config[:dalli][:enabled] = true
+  # Oboe::Config[:em_http_request][:enabled] = true
   # Oboe::Config[:faraday][:enabled] = true
   # Oboe::Config[:memcache][:enabled] = true
   # Oboe::Config[:memcached][:enabled] = true
@@ -88,7 +86,9 @@ if defined?(Oboe::Config)
   # Oboe::Config[:nethttp][:enabled] = true
   # Oboe::Config[:redis][:enabled] = true
   # Oboe::Config[:resque][:enabled] = true
-  # Oboe::Config[:em_http_request][:enabled] = true
+  # Oboe::Config[:sequel][:enabled] = true
+  # Oboe::Config[:typhoeus][:enabled] = true
+  #
 
   #
   # Enabling/Disabling Backtrace Collection
@@ -103,6 +103,7 @@ if defined?(Oboe::Config)
   # Oboe::Config[:action_view][:collect_backtraces] = true
   # Oboe::Config[:cassandra][:collect_backtraces] = true
   # Oboe::Config[:dalli][:collect_backtraces] = false
+  # Oboe::Config[:em_http_request][:collect_backtraces] = true
   # Oboe::Config[:faraday][:collect_backtraces] = false
   # Oboe::Config[:memcache][:collect_backtraces] = false
   # Oboe::Config[:memcached][:collect_backtraces] = false
@@ -111,7 +112,8 @@ if defined?(Oboe::Config)
   # Oboe::Config[:nethttp][:collect_backtraces] = true
   # Oboe::Config[:redis][:collect_backtraces] = false
   # Oboe::Config[:resque][:collect_backtraces] = true
-  # Oboe::Config[:em_http_request][:collect_backtraces] = true
+  # Oboe::Config[:sequel][:collect_backtraces] = true
+  # Oboe::Config[:typhoeus][:collect_backtraces] = false
   #
 
   #
@@ -123,4 +125,17 @@ if defined?(Oboe::Config)
   #     'index#ok' => true
   # }
 
+  #
+  # Resque Options
+  #
+  # :link_workers - associates Resque enqueue operations with the jobs they queue by piggybacking
+  #                 an additional argument on the Redis queue that is stripped prior to job
+  #                 processing
+  #                 !!! Note: Make sure both the enqueue side and the Resque workers are instrumented
+  #                 before enabling this or jobs will fail !!!
+  #                 (Default: false)
+  # Oboe::Config[:resque][:link_workers] = false
+  #
+  # Set to true to disable Resque argument logging (Default: false)
+  # Oboe::Config[:resque][:log_args] = false
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oboe
 version: !ruby/object:Gem::Version
-  version: 2.7.14.1
+  version: 2.7.15.1
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-21 00:00:00.000000000 Z
+date: 2015-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json