failbot 2.5.2 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e17fb2d80a08382f07201582e708558ab9288c33c085950136d42c38ac9e47ff
-  data.tar.gz: 664d9e980cb2901a1487518435a8c15bcd1e7fbce8d72eb16298e43db50d531c
+  metadata.gz: a2261cff70dfa6a7d6a35eec441d3440055ab89166e3441d61d10ccbd7fe635d
+  data.tar.gz: a163db78583fa4ceb80be66e5edb2477fec732718ff9057d331075163f4a35d2
 SHA512:
-  metadata.gz: 5228d0b4914759a86d5605b8573f4c55de41716b2f9fa1248c6df87c169dacff3653a46da0ad4287866ecdb8a60aac5b0ed762202c0aaff89444e3b7cbbd75da
-  data.tar.gz: 332e27bc52d28068b62b6eda1fe30925401788ab3225f68d0a09573e07182f2caa6e7437edf6627cd94cba9fa0be04c44fd6a873e594428ea8bf78a22e2707fa
+  metadata.gz: 915c6f252c20266490c1d345bacf92a246dc352fd409126c260954bf65f569a8a8c05566883c592e68de12af3516722c0469526ac3824f52ad670c1dd161eb3a
+  data.tar.gz: '08e40f7a93557a96a8e9b6857eb3302781f360c47b914f587330a62599b7c6d6a9b93984d58c40e2287ec7d1de4bdcd5ddc15e1ed6b25486a7d26f6b240d7678'

data/lib/failbot/compat.rb

@@ -76,17 +76,17 @@ module Failbot
       warn "#{caller[0]} Failbot.report_errors? is deprecated and will be " \
         "removed in subsequent releases."
 
-      if @report_errors.nil?
+      if @thread_local_report_errors.nil?
         config['report_errors']
       else
-        @report_errors
+        @thread_local_report_errors.value
       end
     end
 
     def report_errors=(v)
       warn "#{caller[0]} Failbot.report_errors= is deprecated and will be " \
         "removed in subsequent releases."
-      @report_errors = v
+      @thread_local_report_errors.value = v
     end
 
     # Load and initialize the exception reporting backend as specified by

data/lib/failbot/exception_format/structured.rb

@@ -14,7 +14,7 @@ module Failbot
       def self.call(e)
         message = e.message.to_s
         class_name = e.class.to_s
-        stacktrace = begin
+        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")}"
@@ -22,6 +22,7 @@ module Failbot
           EMPTY_ARRAY
         end
         {
+          "platform" => "ruby",
           "exception_detail" => exception_details(e),
           "ruby" => RUBY_DESCRIPTION,
           "created_at" => Time.now.utc.iso8601(6)

data/lib/failbot/haystack.rb

@@ -4,8 +4,11 @@ require 'json'
 
 module Failbot
   class Haystack
-    def initialize(url)
+    attr_accessor :connect_timeout, :rw_timeout
+    def initialize(url, connect_timeout=nil, timeout_seconds=nil)
       @url = url
+      @connect_timeout = connect_timeout
+      @rw_timeout = timeout_seconds - @connect_timeout.to_f if timeout_seconds
     end
 
     def user
@@ -24,7 +27,7 @@ module Failbot
 
       # Raise if the exception doesn't make it to Haystack, ensures the failure
       # is logged
-      raise StandardError, "couldn't send exception to Haystack" unless response.code == "201"
+      raise StandardError, "couldn't send exception to Haystack: #{response.code} #{response.message}" unless response.code == "201"
     end
 
     def self.send_data(data)
@@ -50,8 +53,17 @@ 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
+      http.read_timeout = @rw_timeout if @rw_timeout
+      http.write_timeout = @rw_timeout if @rw_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,11 @@
 module Failbot
   class HTTPBackend
-    def initialize(url)
+    def initialize(url, connect_timeout = nil, timeout_seconds = nil)
       if url.to_s.empty?
         raise ArgumentError, "FAILBOT_HAYSTACK_URL setting required."
       end
 
-      @haystack = Failbot::Haystack.new(url)
+      @haystack = Failbot::Haystack.new(url, connect_timeout, timeout_seconds)
     end
 
     def report(data)
@@ -19,5 +19,21 @@ module Failbot
     def ping
       @haystack.ping
     end
+
+    def connect_timeout
+      @haystack.connect_timeout
+    end
+
+    def connect_timeout=(timeout)
+      @haystack.connect_timeout = timeout
+    end
+
+    def rw_timeout
+      @haystack.rw_timeout
+    end
+
+    def rw_timeout=(timeout)
+      @haystack.rw_timeout = timeout
+    end
   end
 end

data/lib/failbot/json_backend.rb

@@ -17,7 +17,7 @@ module Failbot
     def report(data)
       payload = data.to_json
 
-      response = socket do |s|
+      socket do |s|
         s.send(payload, 0)
         nil
       end

data/lib/failbot/middleware.rb

@@ -10,16 +10,17 @@ module Failbot
 
     def call(env)
       Failbot.reset!
-      Failbot.push @other.merge(self.class.context(env)) do
-        begin
-          start = Time.now
-          @app.call(env)
-        rescue Object => boom
-          elapsed = Time.now - start
-          Failbot.report(boom, {:time => elapsed.to_s})
-          raise
-        end
+      Failbot.push @other.merge(self.class.context(env))
+      begin
+        start = Time.now
+        @app.call(env)
+      rescue Object => boom
+        elapsed = Time.now - start
+        Failbot.report(boom, {:time => elapsed.to_s})
+        raise
       end
+    ensure
+      Failbot.reset!
     end
 
     def self.context(env)

data/lib/failbot/thread_local_variable.rb

@@ -6,19 +6,22 @@ module Failbot
   class ThreadLocalVariable
     def initialize(&block)
       @default_block = block || proc {}
-      @key = "_thread_local_variable##{object_id}"
+      @key = "_thread_local_variable_#{object_id}".to_sym
     end
 
     def value
-      if Thread.current.key?(@key)
-        Thread.current[@key]
-      else
-        Thread.current[@key] = @default_block.call
-      end
+      value_from_thread(Thread.current)
     end
 
     def value=(val)
-      Thread.current[@key] = val
+      Thread.current.thread_variable_set(@key, val)
+    end
+
+    def value_from_thread(thread)
+      if !thread.thread_variables.include?(@key)
+        thread.thread_variable_set(@key, @default_block.call)
+      end
+      thread.thread_variable_get(@key)
     end
   end
 end

data/lib/failbot/version.rb

@@ -1,3 +1,3 @@
 module Failbot
-  VERSION = "2.5.2"
+  VERSION = "2.10.0"
 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

data/lib/failbot.rb

@@ -1,8 +1,9 @@
 require 'yaml'
-require 'digest/md5'
+require 'digest/sha2'
 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'
 
   autoload :ThreadLocalVariable, 'failbot/thread_local_variable'
 
@@ -87,7 +89,7 @@ module Failbot
 
   # Default to the original exception format used by haystack unless
   # apps opt in to the newer version.
-  self.exception_format = :haystack
+  self.exception_format = :structured
 
   # Set a callable that is responsible for parsing and formatting ruby
   # backtraces.  This is only necessary to set if your app deals with
@@ -146,15 +148,29 @@ module Failbot
     @thread_local_already_reporting = ::Failbot::ThreadLocalVariable.new { false }
 
     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, @timeout_seconds)
       when 'json'
         Failbot::JSONBackend.new(settings["FAILBOT_BACKEND_JSON_HOST"], settings["FAILBOT_BACKEND_JSON_PORT"])
       when 'console'
@@ -164,7 +180,9 @@ module Failbot
       end
 
     @raise_errors  = !settings["FAILBOT_RAISE"].to_s.empty?
-    @report_errors = settings["FAILBOT_REPORT"] != "0"
+    @thread_local_report_errors = ::Failbot::ThreadLocalVariable.new do
+      settings["FAILBOT_REPORT"] != "0"
+    end
 
     # allows overriding the 'app' value to send to single haystack bucket.
     # used primarily on ghe.io.
@@ -174,6 +192,10 @@ module Failbot
     if settings["FAILBOT_EXCEPTION_FORMAT"]
       self.exception_format = settings["FAILBOT_EXCEPTION_FORMAT"].to_sym
     end
+
+    @ignored_error_classes = settings.fetch("FAILBOT_IGNORED_ERROR_CLASSES", "").split(",").map do |class_name|
+      Module.const_get(class_name.strip)
+    end
   end
 
   # Bring in deprecated methods
@@ -196,6 +218,11 @@ module Failbot
   #
   # Returns the value returned by the block when given; otherwise, returns nil.
   def push(info={})
+    info.each do |key, value|
+      if value.kind_of?(Proc)
+        raise ArgumentError, "Proc usage has been removed from Failbot"
+      end
+    end
     context.push(info)
     yield if block_given?
   ensure
@@ -270,13 +297,13 @@ module Failbot
   # Default rollup for an exception. Exceptions with the same rollup are
   # grouped together in Haystack. The rollup is an MD5 hash of the exception
   # class and the raising file, line, and method.
-  DEFAULT_ROLLUP = lambda do |exception, context|
+  DEFAULT_ROLLUP = lambda do |exception, context, thread|
     backtrace_line = Array(exception.backtrace).first || ""
     # We want all exceptions from foo.html.erb:123 to be grouped together, no
     # matter what wacky generated ERB method name is attached to it.
     cleaned_line = backtrace_line.sub(/_erb__[_\d]+'\z/, "_erb'")
 
-    Digest::MD5.hexdigest("#{exception.class}#{cleaned_line}")
+    Digest::SHA256.hexdigest("#{exception.class}#{cleaned_line}")
   end
 
   private_constant :DEFAULT_ROLLUP
@@ -305,6 +332,8 @@ module Failbot
   #
   # Returns nothing.
   def report(e, other = {})
+    return if ignore_error?(e)
+
     if @raise_errors
       squash_contexts(context, exception_info(e), other) # surface problems squashing
       raise e
@@ -314,53 +343,22 @@ module Failbot
   end
 
   def report!(e, other = {})
-    return unless @report_errors
+    report_with_context!(Thread.current, context, e, other)
+  end
 
-    if already_reporting
-      logger.warn "FAILBOT: asked to report while reporting!" rescue nil
-      logger.warn e.message rescue nil
-      logger.warn e.backtrace.join("\n") rescue nil
-      return
+  def report_from_thread(thread, e, other = {})
+    if @raise_errors
+      squash_contexts(@thread_local_context.value_from_thread(thread), exception_info(e), other) # surface problems squashing
+      raise e
+    else
+      report_from_thread!(thread, e, other)
     end
-    self.already_reporting = true
-
-    begin
-      data = squash_contexts(context, exception_info(e), other)
-
-      if !data.has_key?("rollup")
-        data = data.merge("rollup" => @rollup.call(e, data))
-      end
-
-      if @before_report
-        data = squash_contexts(data, @before_report.call(e, data))
-      end
-
-      if @app_override
-        data = data.merge("app" => @app_override)
-      end
+  end
 
-      data = scrub(sanitize(data))
-    rescue Object => i
-      log_failure("processing", data, e, i)
-      self.already_reporting = false
-      return
-    end
+  def report_from_thread!(thread, e, other = {})
+    return if ignore_error?(e)
 
-    start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    instrumentation_data = {
-      "report_status" => "error",
-    }
-    begin
-      backend.report(data)
-      instrumentation_data["report_status"] = "success"
-    rescue Object => i
-      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
+    report_with_context!(thread, @thread_local_context.value_from_thread(thread), e, other)
   end
 
   # Public: Disable exception reporting. This is equivalent to calling
@@ -373,14 +371,14 @@ module Failbot
   # block - an optional block to perform while reporting is disabled. If a block
   #         is passed, reporting will be re-enabled after the block is called.
   def disable(&block)
-    original_report_errors = @report_errors
-    @report_errors = false
+    original_report_errors = @thread_local_report_errors.value
+    @thread_local_report_errors.value = false
 
     if block
       begin
         block.call
       ensure
-        @report_errors = original_report_errors
+        @thread_local_report_errors.value = original_report_errors
       end
     end
   end
@@ -389,7 +387,7 @@ module Failbot
   # this can be called if it is explicitly disabled by calling `Failbot.disable`
   # or setting `FAILBOT_REPORTING => "0"` in `Failbot.setup`.
   def enable
-    @report_errors = true
+    @thread_local_report_errors.value = true
   end
 
   # Public: exceptions that were reported. Only available when using the
@@ -413,7 +411,6 @@ module Failbot
 
     contexts_to_squash.flatten.each do |hash|
       hash.each do |key, value|
-        value = (value.call rescue nil) if value.kind_of?(Proc)
         squashed[key.to_s] = value
       end
     end
@@ -435,6 +432,8 @@ module Failbot
           value
         when String, true, false
           value.to_s
+        when Proc
+          "proc usage is deprecated"
         when Array
           if key == EXCEPTION_DETAIL
             # special-casing for the exception_detail key, which is allowed to
@@ -476,7 +475,16 @@ module Failbot
   end
 
   def logger
-    @logger ||= Logger.new($stderr)
+    @logger ||= Logger.new($stderr, formatter: proc { |severity, datetime, progname, msg|
+      log = case msg
+            when Hash
+              msg.map { |k,v| "#{k}=#{v.inspect}" }.join(" ")
+            else
+              %Q|msg="#{msg.inspect}"|
+            end
+      log_line = %Q|ts="#{datetime.utc.iso8601}" level=#{severity} logger=Failbot #{log}\n|
+      log_line.lstrip
+    })
   end
 
   def logger=(logger)
@@ -497,6 +505,63 @@ module Failbot
 
   private
 
+  def report_with_context!(thread, provided_context, e, other = {})
+    return unless @thread_local_report_errors.value
+    return if ignore_error?(e)
+
+    if already_reporting
+      logger.warn "FAILBOT: asked to report while reporting!" rescue nil
+      logger.warn e.message rescue nil
+      logger.warn e.backtrace.join("\n") rescue nil
+      return
+    end
+    self.already_reporting = true
+
+    begin
+      data = squash_contexts(provided_context, exception_info(e), other)
+
+      if !data.has_key?("rollup")
+        data = data.merge("rollup" => @rollup.call(e, data, thread))
+      end
+
+      if defined?(@before_report) && @before_report
+        data = squash_contexts(data, @before_report.call(e, data, thread))
+      end
+
+      if @app_override
+        data = data.merge("app" => @app_override)
+      end
+
+      data = scrub(sanitize(data))
+    rescue Object => i
+      log_failure("processing", data, e, i)
+      self.already_reporting = false
+      return
+    end
+
+    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
+      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
+
   # Internal: Publish an event to the instrumenter
   def instrument(name, payload = {})
     Failbot.instrumenter.instrument(name, payload) if Failbot.instrumenter
@@ -507,18 +572,51 @@ 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
+    begin
+      record = {
+        "msg" => "exception",
+        "action" => action,
+        "data" => data,
+      }
+
+      record.merge!(to_semconv(exception))
+      logger.debug record
+
+      record = {
+        "msg" => "report-failed",
+        "action" => action,
+        "data" => data,
+      }
+      record.merge!(to_semconv(original_exception))
+      logger.debug record
+    rescue => e
+      raise e
+    end
+  end
+
+  def to_semconv(exception)
+    {
+      "exception.type" => exception.class.to_s,
+      "exception.message" => exception.message.encode("UTF-8", invalid: :replace, undef: :replace, replace: '�'),
+      "exception.backtrace" => exception.full_message(highlight: false, order: :top).encode('UTF-8', invalid: :replace, undef: :replace, replace: '�'),
+    }
+  end
+
+  def ignore_error?(error)
+    @cache ||= Hash.new do |hash, error_class|
+      hash[error_class] = @ignored_error_classes.any? do |ignored_error_class|
+        error_class.ancestors.include?(ignored_error_class)
+      end
+    end
+
+    @cache[error.class]
   end
 
   extend self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: failbot
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 2.10.0
 platform: ruby
 authors:
 - "@rtomayko"
@@ -10,34 +10,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-07 00:00:00.000000000 Z
+date: 2022-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.4
 - !ruby/object:Gem::Dependency
@@ -82,6 +82,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: "..."
 email:
 - github+failbot@lists.github.com
@@ -108,6 +122,7 @@ files:
 - lib/failbot/sensitive_data_scrubber.rb
 - lib/failbot/thread_local_variable.rb
 - lib/failbot/version.rb
+- lib/failbot/waiter_backend.rb
 homepage: http://github.com/github/failbot#readme
 licenses:
 - MIT
@@ -127,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Deliver exceptions to Haystack