airbrake-ruby 4.10.1 → 4.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48ada7ef05512e70461f565b7d0f501d3109c1b6934449106cb5006bdb7281db
-  data.tar.gz: 343e472ce390b3882543423bdb8ee50a4cc311ff3907f557a553fa57631305d7
+  metadata.gz: 8c5e41d6b33c6a201ef67d32e32e69bbef6e560c1af80dc19ae8f4192d6b84fd
+  data.tar.gz: 34e30b5ce530edc18c512ba0be5392a2c53cdee68ec23eb43174e9690715f821
 SHA512:
-  metadata.gz: 7d68da52b648cff0b0e4c64016f5e0dd6d0143f1cf547e5604ed41ee58f9f03511e689c3acd35eef7df632d998cb56a416212ff1c952c9331ec173459641c20c
-  data.tar.gz: '079ac6ce90ab7b885561e7f17ab6d770630d59cbaa066664c2b0c2cabd4c28b2c594101863ef04b8e4a92e369ac5e9f3c886159f227eec370a485544cf035250'
+  metadata.gz: '0081a23db3f3ff08f56382e97a67685a7c28eb81c5c93963a440a5f216ddf322ffaf8dae6be14a1394edc079dbd1644511f817693a14eebb3e097243f03f74c9'
+  data.tar.gz: c9c58c197046e16f7706cddbfb4caab70837f03b457418ff22f756499efe6bd98762eca8547a9e716af9d04e20c53a4440a9ca83affc7c1713623d3a191cb560

data/lib/airbrake-ruby.rb

@@ -328,9 +328,8 @@ module Airbrake
       notice_notifier.merge_context(context)
     end
 
-    # Increments request statistics of a certain +route+ that was invoked on
-    # +start_time+ and ended on +end_time+ with +method+, and returned
-    # +status_code+.
+    # Increments request statistics of a certain +route+ invoked with +method+,
+    # which returned +status_code+.
     #
     # After a certain amount of time (n seconds) the aggregated route
     # information will be sent to Airbrake.
@@ -343,8 +342,7 @@ module Airbrake
     #     func: 'do_stuff',
     #     file: 'app/models/foo.rb',
     #     line: 452,
-    #     start_time: timestamp,
-    #     end_time: Time.now
+    #     timing: 123.45 # ms
     #   )
     #
     # @param [Hash{Symbol=>Object}] request_info
@@ -358,8 +356,8 @@ module Airbrake
     #   called the query (optional)
     # @option request_info [Integer] :line The line that executes the query
     #   (optional)
-    # @option request_info [Date] :start_time When the request started
-    # @option request_info [Time] :end_time When the request ended (optional)
+    # @option request_info [Float] :timing  How much time it took to process the
+    #   request (in ms)
     # @param [Hash] stash What needs to be appeneded to the stash, so it's
     #   available in filters
     # @return [void]
@@ -371,9 +369,8 @@ module Airbrake
       performance_notifier.notify(request)
     end
 
-    # Synchronously Increments request statistics of a certain +route+ that was
-    # invoked on +start_time+ and ended on +end_time+ with +method+, and
-    # returned +status_code+.
+    # Synchronously increments request statistics of a certain +route+ invoked
+    # with +method+, which returned +status_code+.
     # @since v4.10.0
     # @see .notify_request
     def notify_request_sync(request_info, stash = {})
@@ -382,9 +379,8 @@ module Airbrake
       performance_notifier.notify_sync(request)
     end
 
-    # Increments SQL statistics of a certain +query+ that was invoked on
-    # +start_time+ and finished on +end_time+. When +method+ and +route+ are
-    # provided, the query is grouped by these parameters.
+    # Increments SQL statistics of a certain +query+. When +method+ and +route+
+    # are provided, the query is grouped by these parameters.
     #
     # After a certain amount of time (n seconds) the aggregated query
     # information will be sent to Airbrake.
@@ -394,18 +390,17 @@ module Airbrake
     #     method: 'GET',
     #     route: '/things',
     #     query: 'SELECT * FROM things',
-    #     start_time: timestamp,
-    #     end_time: Time.now
+    #     timing: 123.45 # ms
     #   )
     #
     # @param [Hash{Symbol=>Object}] query_info
-    # @option request_info [String] :method The HTTP method that triggered this
+    # @option query_info [String] :method The HTTP method that triggered this
     #   SQL query (optional)
-    # @option request_info [String] :route The route that triggered this SQL
+    # @option query_info [String] :route The route that triggered this SQL
     #    query (optional)
-    # @option request_info [String] :query The query that was executed
-    # @option request_info [Date] :start_time When the query started executing
-    # @option request_info [Time] :end_time When the query finished (optional)
+    # @option query_info [String] :query The query that was executed
+    # @option query_info [Float] :timing How much time it took to process the
+    #   query (in ms)
     # @param [Hash] stash What needs to be appeneded to the stash, so it's
     #   available in filters
     # @return [void]
@@ -417,9 +412,9 @@ module Airbrake
       performance_notifier.notify(query)
     end
 
-    # Synchronously increments SQL statistics of a certain +query+ that was
-    # invoked on +start_time+ and finished on +end_time+. When +method+ and
-    # +route+ are provided, the query is grouped by these parameters.
+    # Synchronously increments SQL statistics of a certain +query+. When
+    # +method+ and +route+ are provided, the query is grouped by these
+    # parameters.
     # @since v4.10.0
     # @see .notify_query
     def notify_query_sync(query_info, stash = {})
@@ -436,8 +431,7 @@ module Airbrake
     #     route: '/thing/:id/create',
     #     response_type: 'json',
     #     groups: { db: 24.0, view: 0.4 }, # ms
-    #     start_time: timestamp,
-    #     end_time: Time.now
+    #     timing: 123.45 # ms
     #   )
     #
     # @param [Hash{Symbol=>Object}] breakdown_info
@@ -445,7 +439,8 @@ module Airbrake
     # @option breakdown_info [String] :route
     # @option breakdown_info [String] :response_type
     # @option breakdown_info [Array<Hash{Symbol=>Float}>] :groups
-    # @option breakdown_info [Date] :start_time
+    # @option breakdown_info [Float] :timing How much time it took to process
+    #   the performance breakdown (in ms)
     # @param [Hash] stash What needs to be appeneded to the stash, so it's
     #   available in filters
     # @return [void]
@@ -481,6 +476,8 @@ module Airbrake
     #   failed
     # @option queue_info [Array<Hash{Symbol=>Float}>] :groups Where the job
     #   spent its time
+    # @option breakdown_info [Float] :timing How much time it took to process
+    #   the queue (in ms)
     # @param [Hash] stash What needs to be appended to the stash, so it's
     #   available in filters
     # @return [void]

data/lib/airbrake-ruby/benchmark.rb

@@ -2,7 +2,7 @@ module Airbrake
   # Benchmark benchmarks Ruby code.
   #
   # @since v4.2.4
-  # @api private
+  # @api public
   class Benchmark
     # Measures monotonic time for the given operation.
     #

data/lib/airbrake-ruby/config.rb

@@ -101,6 +101,12 @@ module Airbrake
     # @since v4.6.0
     attr_accessor :query_stats
 
+    # @return [Boolean] true if the library should send job/queue/worker stats
+    #   to Airbrake, false otherwise
+    # @api public
+    # @since v4.12.0
+    attr_accessor :job_stats
+
     class << self
       # @return [Config]
       attr_writer :instance
@@ -139,6 +145,7 @@ module Airbrake
       self.performance_stats = true
       self.performance_stats_flush_period = 15
       self.query_stats = true
+      self.job_stats = true
 
       merge(user_config)
     end
@@ -213,6 +220,8 @@ module Airbrake
         promise.reject("The Performance Stats feature is disabled")
       elsif resource.is_a?(Airbrake::Query) && !query_stats
         promise.reject("The Query Stats feature is disabled")
+      elsif resource.is_a?(Airbrake::Queue) && !job_stats
+        promise.reject("The Job Stats feature is disabled")
       else
         promise
       end

data/lib/airbrake-ruby/notice_notifier.rb

@@ -55,7 +55,8 @@ module Airbrake
     def build_notice(exception, params = {})
       if @async_sender.closed?
         raise Airbrake::Error,
-              "attempted to build #{exception} with closed Airbrake instance"
+              "Airbrake is closed; can't build exception: " \
+              "#{exception.class}: #{exception}"
       end
 
       if exception.is_a?(Airbrake::Notice)

data/lib/airbrake-ruby/performance_breakdown.rb

