failbot 2.5.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5252def6736e809a4cfa4961ccce6180a4dcc593048c7185667fc5109ff37bb
-  data.tar.gz: c1e8d453c0b18383896dac11471e9bfc026cd390eac61486d7a795f753a64462
+  metadata.gz: 7d95ed657556e73833f309a37497784e45ac94f959f79988acf8ac066e6f4a6b
+  data.tar.gz: c95554288cab069cf33ce8c1c4bdfad43ebaa5e9e1f1f83492865e67d014977d
 SHA512:
-  metadata.gz: c4655cbdac9571d6d2384e8bd2b593ecd1c564f176126e0e54a9073999dc72d6d776ea506a16b0fc8a116e607c9447fddee7e535ceac8cad60750a2a89b39b1a
-  data.tar.gz: 1edeeafc4c3f36f710b199b414d49d72c9b261c30f08b7da93ade8a6550bc892f66550f5f89ee1ed54c6156c28f1dd9a4444b70e06388caaeedefc10dd14b22c
+  metadata.gz: a1223f04684f214ed5dfcdf444a1e4b9b1a209aee0ba1aa065e85e52603b3fda012790002237b3629ca9e588533aec48a2bd482d995ffa5d149f575c8619465c
+  data.tar.gz: 2acb08a403bbdd7b4fdae7973e40a11320b1002bac4aba4e8393d467d8c9b45d45efa0eaae85b4b6b4e6139be1b7185e7d387ccff7edba33b9dfe4724eaad963

data/lib/failbot.rb

@@ -26,6 +26,8 @@ module Failbot
   autoload :MemoryBackend,  'failbot/memory_backend'
   autoload :JSONBackend,    'failbot/json_backend'
 
+  autoload :ThreadLocalVariable, 'failbot/thread_local_variable'
+
   # Public: Set an instrumenter to be called when exceptions are reported.
   #
   #   class CustomInstrumenter
@@ -44,9 +46,6 @@ module Failbot
   #
   attr_accessor :instrumenter
 
-  # prevent recursive calls to Failbot.report!
-  attr_accessor :already_reporting
-
   # Root directory of the project's source. Used to clean up stack traces if the exception format supports it
 
   def source_root=(str)
@@ -130,9 +129,16 @@ module Failbot
       return setup_deprecated(settings)
     end
 
-    if default_context.respond_to?(:to_hash) && !default_context.to_hash.empty?
-      context[0] = default_context.to_hash
+    initial_context = if default_context.respond_to?(:to_hash) && !default_context.to_hash.empty?
+                        default_context.to_hash
+                      else
+                        { 'server' => hostname }
+                      end
+
+    @thread_local_context = ::Failbot::ThreadLocalVariable.new do
+      [initial_context]
     end
+    @thread_local_already_reporting = ::Failbot::ThreadLocalVariable.new { false }
 
     populate_context_from_settings(settings)
 
@@ -174,7 +180,7 @@ module Failbot
   # hashes are condensed down into one and included in the next report. Don't
   # mess with this structure directly - use the #push and #pop methods.
   def context
-    @context ||= [{'server' => hostname}]
+    @thread_local_context.value
   end
 
   # Add info to be sent in the next failbot report, should one occur.
@@ -198,7 +204,7 @@ module Failbot
 
   # Reset the context stack to a pristine state.
   def reset!
-    @context = [context[0]]
+    @thread_local_context.value = [context[0]].dup
   end
 
   # Loops through the stack of contexts and deletes the given key if it exists.
@@ -329,17 +335,25 @@ module Failbot
       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
       backend.report(data)
-      instrument("report.failbot", data)
+      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
@@ -468,6 +482,14 @@ module Failbot
     @hostname ||= Socket.gethostname
   end
 
+  def already_reporting=(bool)
+    @thread_local_already_reporting.value = bool
+  end
+
+  def already_reporting
+    @thread_local_already_reporting.value
+  end
+
   private
 
   # Internal: Publish an event to the instrumenter
@@ -485,6 +507,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/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/thread_local_variable.rb

@@ -0,0 +1,24 @@
+module Failbot
+  # Public: A simplified implementation of [`::Concurrent::ThreadLocalVar`](https://github.com/ruby-concurrency/concurrent-ruby/blob/7dc6eb04142f008ffa79a59c125669c6fcbb85a8/lib/concurrent-ruby/concurrent/atomic/thread_local_var.rb)
+  #
+  # Why not just use `concurrent-ruby`? We wanted to minimize external dependencies to avoid conflicts with gems already installed with `github/github`.
+  #
+  class ThreadLocalVariable
+    def initialize(&block)
+      @default_block = block || proc {}
+      @key = "_thread_local_variable##{object_id}"
+    end
+
+    def value
+      if Thread.current.key?(@key)
+        Thread.current[@key]
+      else
+        Thread.current[@key] = @default_block.call
+      end
+    end
+
+    def value=(val)
+      Thread.current[@key] = val
+    end
+  end
+end

data/lib/failbot/version.rb

@@ -1,3 +1,3 @@
 module Failbot
-  VERSION = "2.5.0"
+  VERSION = "2.5.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: failbot
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.1
 platform: ruby
 authors:
 - "@rtomayko"
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-06 00:00:00.000000000 Z
+date: 2020-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -106,6 +106,7 @@ files:
 - lib/failbot/middleware.rb
 - lib/failbot/resque_failure_backend.rb
 - lib/failbot/sensitive_data_scrubber.rb
+- lib/failbot/thread_local_variable.rb
 - lib/failbot/version.rb
 homepage: http://github.com/github/failbot#readme
 licenses: