failbot 2.4.2 → 2.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53e182bf0325cad972095bfc874140de2c28b0b771070719e7aff54fb02d8fae
-  data.tar.gz: 8da6d5c26fcfe301e0df2edf096e2afa0e19f40e5941ae5b03e084d8435cfab0
+  metadata.gz: 1bae1044f6d88c6617750ffe63b606591880ebe5132d9714d2e4c9534e309962
+  data.tar.gz: b1d80185dae5e664c049ed38583d25086d3659f517826c38912974d93fed32a6
 SHA512:
-  metadata.gz: 04c21e6c698b040686e522ebe442c04b03a31c4875e904395f4e312e07cc1741e31b59f7eca22dd5475fd32a8a867c0537306f5fbf36ef44870b5337f62ef31e
-  data.tar.gz: e13a7e8a016abddc60e5f071cc4b46d73f3f4e42e575bd123999d68dafdfcd7b42ec1ce2e52dfa0c4a8032b5acfbfaaaf93d6dd43efaf201ab1ad30ad085bd78
+  metadata.gz: 8114032ca98920f4b902447d1b3c69b28ea6bfe14b52d8b1f431d0537295d5c565d9d8a17540afa72f00f439023bc711291542baa2044ada4cd6f547e9506c35
+  data.tar.gz: f0040811958da514da048dd38af5de2cfd3978d6f036dc78c19b6080991b02bf69cca5b79f684ecc3a8c5b3885b577ecf77116fca445439f7ecfa06fbe5a3452

data/lib/failbot.rb

@@ -3,6 +3,7 @@ require 'digest/md5'
 require 'logger'
 require 'socket'
 require "time"
+require "timeout"
 require "date"
 require "uri"
 
@@ -11,6 +12,7 @@ require "failbot/compat"
 require "failbot/sensitive_data_scrubber"
 require "failbot/exception_format/haystack"
 require "failbot/exception_format/structured"
+require "failbot/default_backtrace_parser"
 
 # Failbot asynchronously takes exceptions and reports them to the
 # exception logger du jour. Keeps the main app from failing or lagging if
@@ -24,6 +26,7 @@ module Failbot
   autoload :HTTPBackend,    'failbot/http_backend'
   autoload :MemoryBackend,  'failbot/memory_backend'
   autoload :JSONBackend,    'failbot/json_backend'
+  autoload :WaiterBackend,  'failbot/waiter_backend'
 
   # Public: Set an instrumenter to be called when exceptions are reported.
   #
@@ -66,6 +69,11 @@ module Failbot
 
   EXCEPTION_DETAIL = 'exception_detail'
 
+  # We'll include this many nested Exception#cause objects in the needle
+  # context. We limit the number of objects to prevent excessive recursion and
+  # large needle contexts.
+  MAXIMUM_CAUSE_DEPTH = 2
+
   # Enumerates the available exception formats this gem supports.  The original
   # format and the default is :haystack and the newer format is :structured
   EXCEPTION_FORMATS = {
@@ -84,6 +92,27 @@ module Failbot
   # apps opt in to the newer version.
   self.exception_format = :haystack
 
+  # Set a callable that is responsible for parsing and formatting ruby
+  # backtraces.  This is only necessary to set if your app deals with
+  # exceptions that are manipulated to contain something other than actual
+  # stackframe strings in the format produced by `caller`.  The argument passed
+  # must respond to `call` with an arity of 1.  The callable expects to be
+  # passed Exception instances as its argument.
+  def self.backtrace_parser=(callable)
+    unless callable.respond_to?(:call)
+      raise ArgumentError, "backtrace_parser= passed #{callable.inspect}, which is not callable"
+    end
+    if callable.method(:call).arity != 1
+      raise ArgumentError, "backtrace_parser= passed #{callable.inspect}, whose `#call` has arity =! 1"
+    end
+    @backtrace_parser = callable
+  end
+
+  attr_reader :backtrace_parser
+
+  # Default backtrace parser is provided:
+  self.backtrace_parser = ::Failbot::DefaultBacktraceParser
+
   # Helpers needed to parse hashes included in e.g. Failbot.reports.
   def self.exception_message_from_hash(hash)
     @exception_formatter.exception_message_from_hash(hash)
@@ -118,6 +147,8 @@ module Failbot
       case (name = settings["FAILBOT_BACKEND"])
       when "memory"
         Failbot::MemoryBackend.new
+      when "waiter"
+        Failbot::WaiterBackend.new
       when "file"
         Failbot::FileBackend.new(settings["FAILBOT_BACKEND_FILE_PATH"])
       when "http"
@@ -132,6 +163,11 @@ module Failbot
 
     @raise_errors  = !settings["FAILBOT_RAISE"].to_s.empty?
     @report_errors = settings["FAILBOT_REPORT"] != "0"
+    @enable_timeout = false
+    if settings.key?("FAILBOT_TIMEOUT_MS")
+      @timeout_seconds = settings["FAILBOT_TIMEOUT_MS"].to_f / 1000
+      @enable_timeout = (@timeout_seconds != 0.0)
+    end
 
     # allows overriding the 'app' value to send to single haystack bucket.
     # used primarily on ghe.io.
@@ -307,17 +343,31 @@ module Failbot
       end
 
       data = scrub(sanitize(data))
+    rescue Object => i
+      log_failure("processing", data, e, i)
+      self.already_reporting = false
+      return
+    end
 
-      backend.report(data)
-      instrument("report.failbot", data)
+    start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    instrumentation_data = {
+      "report_status" => "error",
+    }
+    begin
+      if @enable_timeout
+        Timeout.timeout(@timeout_seconds) do
+          backend.report(data)
+        end
+      else
+        backend.report(data)
+      end
+      instrumentation_data["report_status"] = "success"
     rescue Object => i
-      # don't fail for any reason
-      logger.debug "FAILBOT: #{data.inspect}" rescue nil
-      logger.debug e.message rescue nil
-      logger.debug e.backtrace.join("\n") rescue nil
-      logger.debug i.message rescue nil
-      logger.debug i.backtrace.join("\n") rescue nil
+      log_failure("reporting", data, e, i)
+      instrumentation_data["exception_type"] = i.class.name
     ensure
+      instrumentation_data["elapsed_ms"] = ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time) * 1000).to_i
+      instrument("report.failbot", data.merge(instrumentation_data)) rescue nil
       self.already_reporting = false
     end
   end