@@ -7,7 +7,8 @@ module Airbrake
   # @since v4.2.0
   # rubocop:disable Metrics/BlockLength, Metrics/ParameterLists
   PerformanceBreakdown = Struct.new(
-    :method, :route, :response_type, :groups, :start_time, :end_time
+    :method, :route, :response_type, :groups, :start_time, :end_time, :timing,
+    :time
   ) do
     include HashKeyable
     include Ignorable
@@ -19,11 +20,15 @@ module Airbrake
       route:,
       response_type:,
       groups:,
-      start_time:,
-      end_time: start_time + 1
+      start_time: Time.now,
+      end_time: start_time + 1,
+      timing: nil,
+      time: Time.now
     )
-      @start_time_utc = TimeTruncate.utc_truncate_minutes(start_time)
-      super(method, route, response_type, groups, start_time, end_time)
+      @time_utc = TimeTruncate.utc_truncate_minutes(time)
+      super(
+        method, route, response_type, groups, start_time, end_time, timing, time
+      )
     end
 
     def destination
@@ -39,7 +44,7 @@ module Airbrake
         'method' => method,
         'route' => route,
         'responseType' => response_type,
-        'time' => @start_time_utc,
+        'time' => @time_utc,
       }.delete_if { |_key, val| val.nil? }
     end
   end

data/lib/airbrake-ruby/performance_notifier.rb

@@ -62,7 +62,7 @@ module Airbrake
         @payload[resource] = { total: Airbrake::Stat.new }
       end
 
-      @payload[resource][:total].increment(resource.start_time, resource.end_time)
+      update_total(resource, @payload[resource][:total])
 
       resource.groups.each do |name, ms|
         @payload[resource][name] ||= Airbrake::Stat.new
@@ -70,6 +70,19 @@ module Airbrake
       end
     end
 
+    def update_total(resource, total)
+      if resource.timing
+        total.increment_ms(resource.timing)
+      else
+        loc = caller_locations(6..6).first
+        Kernel.warn(
+          "#{loc.path}:#{loc.lineno}: warning: :start_time and :end_time are " \
+          "deprecated. Use :timing & :time instead",
+        )
+        total.increment(resource.start_time, resource.end_time)
+      end
+    end
+
     def schedule_flush
       return if @payload.empty?
 
@@ -107,14 +120,13 @@ module Airbrake
     end
 
     def send_resource(resource, sync:)
-      promise = @config.check_configuration
-      return promise if promise.rejected?
-
-      promise = @config.check_performance_options(resource)
+      promise = check_configuration(resource)
       return promise if promise.rejected?
 
       @filter_chain.refine(resource)
-      return if resource.ignored?
+      if resource.ignored?
+        return Promise.new.reject("#{resource.class} was ignored by a filter")
+      end
 
       @mutex.synchronize do
         update_payload(resource)
@@ -126,6 +138,20 @@ module Airbrake
       end
     end
 
+    def check_configuration(resource)
+      promise = @config.check_configuration
+      return promise if promise.rejected?
+
+      promise = @config.check_performance_options(resource)
+      return promise if promise.rejected?
+
+      if resource.timing && resource.timing == 0
+        return Promise.new.reject(':timing cannot be zero')
+      end
+
+      Promise.new
+    end
+
     def send(sender, payload, promise)
       signature = "#{self.class.name}##{__method__}"
       raise "#{signature}: payload (#{payload}) cannot be empty. Race?" if payload.none?

data/lib/airbrake-ruby/query.rb

@@ -6,7 +6,8 @@ module Airbrake
   # @since v3.2.0
   # rubocop:disable Metrics/ParameterLists, Metrics/BlockLength
   Query = Struct.new(
-    :method, :route, :query, :func, :file, :line, :start_time, :end_time
+    :method, :route, :query, :func, :file, :line, :start_time, :end_time,
+    :timing, :time
   ) do
     include HashKeyable
     include Ignorable
@@ -21,11 +22,16 @@ module Airbrake
       func: nil,
       file: nil,
       line: nil,
-      start_time:,
-      end_time: start_time + 1
+      start_time: Time.now,
+      end_time: start_time + 1,
+      timing: nil,
+      time: Time.now
     )
-      @start_time_utc = TimeTruncate.utc_truncate_minutes(start_time)
-      super(method, route, query, func, file, line, start_time, end_time)
+      @time_utc = TimeTruncate.utc_truncate_minutes(time)
+      super(
+        method, route, query, func, file, line, start_time, end_time, timing,
+        time
+      )
     end
 
     def destination
@@ -41,7 +47,7 @@ module Airbrake
         'method' => method,
         'route' => route,
         'query' => query,
