airbrake-ruby 4.13.0 → 4.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21b45126851240764d75da35e8f7fbc7c73effdda1b01854065dc25db0c351e3
-  data.tar.gz: 5dd7a704b0a16a841fb93b30b72a0acf28cb887f2e7abdda57e48078289d107b
+  metadata.gz: b4ca256b96d64ce95df54220e572323892f0b3496710a7273409306f2b0a7088
+  data.tar.gz: a5b264fb9ac50c258bd7f239af074b20b8bd1515a9a94241f98c602d700d5255
 SHA512:
-  metadata.gz: 9252437e39b4a415e2e90ca8a4434540ecd7e45737bdacd788e772a308fbc6c1f231c293eaa11aaaf90310f695f7a44e87b7511cd5af204259949746a6e85013
-  data.tar.gz: 969b2e55a423d02f241e04ccb27eeb13d352dbe3b0f4394c53dccdf4a3bab8c4d59e19ac7a9c7e455a08b5c22340e49b126581b1be90adcd972faaa79fbb6e11
+  metadata.gz: eba8e8d34d8de98fe34bfea5a3b48393e59d04473f81721565bea42fef486f06ab5b01899e16ed9d2517f6349137e05d1df04f851f48bfb0a998a9c23912daf3
+  data.tar.gz: 39b6d21b0007e6e14f31903a82d8871f45a47a6d27ecef6df65cff7ba6db95ae2b4e81a8bb84e227b2f65cf7ed2cc6fe06bf1b3c2dc880f3423232a25d39224a

data/lib/airbrake-ruby.rb

@@ -1,7 +1,6 @@
 require 'net/https'
 require 'logger'
 require 'json'
-require 'thread'
 require 'set'
 require 'socket'
 require 'time'

data/lib/airbrake-ruby/async_sender.rb

@@ -7,12 +7,6 @@ module Airbrake
   class AsyncSender
     include Loggable
 
-    # @return [String]
-    WILL_NOT_DELIVER_MSG =
-      "%<log_label>s AsyncSender has reached its capacity of %<capacity>s " \
-      "and the following notice will not be delivered " \
-      "Error: %<type>s - %<message>s\nBacktrace: %<backtrace>s\n".freeze
-
     def initialize(method = :post)
       @config = Airbrake::Config.instance
       @method = method
@@ -20,12 +14,13 @@ module Airbrake
 
     # Asynchronously sends a notice to Airbrake.
     #
-    # @param [Airbrake::Notice] notice A notice that was generated by the
-    #   library
+    # @param [Hash] payload Whatever needs to be sent
     # @return [Airbrake::Promise]
-    def send(notice, promise, endpoint = @config.endpoint)
-      unless thread_pool << [notice, promise, endpoint]
-        return will_not_deliver(notice, promise)
+    def send(payload, promise, endpoint = @config.endpoint)
+      unless thread_pool << [payload, promise, endpoint]
+        return promise.reject(
+          "AsyncSender has reached its capacity of #{@config.queue_size}",
+        )
       end
 
       promise
@@ -58,23 +53,5 @@ module Airbrake
         )
       end
     end
-
-    def will_not_deliver(notice, promise)
-      error = notice[:errors].first
-
-      logger.error(
-        format(
-          WILL_NOT_DELIVER_MSG,
-          log_label: LOG_LABEL,
-          capacity: @config.queue_size,
-          type: error[:type],
-          message: error[:message],
-          backtrace: error[:backtrace].map do |line|
-            "#{line[:file]}:#{line[:line]} in `#{line[:function]}'"
-          end.join("\n"),
-        ),
-      )
-      promise.reject("AsyncSender has reached its capacity of #{@config.queue_size}")
-    end
   end
 end

data/lib/airbrake-ruby/config.rb

@@ -119,12 +119,13 @@ module Airbrake
 
     # @param [Hash{Symbol=>Object}] user_config the hash to be used to build the
     #   config
+    # rubocop:disable Metrics/AbcSize
     def initialize(user_config = {})
       self.proxy = {}
       self.queue_size = 100
       self.workers = 1
       self.code_hunks = true
