right_support 2.11.3 → 2.12.1

data/lib/right_support/notifiers/blacklisters.rb

@@ -0,0 +1,34 @@
+#
+# Copyright (c) 2016 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module RightSupport
+  module Notifier
+    module Blacklister
+      autoload :Base, 'right_support/notifiers/blacklisters/base'
+      autoload :Canonical, 'right_support/notifiers/blacklisters/canonical'
+      autoload :RegularExpression, 'right_support/notifiers/blacklisters/regular_expression'
+      autoload :Simple, 'right_support/notifiers/blacklisters/simple'
+      autoload :SnakeCase, 'right_support/notifiers/blacklisters/snake_case'
+      autoload :Wildcard, 'right_support/notifiers/blacklisters/wildcard'
+    end
+  end
+end

data/lib/right_support/notifiers/logger.rb

@@ -0,0 +1,94 @@
+#
+# Copyright (c) 2016 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'airbrake-ruby'
+
+class RightSupport::Notifier::Logger < RightSupport::Notifier::Base
+
+  # arbitrary upper bound on payload dumped to log output.
+  MAX_PAYLOAD = 4096
+
+  def notify(notification)
+    # payload is usually not logged unless DEBUG_MODE=true but for consistency
+   	# we will always include it in the log with the error message.
+    #
+    # note that there is no payload blacklisting as access to view the logs in
+    # production is already restricted. what is most important about
+    # blacklisting data is that it not reach the less secure error notification
+    # services where it is stored permanently.
+    payload = notification.payload
+    if payload.empty?
+      payload = nil
+    else
+      payload = payload.inspect[0, MAX_PAYLOAD]
+    end
+
+    # we are interested in the root cause for logging purposes except when
+    # DEBUG_MODE==true, in which case iterate over all causes without the limit
+    # on backtrace size.
+    if debug_mode?
+      backtrace_decoder.walk_error(notification.error, raw_trace: true) do |cause|
+        log_error(notification, cause, cause.backtrace, payload)
+        payload = nil  # do not repeat payload
+      end
+    else
+      cause, frames = backtrace_decoder.walk_error(notification.error)
+      log_error(notification, cause, frames, payload)
+    end
+    true
+  rescue ::Exception => e
+    lines = [e.class.name, e.message, e.backtrace].flatten.compact
+    msg = "Failed to notify: #{lines.join("\n")}"
+    logger.error(msg)
+    true
+  end
+
+  private
+
+  def log_error(notification, cause, trace_or_frames, payload)
+    lines = []
+    lines << "[%s] Error in %s#%s" % [
+      notification.error_token,
+      notification.component,
+      notification.action
+    ]
+    lines << ''
+    lines << "Error: %s %s" % [cause.class.name, cause.message]
+    lines << ''
+    if (trace_or_frames || []).empty?
+      lines << 'Missing backtrace.'
+    else
+      lines << 'Dump:'
+      if trace_or_frames.first.is_a?(::String)
+        lines += trace_or_frames.map { |t| "  #{t}" }
+      else
+        lines << ::RightSupport::Notifier::Utility::BacktraceDecoder.format_frames(trace_or_frames)
+      end
+    end
+    if payload
+      lines << ''
+      lines << "Payload: #{payload}"
+    end
+    logger.error(lines.join("\n"))
+  end
+
+end  # RightSupport::Notifier::Logger

data/lib/right_support/notifiers/notification.rb

@@ -0,0 +1,57 @@
+#
+# Copyright (c) 2016 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# definition for a notification to be sent to notifiers.
+class RightSupport::Notifier::Notification
+
+  attr_reader :error, :error_token, :env, :payload, :global_session
+  attr_reader :component, :action
+
+  # @param [Exception] error leading to notification
+  # @param [Hash] options
+  # @option options [String] :error_token or nil to generate a new token
+  # @option options [Hash] :env from Rack or nil or empty
+  # @option options [Hash] :global_session or nil or empty
+  # @option options [String] :component as optional name of component (the
+  #  controller name, etc.). default='unknown'.
+  # @option options [String] :action as optional name of action (the controller
+  #  method invoked by request URI, etc.). default='unknown'.
+  def initialize(error, options = {})
+    options = {
+      error_token: nil,
+      env: nil,
+      payload: nil,
+      global_session: nil,
+      component: 'unknown',
+      action: 'unknown',
+    }.merge(options)
+
+    @error = error
+    @error_token = (options[:error_token] || ::RightSupport::Data::Token.generate).to_s
+    @env = (options[:env] || {}).to_hash
+    @payload = (options[:payload] || {}).to_hash
+    @global_session = (options[:global_session] || {}).to_hash
+    @component = options[:component].to_s
+    @action = options[:action].to_s
+  end
+
+end

data/lib/right_support/notifiers/utilities/backtrace_decoder.rb

@@ -0,0 +1,234 @@
+#
+# Copyright (c) 2016 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# decoder for ruby-formatted backtraces.
+class RightSupport::Notifier::Utility::BacktraceDecoder
+
+  # default limit on size of decoded stack trace arrays.
+ 	DEFAULT_BACKTRACE_LIMIT = 10
+
+ 	# hard limit on size of decoded stack trace arrays.
+ 	MAX_BACKTRACE_LIMIT = 255
+
+  # limit on error walk when following cause chain.
+  WALK_LIMIT = 32
+
+  # regular expression used to decode a line of ruby backtrace.
+  BACKTRACE_REGEXP = /^(.*):(\d+)?:in `(.*)'$/
+
+  # ellipsis used for limited trace.
+  ELLIPSIS = '...'.freeze
+
+  attr_reader :backtrace_offset, :backtrace_limit, :path_blacklist, :root_path
+
+  class Frame
+    attr_reader :file, :line, :function
+
+    def initialize(file, line, function)
+      @file = file
+      @line = line
+      @function = function
+    end
+
+    def to_s
+      # the following encoded format is the ruby style (strange quotes, etc.)
+      "#{@file}:#{@line}:in `#{@function}'"
+    end
+  end
+
+  # @param [Hash] options
+  # @option options [Integer] :backtrace_offset as number of stack frames to
+  #  skip initially. default = 0.
+  # @option options [Integer] :backtrace_limit as maximum number of stack frames
+  #  to decode or negative for all. default = 10.
+  # @option options [String|Array] :path_blacklist for unwanted paths in
+  #  backtrace. the blacklisted path substring causes the frame to be omitted
+  #  when it appears anywhere in the traced path. default = none.
+  # @option options [String] :root_path for application to be removed from
+  #  decoded file paths. default = <working directory>
+  def initialize(options = {})
+    options = {
+      backtrace_offset: 0,
+      backtrace_limit: DEFAULT_BACKTRACE_LIMIT,
+      path_blacklist: nil
+    }.merge(options)
+    @backtrace_offset = Integer(options[:backtrace_offset])
+    @backtrace_limit = Integer(options[:backtrace_limit])
+    if @backtrace_limit < 0 || @backtrace_limit > MAX_BACKTRACE_LIMIT
+      @backtrace_limit = MAX_BACKTRACE_LIMIT
+    end
+    @path_blacklist = Array(options[:path_blacklist])
+
+    # resolve current application root path.
+    @root_path = ::File.expand_path(options[:root_path] || ::Dir.pwd) + '/'
+    @root_parent_path = ::File.dirname(@root_path) + '/'
+
+    # resolve current 'lib/ruby' path.
+    @ruby_lib_path = ::File.expand_path(::RbConfig::CONFIG['rubylibprefix']) + '/'
+    @ruby_lib_parent_path = ::File.dirname(@ruby_lib_path) + '/'
+  end
+
+  # decodes lines of backtrace in string form into their component parts.
+  #
+  # borrowed originally from:
+  # @see https://github.com/airbrake/airbrake-ruby/blob/master/lib/airbrake-ruby/backtrace.rb
+  #
+  # @param [Array] trace from error.backtrace or Kernel.caller or empty or nil
+  #
+  # @return [Array] frames of decoded trace or empty
+  def decode(trace)
+    frames = []
+    trace ||= []
+    trace = trace[@backtrace_offset..-1] if @backtrace_offset > 0
+    gems_finder = '/gems/'
+    seen_root_path = false
+    trace.each do |t|
+      has_root_path = false
+      omit = false
+      file = nil
+      line = 0
+      function = nil
+      if m = BACKTRACE_REGEXP.match(t)
+        file = m[1]
+        line = Integer(m[2])
+        function = m[3]
+        @path_blacklist.each do |pbl|
+          if file.include?(pbl)
+            omit = true
+            break
+          end
+        end
+        unless omit
+          # remove base path from the frame file path for simplicity and because
+          # the absolute root path is only meaningful on the file system where
+          # the code is running. the root path basename (i.e. the application
+          # directory name) is kept for display.
+          if file.start_with?(@root_path)
+            file = file[@root_parent_path.length..-1]
+            has_root_path = true
+          elsif file.start_with?(@ruby_lib_path)
+            # remove absoluteness of the lib/ruby path for the same reason.
+            file = file[@ruby_lib_parent_path.length..-1]
+          end
+
+          # remove everything before '/gems/' on the assumption that the
+          # rubygems or '/vendor/bundle/.../gems/' prefixes are only noise that
+          # makes the trace harder to read for a human. '/gems/' may also appear
+          # more than once so use the last found.
+          if gems_offset = file.rindex(gems_finder)
+            file = file[gems_offset + gems_finder.length..-1]
+          end
+        end
+      else
+        # show a failure message for other patterns such as java plugins for
+        # ruby and nonsense only because we have no known use cases.
+        # FIX: support any needed patterns.
+        file = t
+        function = '<< trace decoder error >>'
+      end
+      unless omit
+        # enforce the backtrace limit when configured *unless* we have not yet
+        # seen the root path (i.e. the application root). in this case we want
+        # to keep walking the backtrace until we have shown at least one frame
+        # that references the application. otherwise the backtrace may not be
+        # useful for debugging purposes.
+        done = seen_root_path && @backtrace_limit >= 0 && frames.size >= @backtrace_limit
+
+        # show at least one full application frame before appending ellipsis.
+        seen_root_path ||= has_root_path
+
+        # set an ellipsis as function name of last frame when over limit.
+        frames << Frame.new(file, line, done ? ELLIPSIS : function)
+        break if done
+      end
+    end
+    frames
+  end
+
+  # @return [Array] the current frames for the caller with limit, filters, etc.
+  def caller
+    # note that Kernel.caller always omits the immediate frame so that the
+    # caller of this method is at the top of the trace.
+    decode(::Kernel.caller)
+  end
+
+  # walks the error to find the backtrace closest to the root cause.
+  #
+  # @param [Exception] error to walk
+  # @param [Hash] options
+  # @option options [TrueClass|FalseClass] :raw_trace true to return the raw
+  #  backtrace that was closest to cause, false to decode it (default).
+  #
+  # borrowed originally from:
+  # @see "https://github.com/airbrake/airbrake-ruby/blob/master/lib/airbrake-ruby/nested_exception.rb"
+  #
+  # @yield [cause] yields each walked error without decoding its backtrace.
+  # @yieldparam [Exception] error in cause chain that is currently being walked.
+  #
+  # @return [Array] tuple of [cause, trace_or_frames]
+  def walk_error(error, options={}, &callback)
+    options = {
+      raw_trace: false
+    }.merge(options)
+    cause = error
+    trace = cause.backtrace || ::Kernel.caller[1..-1]
+    callback.call(cause) if callback
+    counter = 0
+    while cause.respond_to?(:cause)
+      next_cause = cause.cause
+      if next_cause && next_cause != cause
+        cause = next_cause
+        callback.call(cause) if callback
+        trace = cause.backtrace if cause.backtrace
+
+        # sanity check that the error is wrapped an unbelievable number of
+        # times or that the cause != next_cause logic has failed somehow; no
+        # infinite loops.
+        counter += 1
+        break if counter >= WALK_LIMIT
+      else
+        break
+      end
+    end
+    unless options[:raw_trace]
+      trace = decode(trace)
+    end
+    [cause, trace]
+  end
+
+  # formats the given frames for display on the console.
+  #
+  # @param [Array] frames to format
+  #
+  # @return [String] formatted frames
+  def self.format_frames(frames)
+    frames.map do |frame|
+      if frame.function == ELLIPSIS
+        line = ELLIPSIS
+      else
+        line = frame
+      end
+      "  #{line}"  # indent and .to_s
+    end.join("\n")
+  end
+
+end  # RightSupport::Notifier::Utility::BacktraceDecoder

data/lib/right_support/notifiers/utilities.rb

@@ -0,0 +1,29 @@
+#
+# Copyright (c) 2016 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module RightSupport
+  module Notifier
+    module Utility
+      autoload :BacktraceDecoder, 'right_support/notifiers/utilities/backtrace_decoder'
+    end
+  end
+end

data/lib/right_support/notifiers.rb

@@ -0,0 +1,32 @@
+#
+# Copyright (c) 2016 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module RightSupport
+  module Notifier
+    autoload :Airbrake, 'right_support/notifiers/airbrake'
+    autoload :Base, 'right_support/notifiers/base'
+    autoload :Blacklister, 'right_support/notifiers/blacklisters'
+    autoload :Logger, 'right_support/notifiers/logger'
+    autoload :Notification, 'right_support/notifiers/notification'
+    autoload :Utility, 'right_support/notifiers/utilities'
+  end
+end

data/lib/right_support/rack/request_logger.rb

@@ -35,8 +35,8 @@ module RightSupport::Rack
   # with Rack::Logger or another middleware that provides logging services.
   class RequestLogger
 
-    # limit exception backtrace length; usually only the first few lines are
-    # significant. the same error dumped repeatedly can make grepping difficult.
+    # default backtrace limit that can be overridden by configuring the
+    # middleware with a specific :backtrace_limit value.
     BACKTRACE_LIMIT = 10
 
     # for debug-mode only logging. debug-mode can also be enabled by the