-        'time' => @start_time_utc,
+        'time' => @time_utc,
         'function' => func,
         'file' => file,
         'line' => line,

data/lib/airbrake-ruby/queue.rb

@@ -4,8 +4,10 @@ module Airbrake
   # @see Airbrake.notify_queue
   # @api public
   # @since v4.9.0
-  # rubocop:disable Metrics/BlockLength
-  Queue = Struct.new(:queue, :error_count, :groups, :start_time, :end_time) do
+  # rubocop:disable Metrics/BlockLength, Metrics/ParameterLists
+  Queue = Struct.new(
+    :queue, :error_count, :groups, :start_time, :end_time, :timing, :time
+  ) do
     include HashKeyable
     include Ignorable
     include Stashable
@@ -15,10 +17,12 @@ module Airbrake
       error_count:,
       groups: {},
       start_time: Time.now,
-      end_time: start_time + 1
+      end_time: start_time + 1,
+      timing: nil,
+      time: Time.now
     )
-      @start_time_utc = TimeTruncate.utc_truncate_minutes(start_time)
-      super(queue, error_count, groups, start_time, end_time)
+      @time_utc = TimeTruncate.utc_truncate_minutes(time)
+      super(queue, error_count, groups, start_time, end_time, timing, time)
     end
 
     def destination
@@ -33,14 +37,14 @@ module Airbrake
       {
         'queue' => queue,
         'errorCount' => error_count,
-        'time' => @start_time_utc,
+        'time' => @time_utc,
       }
     end
 
     def hash
       {
         'queue' => queue,
-        'time' => @start_time_utc,
+        'time' => @time_utc,
       }.hash
     end
 
@@ -48,5 +52,5 @@ module Airbrake
       self.error_count += other.error_count
     end
   end
-  # rubocop:enable Metrics/BlockLength
+  # rubocop:enable Metrics/BlockLength, Metrics/ParameterLists
 end

data/lib/airbrake-ruby/request.rb

@@ -4,8 +4,10 @@ module Airbrake
   # @see Airbrake.notify_request
   # @api public
   # @since v3.2.0
-  # rubocop:disable Metrics/BlockLength
-  Request = Struct.new(:method, :route, :status_code, :start_time, :end_time) do
+  # rubocop:disable Metrics/BlockLength, Metrics/ParameterLists
+  Request = Struct.new(
+    :method, :route, :status_code, :start_time, :end_time, :timing, :time
+  ) do
     include HashKeyable
     include Ignorable
     include Stashable
@@ -16,11 +18,13 @@ module Airbrake
       method:,
       route:,
       status_code:,
-      start_time:,
-      end_time: start_time + 1
+      start_time: Time.now,
+      end_time: start_time + 1,
+      timing: nil,
+      time: Time.now
     )
-      @start_time_utc = TimeTruncate.utc_truncate_minutes(start_time)
-      super(method, route, status_code, start_time, end_time)
+      @time_utc = TimeTruncate.utc_truncate_minutes(time)
+      super(method, route, status_code, start_time, end_time, timing, time)
     end
 
     def destination
@@ -36,9 +40,9 @@ module Airbrake
         'method' => method,
         'route' => route,
         'statusCode' => status_code,
-        'time' => @start_time_utc,
+        'time' => @time_utc,
       }.delete_if { |_key, val| val.nil? }
     end
   end
-  # rubocop:enable Metrics/BlockLength
+  # rubocop:enable Metrics/BlockLength, Metrics/ParameterLists
 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.10.1'.freeze
+  AIRBRAKE_RUBY_VERSION = '4.12.0'.freeze
 end

data/spec/airbrake_spec.rb

@@ -171,7 +171,7 @@ RSpec.describe Airbrake do
           method: 'GET',
           route: '/',
           status_code: 200,
-          start_time: Time.now,
+          timing: 1,
         )
       end
     end
@@ -187,7 +187,7 @@ RSpec.describe Airbrake do
             method: 'GET',
             route: '/',
             status_code: 200,
-            start_time: Time.now,
+            timing: 1,
           },
           request_id: 1,
         )
@@ -204,7 +204,7 @@ RSpec.describe Airbrake do
           method: 'GET',
           route: '/',
           status_code: 200,
-          start_time: Time.now,
+          timing: 1,
         },
         request_id: 1,
       )
@@ -222,7 +222,7 @@ RSpec.describe Airbrake do
           method: 'GET',
           route: '/',
           query: '',