@@ -463,6 +513,15 @@ module Failbot
     end
   end
 
+  def log_failure(action, data, original_exception, exception)
+    # don't fail for any reason
+    logger.debug "FAILBOT EXCEPTION: action=#{action} exception=#{exception.class.name} original_type: #{original_exception.class.name} data=#{data.inspect}" rescue nil
+    logger.debug original_exception.message rescue nil
+    logger.debug original_exception.backtrace.join("\n") rescue nil
+    logger.debug exception.message rescue nil
+    logger.debug exception.backtrace.join("\n") rescue nil
+  end
+
   extend self
 
   # If the library was lazy loaded due to failbot/exit_hook.rb and a delayed

data/lib/failbot/default_backtrace_parser.rb

@@ -0,0 +1,23 @@
+module Failbot
+  # This is the default backtrace parser for the Structured formatter.
+  module DefaultBacktraceParser
+    EMPTY_ARRAY = [].freeze
+
+    # Takes an Exception instance, returns an array of hashes with the keys
+    # that the Structured formatter expects.
+    def self.call(exception)
+      if exception.backtrace
+        Backtrace.parse(exception.backtrace).frames.reverse.map do |line|
+          {
+            "filename" => line.file_name,
+            "abs_path" => line.abs_path,
+            "lineno"   => line.line_number,
+            "function" => line.method
+          }
+        end
+      else
+        EMPTY_ARRAY
+      end
+    end
+  end
+end

data/lib/failbot/exception_format/haystack.rb

@@ -30,11 +30,6 @@ module Failbot
         hash["class"]
       end
 
-      # We'll include this many nested Exception#cause objects in the needle
-      # context. We limit the number of objects to prevent excessive recursion and
-      # large needle contexts.
-      MAXIMUM_CAUSE_DEPTH = 2
-
       # Pretty-print Exception#cause (and nested causes) for inclusion in needle
       # context
       #
@@ -59,7 +54,7 @@ module Failbot
 
         result = causes.join("\n\nCAUSED BY:\n\n")
 
-        if current.respond_to?(:cause) && current.cause
+        if current.cause
           result << "\n\nFurther #cause backtraces were omitted\n"
         end
 
@@ -72,7 +67,6 @@ module Failbot
       #
       # Returns a String.
       def self.pretty_print_one_cause(e)
-        return unless e.respond_to?(:cause)
         cause = e.cause
         return unless cause
 

data/lib/failbot/exception_format/structured.rb

@@ -13,25 +13,56 @@ module Failbot
       # Format an exception.
       def self.call(e)
         message = e.message.to_s
+        class_name = e.class.to_s
         stacktrace = begin