@@ -79,6 +79,8 @@ module RightSupport::Rack
     #  override the usual global session behavior of always responding with a
     #  'Set-Cookie' header regardless of status code. defaults to having the
     #  same value as the :normalize_40x option.
+    # @option options [Integer] :backtrace_limit maximum number of stack frames
+    #  to display on error or negative for all (default = 10)
     def initialize(app, options = {})
       @app = app
       @only = options[:only] || []
@@ -89,6 +91,8 @@ module RightSupport::Rack
       @normalize_40x = !!options[:normalize_40x]
       @normalize_40x_set_cookie = options[:normalize_40x_set_cookie]
       @normalize_40x_set_cookie = @normalize_40x if @normalize_40x_set_cookie.nil?
+      @backtrace_decoder = ::RightSupport::Notifier::Utility::BacktraceDecoder.new(
+        backtrace_limit: Integer(options[:backtrace_limit] || BACKTRACE_LIMIT))
     end
 
     # Add a logger to the Rack environment and call the next middleware.
@@ -224,18 +228,18 @@ module RightSupport::Rack
     # Formats a concise error message with limited backtrace, etc.
     #
     # @param [Exception] e to format
+    # @param [Exception] e to format
     #
     # @return [String] formatted error
-    def self.format_exception_message(e)
-      trace = e.backtrace || []
-      if trace.size > BACKTRACE_LIMIT
-        trace = trace[0, BACKTRACE_LIMIT] << '...'
-      end
+    def self.format_exception_message(e, backtrace_decoder = nil)
+      backtrace_decoder ||= ::RightSupport::Notifier::Utility::BacktraceDecoder.new
+      trace = ::RightSupport::Notifier::Utility::BacktraceDecoder.format_frames(
+        backtrace_decoder.decode(e.backtrace))
       kind = e.class.name
       if (msg = e.message) && !msg.empty? && msg != kind
         kind = "#{kind}: #{msg}"
       end
-      [kind, *trace].join("\n")
+      [kind, trace].join("\n")
     end
 
     # @return [String] accepted/generated request UUID or else 'missing' to
@@ -380,7 +384,7 @@ module RightSupport::Rack
     #
     # @return [TrueClass] always true
     def log_exception(logger, e)
-      logger.error(self.class.format_exception_message(e))
+      logger.error(self.class.format_exception_message(e, @backtrace_decoder))
     rescue
       # no-op; something is seriously messed up by this point...
     end

data/lib/right_support.rb

@@ -15,4 +15,5 @@ module RightSupport
   autoload :Stats, 'right_support/stats'
   autoload :CI, 'right_support/ci'
   autoload :Deployment, 'right_support/deployment'
+  autoload :Notifier, 'right_support/notifiers'
 end