-          start_time: Time.now,
+          timing: 1,
         )
       end
     end
@@ -238,7 +238,7 @@ RSpec.describe Airbrake do
             method: 'GET',
             route: '/',
             query: '',
-            start_time: Time.now,
+            timing: 1,
           },
           request_id: 1,
         )
@@ -255,7 +255,7 @@ RSpec.describe Airbrake do
           method: 'GET',
           route: '/',
           query: '',
-          start_time: Time.now,
+          timing: 1,
         },
         request_id: 1,
       )
@@ -273,7 +273,7 @@ RSpec.describe Airbrake do
           method: 'GET',
           route: '/',
           query: '',
-          start_time: Time.now,
+          timing: 1,
         )
       end
     end
@@ -292,7 +292,7 @@ RSpec.describe Airbrake do
             route: '/',
             response_type: :html,
             groups: {},
-            start_time: Time.now,
+            timing: 1,
           },
           request_id: 1,
         )
@@ -310,7 +310,7 @@ RSpec.describe Airbrake do
           route: '/',
           response_type: :html,
           groups: {},
-          start_time: Time.now,
+          timing: 1,
         },
         request_id: 1,
       )

data/spec/config_spec.rb

@@ -22,6 +22,7 @@ RSpec.describe Airbrake::Config do
   its(:performance_stats) { is_expected.to eq(true) }
   its(:performance_stats_flush_period) { is_expected.to eq(15) }
   its(:query_stats) { is_expected.to eq(true) }
+  its(:job_stats) { is_expected.to eq(true) }
 
   describe "#new" do
     context "when user config is passed" do
@@ -110,9 +111,7 @@ RSpec.describe Airbrake::Config do
 
   describe "#check_performance_options" do
     it "returns a promise" do
-      resource = Airbrake::Query.new(
-        method: '', route: '', query: '', start_time: Time.now,
-      )
+      resource = Airbrake::Query.new(method: '', route: '', query: '', timing: 1)
       expect(subject.check_performance_options(resource))
         .to be_an(Airbrake::Promise)
     end
@@ -122,7 +121,7 @@ RSpec.describe Airbrake::Config do
 
       let(:resource) do
         Airbrake::Request.new(
-          method: 'GET', route: '/foo', status_code: 200, start_time: Time.new,
+          method: 'GET', route: '/foo', status_code: 200, timing: 1,
         )
       end
 
@@ -138,9 +137,7 @@ RSpec.describe Airbrake::Config do
       before { subject.query_stats = false }
 
       let(:resource) do
-        Airbrake::Query.new(
-          method: 'GET', route: '/foo', query: '', start_time: Time.new,
-        )
+        Airbrake::Query.new(method: 'GET', route: '/foo', query: '', timing: 1)
       end
 
       it "returns a rejected promise" do
@@ -150,5 +147,20 @@ RSpec.describe Airbrake::Config do
         )
       end
     end
+
+    context "when job stats are disabled" do
+      before { subject.job_stats = false }
+
+      let(:resource) do
+        Airbrake::Queue.new(queue: 'foo_queue', error_count: 0, timing: 1)
+      end
+
+      it "returns a rejected promise" do
+        promise = subject.check_performance_options(resource)
+        expect(promise.value).to eq(
+          'error' => "The Job Stats feature is disabled",
+        )
+      end
+    end
   end
 end

data/spec/filters/sql_filter_spec.rb

@@ -13,9 +13,7 @@ RSpec.describe Airbrake::Filters::SqlFilter do
   shared_examples "query blacklisting" do |query, opts|
     it "ignores '#{query}'" do
       filter = described_class.new('postgres')
-      q = Airbrake::Query.new(
-        query: query, method: 'GET', route: '/', start_time: Time.now,
-      )
+      q = Airbrake::Query.new(query: query, method: 'GET', route: '/', timing: 1)
       filter.call(q)
 
       expect(q.ignored?).to eq(opts[:should_ignore])

data/spec/notice_notifier_spec.rb

@@ -328,9 +328,9 @@ RSpec.describe Airbrake::NoticeNotifier do
       end
 
       it "raises error" do