-      self.logger = ::Logger.new(File::NULL)
+      self.logger = ::Logger.new(File::NULL).tap { |l| l.level = Logger::WARN }
       self.project_id = user_config[:project_id]
       self.project_key = user_config[:project_key]
       self.host = 'https://api.airbrake.io'
@@ -149,6 +150,7 @@ module Airbrake
 
       merge(user_config)
     end
+    # rubocop:enable Metrics/AbcSize
 
     # The full URL to the Airbrake Notice API. Based on the +:host+ option.
     # @return [URI] the endpoint address

data/lib/airbrake-ruby/loggable.rb

@@ -22,7 +22,7 @@ module Airbrake
 
       # @return [Logger]
       def instance
-        @instance ||= ::Logger.new(File::NULL)
+        @instance ||= ::Logger.new(File::NULL).tap { |l| l.level = ::Logger::WARN }
       end
     end
 

data/lib/airbrake-ruby/monotonic_time.rb

@@ -16,6 +16,11 @@ module Airbrake
         time_in_nanoseconds / (10.0**6)
       end
 
+      # @return [Integer] current monotonic time in seconds
+      def time_in_s
+        time_in_nanoseconds / (10.0**9)
+      end
+
       private
 
       if defined?(Process::CLOCK_MONOTONIC)

data/lib/airbrake-ruby/notice.rb

@@ -76,7 +76,7 @@ module Airbrake
     #
     # @return [Hash{String=>String}, nil]
     # @api private
-    def to_json
+    def to_json(*_args)
       loop do
         begin
           json = @payload.to_json

data/lib/airbrake-ruby/notice_notifier.rb

