airbrake-ruby 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25d739899ae0250aa01c5e81ab01d76bbcfac28d
-  data.tar.gz: fca6e05b839805cb5d4b4171145c1dfeb4b4890b
+  metadata.gz: da152828a1f9be5664faef3a2bce8cb09755ea4f
+  data.tar.gz: 3db1f8a4dc6f496c1067d7d0e295054ee6c8fce2
 SHA512:
-  metadata.gz: 13fd52e48ce2f8405640785323f2cc330d9364496b58ce0b8fb416b28baff5584a95b97ded5441ee47aca872af43cf7251ebb7cfd6d3b1660c523ee774e6a870
-  data.tar.gz: d96f9bb73da48029a993bda925ec727a945177300721eb521f5966bac962f6d9ae2941cd191b4bc2d5497c07da7764c5d7c740bf5bb7fc0a30b61c50b263c08f
+  metadata.gz: cbf759c4bfb802574e23176ae0629b46bc4c7ddf73221477aa3e5b4af6dae02b4ca7d4b7e76984486e3b5b8f4d0a1d997bbf32c46d8076054555c83851160cfa
+  data.tar.gz: 3055d714f7d8263efd11e9de8748c04bb84031382fb1e377eef2333c2712636b48d774186a5f0b6d092de9d1fa73d43446dbf06f5b41e4587acf94a7cb05a92a

data/lib/airbrake-ruby.rb

@@ -46,6 +46,7 @@ require 'airbrake-ruby/time_truncate'
 require 'airbrake-ruby/tdigest'
 require 'airbrake-ruby/query'
 require 'airbrake-ruby/request'
+require 'airbrake-ruby/performance_breakdown'
 
 # Airbrake is a thin wrapper around instances of the notifier classes (such as
 # notice, performance & deploy notifiers). It creates a way to access them via a
@@ -352,7 +353,6 @@ module Airbrake
     #   )
     #
     # @param [Hash{Symbol=>Object}] query_info
-    # @option request_info [String] :environment (optional)
     # @option request_info [String] :method The HTTP method that triggered this
     #   SQL query (optional)
     # @option request_info [String] :route The route that triggered this SQL
@@ -367,6 +367,30 @@ module Airbrake
       @performance_notifier.notify(Query.new(query_info))
     end
 
+    # Increments performance breakdown statistics of a certain route.
+    #
+    # @example
+    #   Airbrake.notify_request(
+    #     method: 'POST',
+    #     route: '/thing/:id/create',
+    #     response_type: 'json',
+    #     groups: { db: 24.0, view: 0.4 }, # ms
+    #     start_time: timestamp,
+    #     end_time: Time.now
+    #   )
+    #
+    # @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
+    # @return [void]
+    # @since v4.2.0
+    def notify_performance_breakdown(breakdown_info)
+      @performance_notifier.notify(PerformanceBreakdown.new(breakdown_info))
+    end
+
     # Runs a callback before {.notify_request} or {.notify_query} kicks in. This
     # is useful if you want to ignore specific resources or filter the data the
     # resource contains.

data/lib/airbrake-ruby/performance_breakdown.rb

@@ -0,0 +1,44 @@
+module Airbrake
+  # PerformanceBreakdown holds data that shows how much time a request spent
+  # doing certaing subtasks such as (DB querying, view rendering, etc).  request
+  #
+  # @see Airbrake.notify_breakdown
+  # @api public
+  # @since v4.3.0
+  # rubocop:disable Metrics/BlockLength, Metrics/ParameterLists
+  PerformanceBreakdown = Struct.new(
+    :method, :route, :response_type, :groups, :start_time, :end_time
+  ) do
+    include HashKeyable
+    include Ignorable
+
+    def initialize(
+      method:,
+      route:,
+      response_type:,
+      groups:,
+      start_time:,
+      end_time: Time.now
+    )
+      super(method, route, response_type, groups, start_time, end_time)
+    end
+
+    def destination
+      'routes-breakdowns'
+    end
+
+    def cargo
+      'routes'
+    end
+
+    def to_h
+      {
+        'method' => method,
+        'route' => route,
+        'responseType' => response_type,
+        'time' => TimeTruncate.utc_truncate_minutes(start_time)
+      }.delete_if { |_key, val| val.nil? }
+    end
+  end
+  # rubocop:enable Metrics/BlockLength, Metrics/ParameterLists
+end

data/lib/airbrake-ruby/performance_notifier.rb

@@ -34,14 +34,8 @@ module Airbrake
       return if resource.ignored?
 
       @mutex.synchronize do
-        @payload[resource] ||= Airbrake::Stat.new
-        @payload[resource].increment(resource.start_time, resource.end_time)
-
-        if @flush_period > 0
-          schedule_flush(promise)
-        else
-          send(@payload, promise)
-        end
+        update_payload(resource)
+        @flush_period > 0 ? schedule_flush(promise) : send(@payload, promise)
       end
 
       promise
@@ -59,6 +53,16 @@ module Airbrake
 
     private
 
+    def update_payload(resource)
+      @payload[resource] ||= { total: Airbrake::Stat.new }
+      @payload[resource][:total].increment(resource.start_time, resource.end_time)
+
+      resource.groups.each do |name, ms|
+        @payload[resource][name] ||= Airbrake::Stat.new
+        @payload[resource][name].increment_ms(ms)
+      end
+    end
+
     def schedule_flush(promise)
       @schedule_flush ||= Thread.new do
         sleep(@flush_period)
@@ -74,27 +78,50 @@ module Airbrake
       end
     end
 
-    # rubocop:disable Metrics/AbcSize
     def send(payload, promise)
       signature = "#{self.class.name}##{__method__}"
       raise "#{signature}: payload (#{payload}) cannot be empty. Race?" if payload.none?
 
       logger.debug("#{LOG_LABEL} #{signature}: #{payload}")
 
-      payload.group_by { |k, _v| k.name }.each do |resource_name, data|
-        data = { resource_name => data.map { |k, v| k.to_h.merge!(v.to_h) } }
-        data['environment'] = @config.environment if @config.environment
-
-        @sender.send(
-          data,
-          promise,
-          URI.join(
-            @config.host,
-            "api/v5/projects/#{@config.project_id}/#{resource_name}-stats"
-          )
+      with_grouped_payload(payload) do |resource_hash, destination|
+        url = URI.join(
+          @config.host,
+          "api/v5/projects/#{@config.project_id}/#{destination}"
         )
+        @sender.send(resource_hash, promise, url)
+      end
+
+      promise
+    end
+
+    def with_grouped_payload(raw_payload)
+      grouped_payload = raw_payload.group_by do |resource, _stats|
+        [resource.cargo, resource.destination]
+      end
+
+      grouped_payload.each do |(cargo, destination), resources|
+        payload = {}
+        payload[cargo] = serialize_resources(resources)
+        payload['environment'] = @config.environment if @config.environment
+
+        yield(payload, destination)
+      end
+    end
+
+    def serialize_resources(resources)
+      resources.map do |resource, stats|
+        resource_hash = resource.to_h.merge!(stats[:total].to_h)
+
+        if resource.groups.any?
+          group_stats = stats.reject { |name, _stat| name == :total }
+          resource_hash['groups'] = group_stats.merge(group_stats) do |_name, stat|
+            stat.to_h
+          end
+        end
+
+        resource_hash
       end
     end
-    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/airbrake-ruby/query.rb

@@ -24,10 +24,18 @@ module Airbrake
       super(method, route, query, func, file, line, start_time, end_time)
     end
 
-    def name
+    def destination
+      'queries-stats'
+    end
+
+    def cargo
       'queries'
     end
 
+    def groups
+      {}
+    end
+
     def to_h
       {
         'method' => method,

data/lib/airbrake-ruby/request.rb

@@ -4,6 +4,7 @@ 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
     include HashKeyable
     include Ignorable
@@ -18,10 +19,18 @@ module Airbrake
       super(method, route, status_code, start_time, end_time)
     end
 
-    def name
+    def destination
+      'routes-stats'
+    end
+
+    def cargo
       'routes'
     end
 
+    def groups
+      {}
+    end
+
     def to_h
       {
         'method' => method,
@@ -31,4 +40,5 @@ module Airbrake
       }.delete_if { |_key, val| val.nil? }
     end
   end
+  # rubocop:enable Metrics/BlockLength
 end

data/lib/airbrake-ruby/stat.rb

@@ -43,10 +43,16 @@ module Airbrake
     # @return [void]
     def increment(start_time, end_time = nil)
       end_time ||= Time.new
+      increment_ms((end_time - start_time) * 1000)
+    end
 
+    # Increments count and updates performance with given +ms+ value.
+    #
+    # @param [Float] ms
+    # @return [void]
+    def increment_ms(ms)
       self.count += 1
 
-      ms = (end_time - start_time) * 1000
       self.sum += ms
       self.sumsq += ms * ms
 

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.1.0'.freeze
+  AIRBRAKE_RUBY_VERSION = '4.2.0'.freeze
 end

data/spec/notice_notifier_spec.rb

@@ -185,10 +185,6 @@ RSpec.describe Airbrake::NoticeNotifier do
   describe "#notify_sync" do
     let(:endpoint) { 'https://api.airbrake.io/api/v3/projects/1/notices' }
 
-    let(:user_params) do
-      { project_id: 1, project_key: 'abc', logger: Logger.new('/dev/null') }
-    end
-
     let(:body) do
       {
         'id' => '00054414-b147-6ffa-85d6-1524d83362a6',

data/spec/notice_notifier_spec/options_spec.rb

@@ -1,8 +1,4 @@
 RSpec.describe Airbrake::NoticeNotifier do
-  def expect_a_request_with_body(body)
-    expect(a_request(:post, endpoint).with(body: body)).to have_been_made.once
-  end
-
   let(:project_id) { 105138 }
   let(:project_key) { 'fd04e13d806a90f96614ad8e529b2822' }
   let(:localhost) { 'http://localhost:8080' }

data/spec/performance_notifier_spec.rb

@@ -1,10 +1,12 @@
 RSpec.describe Airbrake::PerformanceNotifier do
   let(:routes) { 'https://api.airbrake.io/api/v5/projects/1/routes-stats' }
   let(:queries) { 'https://api.airbrake.io/api/v5/projects/1/queries-stats' }
+  let(:breakdowns) { 'https://api.airbrake.io/api/v5/projects/1/routes-breakdowns' }
 
   before do
     stub_request(:put, routes).to_return(status: 200, body: '')
     stub_request(:put, queries).to_return(status: 200, body: '')
+    stub_request(:put, breakdowns).to_return(status: 200, body: '')
 
     Airbrake::Config.instance = Airbrake::Config.new(
       project_id: 1,
@@ -73,6 +75,47 @@ RSpec.describe Airbrake::PerformanceNotifier do
       ).to have_been_made
     end
 
+    it "sends full performance breakdown" do
+      subject.notify(
+        Airbrake::PerformanceBreakdown.new(
+          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),
+          groups: { db: 131, view: 421 }
+        )
+      )
+
+      expect(
+        a_request(:put, breakdowns).with(body: %r|
+          \A{"routes":\[{
+            "method":"DELETE",
+            "route":"/routes-breakdowns",
+            "responseType":"json",
+            "time":"2018-01-01T00:49:00\+00:00",
+            "count":1,
+            "sum":60000.0,
+            "sumsq":3600000000.0,
+            "tdigest":"AAAAAkA0AAAAAAAAAAAAAUdqYAAB",
+            "groups":{
+              "db":{
+                "count":1,
+                "sum":131.0,
+                "sumsq":17161.0,
+                "tdigest":"AAAAAkA0AAAAAAAAAAAAAUMDAAAB"
+              },
+              "view":{
+                "count":1,
+                "sum":421.0,
+                "sumsq":177241.0,
+                "tdigest":"AAAAAkA0AAAAAAAAAAAAAUPSgAAB"
+              }
+            }
+        }\]}\z|x)
+      ).to have_been_made
+    end
+
     it "rounds time to the floor minute" do
       subject.notify(
         Airbrake::Request.new(
@@ -177,6 +220,57 @@ RSpec.describe Airbrake::PerformanceNotifier do
       ).to have_been_made
     end
 
+    it "groups performance breakdowns by route key" do
+      subject.notify(
+        Airbrake::PerformanceBreakdown.new(
+          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),
+          groups: { db: 131, view: 421 }
+        )
+      )
+      subject.notify(
+        Airbrake::PerformanceBreakdown.new(
+          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),
+          groups: { db: 55, view: 11 }
+        )
+      )
+
+      expect(
+        a_request(:put, breakdowns).with(body: %r|
+          \A{"routes":\[{
+            "method":"DELETE",
+            "route":"/routes-breakdowns",
+            "responseType":"json",
+            "time":"2018-01-01T00:00:00\+00:00",
+            "count":2,
+            "sum":4000.0,
+            "sumsq":8000000.0,
+            "tdigest":"AAAAAkA0AAAAAAAAAAAAAUT6AAAC",
+            "groups":{
+              "db":{
+                "count":2,
+                "sum":186.0,
+                "sumsq":20186.0,
+                "tdigest":"AAAAAkA0AAAAAAAAAAAAAkJcAABCmAAAAQE="
+              },
+              "view":{
+                "count":2,
+                "sum":432.0,
+                "sumsq":177362.0,
+                "tdigest":"AAAAAkA0AAAAAAAAAAAAAkEwAABDzQAAAQE="
+              }
+            }
+        }\]}\z|x)
+      ).to have_been_made
+    end
+
     it "returns a promise" do
       promise = subject.notify(
         Airbrake::Request.new(
@@ -339,9 +433,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
   describe "#delete_filter" do
     let(:filter) do
       Class.new do
-        def call(resource)
-          resource.ignore!
-        end
+        def call(resource); end
       end
     end
 

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'simplecov'
+SimpleCov.start if ENV['COVERAGE']
+
 require 'airbrake-ruby'
 
 require 'rspec/its'

data/spec/stat_spec.rb

@@ -12,21 +12,19 @@ RSpec.describe Airbrake::Stat do
 
   describe "#increment" do
     let(:start_time) { Time.new(2018, 1, 1, 0, 0, 20, 0) }
-    let(:end_time) { Time.new(2018, 1, 1, 0, 0, 21, 0) }
+    let(:end_time) { Time.new(2018, 1, 1, 0, 0, 22, 0) }
 
     before { subject.increment(start_time, end_time) }
 
-    it "increments count" do
-      expect(subject.count).to eq(1)
-    end
+    its(:sum) { is_expected.to eq(2000) }
+  end
 
-    it "updates sum" do
-      expect(subject.sum).to eq(1000)
-    end
+  describe "#increment_ms" do
+    before { subject.increment_ms(1000) }
 
-    it "updates sumsq" do
-      expect(subject.sumsq).to eq(1000000)
-    end
+    its(:count) { is_expected.to eq(1) }
+    its(:sum) { is_expected.to eq(1000) }
+    its(:sumsq) { is_expected.to eq(1000000) }
 
     it "updates tdigest" do
       expect(subject.tdigest.size).to eq(1)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2019-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3
@@ -68,6 +68,7 @@ files:
 - lib/airbrake-ruby/nested_exception.rb
 - lib/airbrake-ruby/notice.rb
 - lib/airbrake-ruby/notice_notifier.rb
+- lib/airbrake-ruby/performance_breakdown.rb
 - lib/airbrake-ruby/performance_notifier.rb
 - lib/airbrake-ruby/promise.rb
 - lib/airbrake-ruby/query.rb