-        expect { subject.build_notice(Exception.new) }.to raise_error(
+        expect { subject.build_notice(Exception.new('oops')) }.to raise_error(
           Airbrake::Error,
-          'attempted to build Exception with closed Airbrake instance',
+          "Airbrake is closed; can't build exception: Exception: oops",
         )
       end
     end

data/spec/performance_notifier_spec.rb

@@ -16,6 +16,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
       performance_stats: true,
       performance_stats_flush_period: 0,
       query_stats: true,
+      job_stats: true,
     )
   end
 
@@ -29,8 +30,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           func: 'foo',
           file: 'foo.rb',
           line: 123,
-          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
-          end_time: Time.new(2018, 1, 1, 0, 50, 0, 0),
+          timing: 60000,
+          time: Time.new(2018, 1, 1, 0, 49, 0, 0),
         ),
       )
       subject.close
@@ -59,8 +60,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'POST',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
-          end_time: Time.new(2018, 1, 1, 0, 50, 0, 0),
+          timing: 60000,
+          time: Time.new(2018, 1, 1, 0, 49, 0, 0),
         ),
       )
       subject.close
@@ -86,8 +87,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'DELETE',
           route: '/routes-breakdowns',
           response_type: 'json',
-          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
-          end_time: Time.new(2018, 1, 1, 0, 50, 0, 0),
+          timing: 60000,
+          time: Time.new(2018, 1, 1, 0, 49, 0, 0),
           groups: { db: 131, view: 421 },
         ),
       )
@@ -128,8 +129,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           queue: 'emails',
           error_count: 2,
           groups: { redis: 131, sql: 421 },
-          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
-          end_time: Time.new(2018, 1, 1, 0, 50, 0, 0),
+          timing: 60000,
+          time: Time.new(2018, 1, 1, 0, 49, 0, 0),
         ),
       )
       subject.close
@@ -168,7 +169,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'GET',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 0, 20, 0),
+          timing: 60000,
+          time: Time.new(2018, 1, 1, 0, 0, 20, 0),
         ),
       )
       subject.close
@@ -184,7 +186,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'GET',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 0, 20, 0),
+          timing: 213,
         ),
       )
       subject.notify(
@@ -192,7 +194,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'GET',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 0, 50, 0),
+          timing: 123,
         ),
       )
       subject.close
@@ -208,8 +210,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'GET',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 0, 49, 0),
-          end_time: Time.new(2018, 1, 1, 0, 0, 50, 0),
+          timing: 1000,
+          time: Time.new(2018, 1, 1, 0, 0, 49, 0),
         ),
       )
       subject.notify(
@@ -217,8 +219,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'GET',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 1, 49, 0),
-          end_time: Time.new(2018, 1, 1, 0, 1, 55, 0),
+          timing: 6000,
+          time: Time.new(2018, 1, 1, 0, 1, 49, 0),
         ),
       )
       subject.close
@@ -244,8 +246,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'GET',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
-          end_time: Time.new(2018, 1, 1, 0, 50, 0, 0),
+          timing: 60000,
+          time: Time.new(2018, 1, 1, 0, 49, 0, 0),
         ),
       )
       subject.notify(
@@ -253,8 +255,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'POST',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
-          end_time: Time.new(2018, 1, 1, 0, 50, 0, 0),
+          timing: 60000,
+          time: Time.new(2018, 1, 1, 0, 49, 0, 0),
         ),
       )
       subject.close
@@ -280,8 +282,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'DELETE',
           route: '/routes-breakdowns',
           response_type: 'json',
-          start_time: Time.new(2018, 1, 1, 0, 0, 20, 0),
-          end_time: Time.new(2018, 1, 1, 0, 0, 22, 0),
+          timing: 2000,
+          time: Time.new(2018, 1, 1, 0, 0, 20, 0),
           groups: { db: 131, view: 421 },
         ),
       )
@@ -290,8 +292,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'DELETE',
           route: '/routes-breakdowns',
           response_type: 'json',
-          start_time: Time.new(2018, 1, 1, 0, 0, 30, 0),
-          end_time: Time.new(2018, 1, 1, 0, 0, 32, 0),
+          timing: 2000,
+          time: Time.new(2018, 1, 1, 0, 0, 30, 0),
           groups: { db: 55, view: 11 },
         ),
       )
@@ -332,8 +334,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           queue: 'emails',
           error_count: 2,
           groups: { redis: 131, sql: 421 },
-          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
-          end_time: Time.new(2018, 1, 1, 0, 50, 0, 0),
+          timing: 60000,
+          time: Time.new(2018, 1, 1, 0, 49, 0, 0),
         ),
       )
       subject.notify(
@@ -341,8 +343,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           queue: 'emails',
           error_count: 3,
           groups: { redis: 131, sql: 421 },
-          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
-          end_time: Time.new(2018, 1, 1, 0, 50, 0, 0),
+          timing: 60000,
+          time: Time.new(2018, 1, 1, 0, 49, 0, 0),
         ),
       )
       subject.close
@@ -381,7 +383,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'GET',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+          timing: 123,
         ),
       )
       subject.close
@@ -392,7 +394,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
 
     it "checks performance stat configuration" do
       request = Airbrake::Request.new(
-        method: 'GET', route: '/foo', status_code: 200, start_time: Time.new,
+        method: 'GET', route: '/foo', status_code: 200, timing: 123,
       )
       expect(Airbrake::Config.instance).to receive(:check_performance_options)
         .with(request).and_return(Airbrake::Promise.new)
@@ -408,7 +410,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'POST',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new,
+          timing: 123,
         ),
       )
       subject.close
@@ -445,7 +447,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
             method: 'GET',
             route: '/foo',
             status_code: 200,
-            start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+            timing: 123,
           ),
         )
 
@@ -454,7 +456,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
             method: 'POST',
             route: '/foo',
             query: 'SELECT * FROM things',
-            start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+            timing: 123,
           ),
         )
 
@@ -474,7 +476,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
             method: 'GET',
             route: '/foo',
             status_code: 200,
-            start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+            timing: 1,
           ),
         )
         subject.close
@@ -488,13 +490,29 @@ RSpec.describe Airbrake::PerformanceNotifier do
             method: 'POST',
             route: '/foo',
             query: 'SELECT * FROM things',
-            start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+            timing: 1,
           ),
         )
         subject.close
 
         expect(a_request(:put, queries)).not_to have_been_made
       end
+
+      it "returns a rejected promise" do
+        promise = subject.notify(
+          Airbrake::Query.new(
+            method: 'POST',
+            route: '/foo',
+            query: 'SELECT * FROM things',
+            timing: 1,
+          ),
+        )
+        subject.close
+
+        expect(promise.value).to eq(
+          'error' => 'Airbrake::Query was ignored by a filter',
+        )
+      end
     end
 
     context "when a filter that modifies payload was defined" do
@@ -510,7 +528,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
             method: 'POST',
             route: '/foo',
             query: 'SELECT * FROM things',
-            start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+            timing: 123,
           ),
         )
         subject.close
@@ -522,6 +540,49 @@ RSpec.describe Airbrake::PerformanceNotifier do
         ).to have_been_made
       end
     end
+
+    context "when :start_time is specified (deprecated)" do
+      before do
+        allow(Kernel).to receive(:warn)
+      end
+
+      it "uses the value of :start_time to update stat" do
+        subject.notify(
+          Airbrake::Query.new(
+            method: 'POST',
+            route: '/foo',
+            query: 'SELECT * FROM things',
+            start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+            end_time: Time.new(2018, 1, 1, 0, 50, 0, 0),
+          ),
+        )
+        subject.close
+
+        expect(
+          a_request(:put, queries).with(
+            body: /"count":1,"sum":60000.0,"sumsq":3600000000.0/,
+          ),
+        ).to have_been_made
+      end
+    end
+
+    context "when provided :timing is zero" do
+      it "doesn't notify" do
+        queue = Airbrake::Queue.new(queue: 'bananas', error_count: 0, timing: 0)
+        subject.notify(queue)
+        subject.close
+
+        expect(a_request(:put, queues)).not_to have_been_made
+      end
+
+      it "returns a rejected promise" do
+        queue = Airbrake::Queue.new(queue: 'bananas', error_count: 0, timing: 0)
+        promise = subject.notify(queue)
+        subject.close
+
+        expect(promise.value).to eq('error' => ':timing cannot be zero')
+      end
+    end
   end
 
   describe "#notify_sync" do
@@ -531,7 +592,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'POST',
           route: '/foo',
           query: 'SELECT * FROM things',
-          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+          timing: 123,
         ),
       )
 
@@ -560,7 +621,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'POST',
           route: '/foo',
           query: 'SELECT * FROM things',
-          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+          timing: 123,
         ),
       )
       subject.close
@@ -591,7 +652,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'POST',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+          timing: 123,
         ),
       )
       subject.close

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 4.10.1
+  version: 4.12.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-12 00:00:00.000000000 Z
+date: 2020-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3