@@ -9,7 +9,7 @@ module Airbrake
     # @return [Array<Class>] filters to be executed first
     DEFAULT_FILTERS = [
       Airbrake::Filters::SystemExitFilter,
-      Airbrake::Filters::GemRootFilter
+      Airbrake::Filters::GemRootFilter,
 
       # Optional filters (must be included by users):
       # Airbrake::Filters::ThreadFilter

data/lib/airbrake-ruby/performance_notifier.rb

@@ -14,18 +14,20 @@ module Airbrake
       @flush_period = Airbrake::Config.instance.performance_stats_flush_period
       @async_sender = AsyncSender.new(:put)
       @sync_sender = SyncSender.new(:put)
-      @payload = {}
       @schedule_flush = nil
-      @mutex = Mutex.new
       @filter_chain = FilterChain.new
-      @waiting = false
+
+      @payload = {}.extend(MonitorMixin)
+      @has_payload = @payload.new_cond
     end
 
     # @param [Hash] resource
     # @see Airbrake.notify_query
     # @see Airbrake.notify_request
     def notify(resource)
-      send_resource(resource, sync: false)
+      @payload.synchronize do
+        send_resource(resource, sync: false)
+      end
     end
 
     # @param [Hash] resource
@@ -46,7 +48,7 @@ module Airbrake
     end
 
     def close
-      @mutex.synchronize do
+      @payload.synchronize do
         @schedule_flush.kill if @schedule_flush
         @async_sender.close
         logger.debug("#{LOG_LABEL} performance notifier closed")
@@ -55,6 +57,46 @@ module Airbrake
 
     private
 
+    def schedule_flush
+      @schedule_flush ||= Thread.new do
+        loop do
+          @payload.synchronize do
+            @last_flush_time ||= MonotonicTime.time_in_s
+
+            while (MonotonicTime.time_in_s - @last_flush_time) < @flush_period
+              @has_payload.wait(@flush_period)
+            end
+
+            if @payload.none?
+              @last_flush_time = nil
+              next
+            end
+
+            send(@async_sender, @payload, Airbrake::Promise.new)
+            @payload.clear
+          end
+        end
+      end
+    end
+
+    def send_resource(resource, sync:)
+      promise = check_configuration(resource)
+      return promise if promise.rejected?
+
+      @filter_chain.refine(resource)
+      if resource.ignored?
+        return Promise.new.reject("#{resource.class} was ignored by a filter")
+      end
+
+      update_payload(resource)
+      if sync || @flush_period == 0
+        send(@sync_sender, @payload, promise)
+      else
+        @has_payload.signal
+        schedule_flush
+      end
+    end
+
     def update_payload(resource)
       if (total_stat = @payload[resource])
         @payload.key(total_stat).merge(resource)
@@ -83,61 +125,6 @@ module Airbrake
       end
     end
 
-    def schedule_flush
-      return if @payload.empty?
-
-      if @schedule_flush && @schedule_flush.status == 'sleep' && @waiting
-        begin
-          @schedule_flush.run
-        rescue ThreadError => exception
-          logger.error("#{LOG_LABEL}: error occurred while flushing: #{exception}")
-        end
-      end
-
-      @schedule_flush ||= spawn_timer
-    end
-
-    def spawn_timer
-      Thread.new do
-        loop do
-          if @payload.none?
-            @waiting = true
-            Thread.stop
-            @waiting = false
-          end
-
-          sleep(@flush_period)
-
-          payload = nil
-          @mutex.synchronize do
-            payload = @payload
-            @payload = {}
-          end
-
-          send(@async_sender, payload, Airbrake::Promise.new)
-        end
-      end
-    end
-
-    def send_resource(resource, sync:)
-      promise = check_configuration(resource)
-      return promise if promise.rejected?
-
-      @filter_chain.refine(resource)
-      if resource.ignored?
-        return Promise.new.reject("#{resource.class} was ignored by a filter")
-      end
-
-      @mutex.synchronize do
-        update_payload(resource)
-        if sync || @flush_period == 0
-          send(@sync_sender, @payload, promise)
-        else
-          schedule_flush
-        end
-      end
-    end
-
     def check_configuration(resource)
       promise = @config.check_configuration
       return promise if promise.rejected?
@@ -153,16 +140,17 @@ module Airbrake
     end
 
     def send(sender, payload, promise)
-      signature = "#{self.class.name}##{__method__}"
-      raise "#{signature}: payload (#{payload}) cannot be empty. Race?" if payload.none?
-
-      logger.debug { "#{LOG_LABEL} #{signature}: #{payload}" }
+      raise "payload cannot be empty. Race?" if payload.none?
 
       with_grouped_payload(payload) do |resource_hash, destination|
         url = URI.join(
           @config.host,
           "api/v5/projects/#{@config.project_id}/#{destination}",
         )
+
+        logger.debug do
+          "#{LOG_LABEL} #{self.class.name}##{__method__}: #{resource_hash}"
+        end
         sender.send(resource_hash, promise, url)
       end
 

data/lib/airbrake-ruby/stat.rb

@@ -14,15 +14,13 @@ module Airbrake
   #
   # @since v3.2.0
   class Stat
-    attr_accessor :count, :sum, :sumsq, :tdigest
+    attr_accessor :sum, :sumsq, :tdigest
 
-    # @param [Integer] count How many times this stat was incremented
     # @param [Float] sum The sum of duration in milliseconds
     # @param [Float] sumsq The squared sum of duration in milliseconds
     # @param [TDigest::TDigest] tdigest Packed durations. By default,
     #   compression is 20
-    def initialize(count: 0, sum: 0.0, sumsq: 0.0, tdigest: TDigest.new(0.05))
-      @count = count
+    def initialize(sum: 0.0, sumsq: 0.0, tdigest: TDigest.new(0.05))
       @sum = sum
       @sumsq = sumsq
       @tdigest = tdigest
@@ -33,15 +31,15 @@ module Airbrake
     def to_h
       tdigest.compress!
       {
-        'count' => count,
+        'count' => tdigest.size,
         'sum' => sum,
         'sumsq' => sumsq,
         'tdigest' => Base64.strict_encode64(tdigest.as_small_bytes),
       }
     end
 
-    # Increments count and updates performance with the difference of +end_time+
-    # and +start_time+.
+    # Increments tdigest timings and updates tdigest with the difference between
+    # +end_time+ and +start_time+.
     #
     # @param [Date] start_time
     # @param [Date] end_time
@@ -51,13 +49,11 @@ module Airbrake
       increment_ms((end_time - start_time) * 1000)
     end
 
-    # Increments count and updates performance with given +ms+ value.
+    # Increments tdigest timings and updates tdigest with given +ms+ value.
     #
     # @param [Float] ms
     # @return [void]
     def increment_ms(ms)
-      self.count += 1
-
       self.sum += ms
       self.sumsq += ms * ms
 
@@ -69,7 +65,7 @@ module Airbrake
     #
     # @return [String]
     def inspect
-      "#<struct Airbrake::Stat count=#{count}, sum=#{sum}, sumsq=#{sumsq}>"
+      "#<struct Airbrake::Stat count=#{tdigest.size}, sum=#{sum}, sumsq=#{sumsq}>"
     end
     alias pretty_print inspect
   end

data/lib/airbrake-ruby/tdigest.rb

@@ -37,14 +37,15 @@ module Airbrake
     end
 
     attr_accessor :centroids
+    attr_reader :size
+
     def initialize(delta = 0.01, k = 25, cx = 1.1)
       @delta = delta
       @k = k
       @cx = cx
       @centroids = RBTree.new
-      @nreset = 0
-      @n = 0
-      reset!
+      @size = 0
+      @last_cumulate = 0
     end
 
     def +(other)
@@ -59,8 +60,8 @@ module Airbrake
       # compression as defined by Java implementation
       size = @centroids.size
       output = [VERBOSE_ENCODING, compression, size]
-      output += @centroids.map { |_, c| c.mean }
-      output += @centroids.map { |_, c| c.n }
+      output += @centroids.each_value.map(&:mean)
+      output += @centroids.each_value.map(&:n)
       output.pack("NGNG#{size}N#{size}")
     end
 
@@ -70,14 +71,14 @@ module Airbrake
       output = [self.class::SMALL_ENCODING, compression, size]
       x = 0
       # delta encoding allows saving 4-bytes floats
-      mean_arr = @centroids.map do |_, c|
+      mean_arr = @centroids.each_value.map do |c|
         val = c.mean - x
         x = c.mean
         val
       end
       output += mean_arr
       # Variable length encoding of numbers
-      c_arr = @centroids.each_with_object([]) do |(_, c), arr|
+      c_arr = @centroids.each_value.each_with_object([]) do |c, arr|
         k = 0
         n = c.n
         while n < 0 || n > 0x7f
@@ -95,7 +96,7 @@ module Airbrake
     # rubocop:enable Metrics/AbcSize
 
     def as_json(_ = nil)
-      @centroids.map { |_, c| c.as_json }
+      @centroids.each_value.map(&:as_json)
     end
 
     def bound_mean(x)
@@ -138,21 +139,17 @@ module Airbrake
     end
 
     def find_nearest(x)
-      return nil if size == 0
-
-      ceil  = @centroids.upper_bound(x)
-      floor = @centroids.lower_bound(x)
+      return if size == 0
 
-      return floor[1] if ceil.nil?
-      return ceil[1]  if floor.nil?
+      upper_key, upper = @centroids.upper_bound(x)
+      lower_key, lower = @centroids.lower_bound(x)
+      return lower unless upper_key
+      return upper unless lower_key
 
-      ceil_key  = ceil[0]
-      floor_key = floor[0]
-
-      if (floor_key - x).abs < (ceil_key - x).abs
-        floor[1]
+      if (lower_key - x).abs < (upper_key - x).abs
+        lower
       else
-        ceil[1]
+        upper
       end
     end
 
@@ -186,7 +183,7 @@ module Airbrake
             mean_cumn += (item - lower.mean) * (upper.mean_cumn - lower.mean_cumn) \
               / (upper.mean - lower.mean)
           end
-          mean_cumn / @n
+          mean_cumn / @size
         end
       end
       is_array ? x : x.first
@@ -207,7 +204,7 @@ module Airbrake
           nil
         else
           _cumulate(true)
-          h = @n * item
+          h = @size * item
           lower, upper = bound_mean_cumn(h)
           if lower.nil? && upper.nil?
             nil
@@ -237,17 +234,12 @@ module Airbrake
 
     def reset!
       @centroids.clear
-      @n = 0
-      @nreset += 1
+      @size = 0
       @last_cumulate = 0
     end
 
-    def size
-      @n || 0
-    end
-
     def to_a
-      @centroids.map { |_, c| c }
+      @centroids.each_value.to_a
     end
 
     # rubocop:disable Metrics/PerceivedComplexity, Metrics/MethodLength
@@ -307,16 +299,16 @@ module Airbrake
 
     private
 
-    def _add_weight(nearest, x, n)
-      nearest.mean += n * (x - nearest.mean) / (nearest.n + n) unless x == nearest.mean
-
-      _cumulate(false, true) if nearest.mean_cumn.nil?
+    def _add_weight(centroid, x, n)
+      unless x == centroid.mean
+        centroid.mean += n * (x - centroid.mean) / (centroid.n + n)
+      end
 
-      nearest.cumn += n
-      nearest.mean_cumn += n / 2.0
-      nearest.n += n
+      _cumulate(false, true) if centroid.mean_cumn.nil?
 
-      nil
+      centroid.cumn += n
+      centroid.mean_cumn += n / 2.0
+      centroid.n += n
     end
 
     # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
@@ -325,17 +317,17 @@ module Airbrake
         factor = if @last_cumulate == 0
                    Float::INFINITY
                  else
-                   (@n.to_f / @last_cumulate)
+                   (@size.to_f / @last_cumulate)
                  end
-        return if @n == @last_cumulate || (!exact && @cx && @cx > factor)
+        return if @size == @last_cumulate || (!exact && @cx && @cx > factor)
       end
 
       cumn = 0
-      @centroids.each do |_, c|
+      @centroids.each_value do |c|
         c.mean_cumn = cumn + c.n / 2.0
         cumn = c.cumn = cumn + c.n
       end
-      @n = @last_cumulate = cumn
+      @size = @last_cumulate = cumn
       nil
     end
     # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
@@ -345,28 +337,25 @@ module Airbrake
     def _digest(x, n)
       # Use 'first' and 'last' instead of min/max because of performance reasons
       # This works because RBTree is sorted
-      min = @centroids.first
-      max = @centroids.last
-
-      min = min.nil? ? nil : min[1]
-      max = max.nil? ? nil : max[1]
+      min = min.last if (min = @centroids.first)
+      max = max.last if (max = @centroids.last)
       nearest = find_nearest(x)
 
-      @n += n
+      @size += n
 
       if nearest && nearest.mean == x
         _add_weight(nearest, x, n)
       elsif nearest == min
-        _new_centroid(x, n, 0)
+        @centroids[x] = Centroid.new(x, n, 0)
       elsif nearest == max
-        _new_centroid(x, n, @n)
+        @centroids[x] = Centroid.new(x, n, @size)
       else
-        p = nearest.mean_cumn.to_f / @n
-        max_n = (4 * @n * @delta * p * (1 - p)).floor
+        p = nearest.mean_cumn.to_f / @size
+        max_n = (4 * @size * @delta * p * (1 - p)).floor
         if max_n - nearest.n >= n
           _add_weight(nearest, x, n)
         else
-          _new_centroid(x, n, nearest.cumn)
+          @centroids[x] = Centroid.new(x, n, nearest.cumn)
         end
       end
 
@@ -382,12 +371,6 @@ module Airbrake
     end
     # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity,
     # rubocop:enable Metrics/AbcSize
-
-    def _new_centroid(x, n, cumn)
-      c = Centroid.new(x, n, cumn)
-      @centroids[x] = c
-      c
-    end
   end
   # rubocop:enable Metrics/ClassLength
 end

data/lib/airbrake-ruby/thread_pool.rb

@@ -45,7 +45,15 @@ module Airbrake
     # @return [Boolean] true if the message was successfully sent to the pool,
     #   false if the queue is full
     def <<(message)
-      return false if backlog >= @queue_size
+      if backlog >= @queue_size
+        logger.error(
+          "#{LOG_LABEL} ThreadPool has reached its capacity of " \
+          "#{@queue_size} and the following message will not be " \
+          "processed: #{message.inspect}",
+        )
+        return false
+      end
+
       @queue << message
       true
     end

data/lib/airbrake-ruby/version.rb

@@ -2,5 +2,5 @@
 # More information: http://semver.org/
 module Airbrake
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '4.13.0'.freeze
+  AIRBRAKE_RUBY_VERSION = '4.13.2'.freeze
 end

data/spec/async_sender_spec.rb

@@ -58,15 +58,6 @@ RSpec.describe Airbrake::AsyncSender do
           'error' => "AsyncSender has reached its capacity of 1",
         )
       end
-
-      it "logs discarded notice" do
-        expect(Airbrake::Loggable.instance).to receive(:error).with(
-          /reached its capacity/,
-        ).at_least(:once)
-
-        15.times { subject.send(notice, Airbrake::Promise.new) }
-        subject.close
-      end
     end
   end
 end

data/spec/config_spec.rb

@@ -163,4 +163,10 @@ RSpec.describe Airbrake::Config do
       end
     end
   end
+
+  describe "#logger" do
+    it "sets logger level to Logger::WARN" do
+      expect(subject.logger.level).to eq(Logger::WARN)
+    end
+  end
 end

data/spec/loggable_spec.rb

@@ -0,0 +1,17 @@
+RSpec.describe Airbrake::Loggable do
+  describe ".instance" do
+    it "returns a logger" do
+      expect(described_class.instance).to be_a(Logger)
+    end
+  end
+
+  describe "#logger" do
+    let(:subject) do
+      Class.new { include Airbrake::Loggable }.new
+    end
+
+    it "returns a logger that has Logger::WARN severity" do
+      expect(subject.logger.level).to eq(Logger::WARN)
+    end
+  end
+end

data/spec/monotonic_time_spec.rb

@@ -9,4 +9,15 @@ RSpec.describe Airbrake::MonotonicTime do
       expect(subject.time_in_ms).to be > old_time
     end
   end
+
+  describe ".time_in_s" do
+    it "returns monotonic time in seconds" do
+      expect(subject.time_in_s).to be_a(Float)
+    end
+
+    it "always returns time in the future" do
+      old_time = subject.time_in_s
+      expect(subject.time_in_s).to be > old_time
+    end
+  end
 end

data/spec/stat_spec.rb

@@ -22,7 +22,6 @@ RSpec.describe Airbrake::Stat do
   describe "#increment_ms" do
     before { subject.increment_ms(1000) }
 
-    its(:count) { is_expected.to eq(1) }
     its(:sum) { is_expected.to eq(1000) }
     its(:sumsq) { is_expected.to eq(1000000) }
 

data/spec/thread_pool_spec.rb

@@ -51,6 +51,15 @@ RSpec.describe Airbrake::ThreadPool do
 
         expect(tasks.size).to be_zero
       end
+
+      it "logs discarded tasks" do
+        expect(Airbrake::Loggable.instance).to receive(:error).with(
+          /reached its capacity/,
+        ).exactly(15).times
+
+        15.times { subject << 1 }
+        subject.close
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 4.13.0
+  version: 4.13.2
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-27 00:00:00.000000000 Z
+date: 2020-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3
@@ -120,6 +120,7 @@ files:
 - spec/helpers.rb
 - spec/ignorable_spec.rb
 - spec/inspectable_spec.rb
+- spec/loggable_spec.rb
 - spec/monotonic_time_spec.rb
 - spec/nested_exception_spec.rb
 - spec/notice_notifier/options_spec.rb
@@ -189,6 +190,7 @@ test_files:
 - spec/tdigest_spec.rb
 - spec/async_sender_spec.rb
 - spec/stat_spec.rb
+- spec/loggable_spec.rb
 - spec/backtrace_spec.rb
 - spec/notice_notifier_spec.rb
 - spec/time_truncate_spec.rb