Merge pull request #526 from airbrake/timing-param

Deprecate :{start,end}_time, add :timing instead

README.md

@@ -737,8 +737,7 @@ Airbrake.notify_request(
   method: 'GET',
   route: '/things/1',
   status_code: 200,
-  start_time: Time.new - 200,
-  end_time: Time.new
+  timing: 123.45 # ms
 )
 ```
 
@@ -792,8 +791,7 @@ Airbrake.notify_query(
   func: 'foo', # optional
   file: 'foo.rb', # optional
   line: 123, # optional
-  start_time: Time.new - 200,
-  end_time: Time.new # optional
+  timing: 123.45 # ms
 )
 ```
 
@@ -844,7 +842,7 @@ Airbrake.notify_performance_breakdown(
   route: '/things/1',
   response_type: 'json',
   groups: { db: 24.0, view: 0.4 }, # ms
-  start_time: Time.new
+  timing: 123.45 # ms
 )
 ```
 

lib/airbrake-ruby.rb

@@ -328,9 +328,8 @@ def merge_context(context)
       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 @@ def merge_context(context)
     #     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 @@ def merge_context(context)
     #   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 @@ def notify_request(request_info, stash = {})
       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 @@ def notify_request_sync(request_info, stash = {})
       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 @@ def notify_request_sync(request_info, stash = {})
     #     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 @@ def notify_query(query_info, stash = {})
       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,16 +431,16 @@ def notify_query_sync(query_info, stash = {})
     #     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
     # @option breakdown_info [String] :method HTTP method
     # @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 @@ def notify_performance_breakdown_sync(breakdown_info, stash = {})
     #   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]

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.
     #

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 @@ def initialize(
       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 @@ def to_h
         'method' => method,
         'route' => route,
         'responseType' => response_type,
-        'time' => @start_time_utc,
+        'time' => @time_utc,
       }.delete_if { |_key, val| val.nil? }
     end
   end

lib/airbrake-ruby/performance_notifier.rb

@@ -62,14 +62,27 @@ def update_payload(resource)
         @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
         @payload[resource][name].increment_ms(ms)
       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?
 

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 @@ def initialize(
       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 @@ def to_h
         'method' => method,
         'route' => route,
         'query' => query,
-        'time' => @start_time_utc,
+        'time' => @time_utc,
         'function' => func,
         'file' => file,
         'line' => line,

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 @@ def initialize(
       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,20 +37,20 @@ def to_h
       {
         '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
 
     def merge(other)
       self.error_count += other.error_count
     end
   end
-  # rubocop:enable Metrics/BlockLength
+  # rubocop:enable Metrics/BlockLength, Metrics/ParameterLists
 end

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 @@ def initialize(
       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 @@ def to_h
         '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