failbot 2.4.3 → 2.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5d1f28105f9f590c7c9160004bfa4a15101da5a1372ee0e40e882c493dad5fd
-  data.tar.gz: 5b09392f7d2243343a7982c6ae031f80d8501eb946d687490be6ad88e7321b1f
+  metadata.gz: ef2b30021fd84983545c9fa374d030d9c1269d3ef51b778cf84d55fe96fde087
+  data.tar.gz: 998dde878c99c47177d03ff693625e05f1522009d84bf4e5f1a12a0fb398ad0e
 SHA512:
-  metadata.gz: 011af8c261c0826685972133268b52b85dcd358c402ee662575ef853b36f7c8ea6ff527673f2ec1210316d9cefc053aa8a20b119bfd55c09cf9666cbd6a0eeb8
-  data.tar.gz: 58bc429f5b2e27ef75f570eb2d194d2e956dc935bc5ec471042a0029ae8e14a929ee486abe25d2bd9e52ee9f052eccec559b18f31bf3ee292441e51820880bf1
+  metadata.gz: 774ccebb4f0b04886309e32840d73f17b0278388a73aa6a15541870c791a832f68c767b140ed1d62527feff87ae880aedebf60e942946c103116103c32bda9be
+  data.tar.gz: 778c39eea60f8acdd0b53246401351e1373bf9386259fde67adfb86c0956baa8780fdda6afcf01f942ee6327aa8672390ec57d699e93ade429c8123b6f5ef3a6

data/lib/failbot.rb

@@ -3,6 +3,7 @@ require 'digest/md5'
 require 'logger'
 require 'socket'
 require "time"
+require "timeout"
 require "date"
 require "uri"
 
@@ -25,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.
   #
@@ -67,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 = {
@@ -135,15 +142,29 @@ module Failbot
     end
 
     populate_context_from_settings(settings)
+    @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
+
+    @connect_timeout_seconds = nil
+    if settings.key?("FAILBOT_CONNECT_TIMEOUT_MS")
+      @connect_timeout_seconds = settings["FAILBOT_CONNECT_TIMEOUT_MS"].to_f / 1000
+      # unset the value if it's not parsing to something valid
+      @connect_timeout_seconds = nil unless @connect_timeout_seconds > 0
+    end
 
     self.backend =
       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"
-        Failbot::HTTPBackend.new(URI(settings["FAILBOT_HAYSTACK_URL"]))
+        Failbot::HTTPBackend.new(URI(settings["FAILBOT_HAYSTACK_URL"]), @connect_timeout_seconds)
       when 'json'
         Failbot::JSONBackend.new(settings["FAILBOT_BACKEND_JSON_HOST"], settings["FAILBOT_BACKEND_JSON_PORT"])
       when 'console'
@@ -329,17 +350,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
@@ -480,11 +515,21 @@ module Failbot
   def populate_context_from_settings(settings)
     settings.each do |key, value|
       if /\AFAILBOT_CONTEXT_(.+)\z/ =~ key
-        context[0][$1.downcase] = value
+        key = $1.downcase
+        context[0][key] = value unless context[0][key]
       end
     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/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

@@ -22,18 +22,47 @@ module Failbot
           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" => class_name,
-              "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")

data/lib/failbot/haystack.rb

@@ -4,8 +4,10 @@ require 'json'
 
 module Failbot
   class Haystack
-    def initialize(url)
+    attr_accessor :connect_timeout
+    def initialize(url, connect_timeout=nil)
       @url = url
+      @connect_timeout = connect_timeout
     end
 
     def user
@@ -50,8 +52,15 @@ module Failbot
       # use SSL if applicable
       http.use_ssl = true if @url.scheme == "https"
 
+      # Set the connect timeout if it was provided
+      http.open_timeout = @connect_timeout if @connect_timeout
+
       # push it through
       http.request(request)
+    ensure
+      if defined?(http) && http.started?
+        http.finish
+      end
     end
   end
 end

data/lib/failbot/http_backend.rb

@@ -1,11 +1,12 @@
 module Failbot
   class HTTPBackend
-    def initialize(url)
+    def initialize(url, connect_timeout = nil)
       if url.to_s.empty?
         raise ArgumentError, "FAILBOT_HAYSTACK_URL setting required."
       end
 
-      @haystack = Failbot::Haystack.new(url)
+      @connect_timeout = connect_timeout
+      @haystack = Failbot::Haystack.new(url, connect_timeout)
     end
 
     def report(data)
@@ -19,5 +20,13 @@ module Failbot
     def ping
       @haystack.ping
     end
+
+    def connect_timeout
+      @haystack.connect_timeout
+    end
+
+    def connect_timeout=(timeout)
+      @haystack.connect_timeout = timeout
+    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.3"
+  VERSION = "2.5.5"
 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.3
+  version: 2.5.5
 platform: ruby
 authors:
 - "@rtomayko"
 - "@atmos"
 - "@sr"
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-24 00:00:00.000000000 Z
+date: 2020-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -107,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
@@ -119,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: []