-          formatted_backtrace(e) || EMPTY_ARRAY
-        rescue Backtrace::ParseError
-          message += "\nUnable to parse backtrace!  Don't put non-backtrace text in Exception#backtrace please!\n#{e.backtrace}"
+          Failbot.backtrace_parser.call(e)
+        rescue => ex
+          message += "\nUnable to parse backtrace (#{ex.inspect})\nDon't put non-backtrace text in Exception#backtrace please!\nSo-called backtrace follows:\n#{e.backtrace.join("\n")}"
+          class_name += " (backtrace failed to parse)"
           EMPTY_ARRAY
         end
         {
-          "exception_detail" => [ # TODO Once supported in failbotg, this should be an array of
-            {                     # hashes generated from subsequent calls to Exception#cause.
-              "type" => e.class.to_s,
-              "value" => message,
-              "stacktrace" => stacktrace
-            }
-          ],
+          "exception_detail" => exception_details(e),
           "ruby" => RUBY_DESCRIPTION,
           "created_at" => Time.now.utc.iso8601(6)
         }
       end
 
+      FURTHER_CAUSES_WERE_OMITTED = {
+        "type" => "Notice",
+        "value" => "further Exception#cause values were omitted",
+        "stacktrace" => EMPTY_ARRAY
+      }.freeze
+
+      def self.exception_details(e)
+        result = []
+        depth = 0
+
+        loop do
+          message = e.message.to_s
+          class_name = e.class.to_s
+          stacktrace = begin
+            Failbot.backtrace_parser.call(e)
+          rescue => ex
+            message += "\nUnable to parse backtrace (#{ex.inspect})\nDon't put non-backtrace text in Exception#backtrace please!\nSo-called backtrace follows:\n#{e.backtrace.join("\n")}"
+            class_name += " (backtrace failed to parse)"
+            EMPTY_ARRAY
+          end
+          result.unshift({
+            "type" => class_name,
+            "value" => message,
+            "stacktrace" => stacktrace
+          })
+          depth += 1
+          break unless (e=e.cause)
+          if depth > MAXIMUM_CAUSE_DEPTH
+            result.unshift(FURTHER_CAUSES_WERE_OMITTED)
+            break
+          end
+        end
+        result
+      end
+
       # given a hash generated by this class, return the exception message.
       def self.exception_message_from_hash(hash)
         hash.dig("exception_detail", 0, "value")
@@ -41,19 +72,6 @@ module Failbot
       def self.exception_classname_from_hash(hash)
         hash.dig("exception_detail", 0, "type")
       end
-
-      def self.formatted_backtrace(e)
-        if e.backtrace
-          Backtrace.parse(e.backtrace).frames.reverse.map do |line|
-            {
-              "filename" => line.file_name,
-              "abs_path" => line.abs_path,
-              "lineno"   => line.line_number,
-              "function" => line.method
-            }
-          end
-        end
-      end
     end
   end
 end

data/lib/failbot/haystack.rb

@@ -52,6 +52,10 @@ module Failbot
 
       # push it through
       http.request(request)
+    ensure
+      if defined?(http) && http.started?
+        http.finish
+      end
     end
   end
 end

data/lib/failbot/memory_backend.rb

@@ -12,11 +12,8 @@ module Failbot
     end
 
     def report(data)
-      if @fail
-        fail
-      end
-
       @reports << data
+      fail if @fail
     end
 
     def ping

data/lib/failbot/version.rb

@@ -1,3 +1,3 @@
 module Failbot
-  VERSION = "2.4.2"
+  VERSION = "2.5.4"
 end

data/lib/failbot/waiter_backend.rb

@@ -0,0 +1,21 @@
+module Failbot
+  class WaiterBackend
+    # This backend waits a configured amount of time before returning.  This is
+    # intended be used to test timeouts.  Delay is the number of seconds to wait.
+
+    attr_reader :reports
+    def initialize(delay = 5)
+      @delay = delay
+      @reports = []
+    end
+
+    def report(data)
+      @reports << data
+      sleep(@delay)
+    end
+
+    def ping
+      # nop
+    end
+  end
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: failbot
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.5.4
 platform: ruby
 authors:
 - "@rtomayko"
 - "@atmos"
 - "@sr"
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -93,6 +93,7 @@ files:
 - lib/failbot/backtrace.rb
 - lib/failbot/compat.rb
 - lib/failbot/console_backend.rb
+- lib/failbot/default_backtrace_parser.rb
 - lib/failbot/exception_format/haystack.rb
 - lib/failbot/exception_format/structured.rb
 - lib/failbot/exit_hook.rb
@@ -106,11 +107,12 @@ files:
 - lib/failbot/resque_failure_backend.rb
 - lib/failbot/sensitive_data_scrubber.rb
 - lib/failbot/version.rb
+- lib/failbot/waiter_backend.rb
 homepage: http://github.com/github/failbot#readme
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -118,15 +120,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Deliver exceptions to Haystack
 test_files: []