airbrake-ruby 4.8.0 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb6fd7fd474a31d89d2b532d467f5c319399b183a5805488bbb57789bc502bef
-  data.tar.gz: 83493c7a39f6eea49668f7c94fc202c90d55efcc1d4822864a70cca03c96134f
+  metadata.gz: 2358d01604e7b5362fe0a714c0137a0a95053741e5856acd58daf889da2810cb
+  data.tar.gz: b76c2b4282f77e94d0879df60bd5283f472ef92377d0190166cadba682ade87c
 SHA512:
-  metadata.gz: 149075c2e3a3cd9f43f19f7309f8b9e46aa36bde2994bc48b80c8b66a4c675d1fef2989e2020e5bc81dc55a8e8490f18aa445307dd2212f7c2467a3186fb1c8d
-  data.tar.gz: 030edc9303bd0f1042a6aa3f3ec5b672ab58598fee90a71e6d7f6a6fed84716d2043afab9edf46b3bdd6ee9939ef6b979ad78dc37575be774663ac84e8af73a7
+  metadata.gz: 0f389a12166d80085b35551a29a6ec6b963b79b55da50a29c37894f0fa8d5f3bcc87c61bddca113c3ada2f250c1541be13337981da98254bb59d73c4c60aa801
+  data.tar.gz: d8f0db0d2f682421f75d2fd7647be688decb19d2aadfadfa3c39a8d7ba198c07b7d1a6dd6a1924f2aedd7c28c482ccb63cf77ff5376cb815cade58e146a007f5

data/lib/airbrake-ruby.rb

@@ -9,6 +9,8 @@ require 'time'
 require 'airbrake-ruby/version'
 require 'airbrake-ruby/loggable'
 require 'airbrake-ruby/stashable'
+require 'airbrake-ruby/mergeable'
+require 'airbrake-ruby/grouppable'
 require 'airbrake-ruby/config'
 require 'airbrake-ruby/config/validator'
 require 'airbrake-ruby/promise'
@@ -52,6 +54,7 @@ require 'airbrake-ruby/performance_breakdown'
 require 'airbrake-ruby/benchmark'
 require 'airbrake-ruby/monotonic_time'
 require 'airbrake-ruby/timed_trace'
+require 'airbrake-ruby/queue'
 
 # 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
@@ -69,6 +72,7 @@ require 'airbrake-ruby/timed_trace'
 #
 # @since v1.0.0
 # @api public
+# rubocop:disable Metrics/ModuleLength
 module Airbrake
   # The general error that this library uses when it wants to raise.
   Error = Class.new(StandardError)
@@ -423,6 +427,31 @@ module Airbrake
       performance_notifier.notify(performance_breakdown)
     end
 
+    # Increments statistics of a certain queue (worker).
+    #
+    # @example
+    #   Airbrake.notify_queue(
+    #     queue: 'emails',
+    #     error_count: 1,
+    #     groups: { redis: 24.0, sql: 0.4 } # ms
+    #   )
+    #
+    # @param [Hash{Symbol=>Object}] queue_info
+    # @option queue_info [String] :queue The name of the queue/worker
+    # @option queue_info [Integer] :error_count How many times this worker
+    #   failed
+    # @option queue_info [Array<Hash{Symbol=>Float}>] :groups Where the job
+    #   spent its time
+    # @param [Hash] stash What needs to be appeneded to the stash, so it's
+    #   available in filters
+    # @return [void]
+    # @since v4.9.0
+    def notify_queue(queue_info, stash = {})
+      queue = Queue.new(queue_info)
+      queue.stash.merge!(stash)
+      performance_notifier.notify(queue)
+    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.
@@ -513,3 +542,4 @@ module Airbrake
     end
   end
 end
+# rubocop:enable Metrics/ModuleLength

data/lib/airbrake-ruby/grouppable.rb

@@ -0,0 +1,12 @@
+module Airbrake
+  # Grouppable adds the `#groups` method, so that we don't need to define it in
+  # all of performance models every time we add a model without groups.
+  #
+  # @since 4.9.0
+  # @api private
+  module Grouppable
+    def groups
+      {}
+    end
+  end
+end

data/lib/airbrake-ruby/mergeable.rb

@@ -0,0 +1,12 @@
+module Airbrake
+  # Mergeable adds the `#merge` method, so that we don't need to define it in
+  # all of performance models every time we add a model.
+  #
+  # @since 4.9.0
+  # @api private
+  module Mergeable
+    def merge(_other)
+      nil
+    end
+  end
+end

data/lib/airbrake-ruby/performance_breakdown.rb

@@ -12,6 +12,7 @@ module Airbrake
     include HashKeyable
     include Ignorable
     include Stashable
+    include Mergeable
 
     def initialize(
       method:,

data/lib/airbrake-ruby/performance_notifier.rb

@@ -61,7 +61,12 @@ module Airbrake
     private
 
     def update_payload(resource)
-      @payload[resource] ||= { total: Airbrake::Stat.new }
+      if (total_stat = @payload[resource])
+        @payload.key(total_stat).merge(resource)
+      else
+        @payload[resource] = { total: Airbrake::Stat.new }
+      end
+
       @payload[resource][:total].increment(resource.start_time, resource.end_time)
 
       resource.groups.each do |name, ms|

data/lib/airbrake-ruby/query.rb

@@ -11,6 +11,8 @@ module Airbrake
     include HashKeyable
     include Ignorable
     include Stashable
+    include Mergeable
+    include Grouppable
 
     def initialize(
       method:,
@@ -34,10 +36,6 @@ module Airbrake
       'queries'
     end
 
-    def groups
-      {}
-    end
-
     def to_h
       {
         'method' => method,

data/lib/airbrake-ruby/queue.rb

@@ -0,0 +1,52 @@
+module Airbrake
+  # Queue represents a queue (worker).
+  #
+  # @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
+    include HashKeyable
+    include Ignorable
+    include Stashable
+
+    def initialize(
+      queue:,
+      error_count:,
+      groups: {},
+      start_time: Time.now,
+      end_time: Time.now
+    )
+      @start_time_utc = TimeTruncate.utc_truncate_minutes(start_time)
+      super(queue, error_count, groups, start_time, end_time)
+    end
+
+    def destination
+      'queues-stats'
+    end
+
+    def cargo
+      'queues'
+    end
+
+    def to_h
+      {
+        'queue' => queue,
+        'errorCount' => error_count,
+        'time' => @start_time_utc
+      }
+    end
+
+    def hash
+      {
+        'queue' => queue,
+        'time' => @start_time_utc
+      }.hash
+    end
+
+    def merge(other)
+      self.error_count += other.error_count
+    end
+  end
+  # rubocop:enable Metrics/BlockLength
+end

data/lib/airbrake-ruby/request.rb

@@ -9,6 +9,8 @@ module Airbrake
     include HashKeyable
     include Ignorable
     include Stashable
+    include Mergeable
+    include Grouppable
 
     def initialize(
       method:,
@@ -29,10 +31,6 @@ module Airbrake
       'routes'
     end
 
-    def groups
-      {}
-    end
-
     def to_h
       {
         'method' => method,

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.8.0'.freeze
+  AIRBRAKE_RUBY_VERSION = '4.9.0'.freeze
 end

data/spec/airbrake_spec.rb

@@ -303,6 +303,37 @@ RSpec.describe Airbrake do
     end
   end
 
+  describe "#notify_queue" do
+    context "when :stash key is not provided" do
+      it "doesn't add anything to the stash of the queue" do
+        expect(described_class.performance_notifier).to receive(:notify) do |queue|
+          expect(queue.stash).to be_empty
+        end
+
+        described_class.notify_queue(
+          queue: 'bananas',
+          error_count: 10
+        )
+      end
+    end
+
+    context "when :stash key is provided" do
+      it "adds the value as the stash of the queue" do
+        expect(described_class.performance_notifier).to receive(:notify) do |queue|
+          expect(queue.stash).to eq(request_id: 1)
+        end
+
+        described_class.notify_queue(
+          {
+            queue: 'bananas',
+            error_count: 10
+          },
+          request_id: 1
+        )
+      end
+    end
+  end
+
   describe ".performance_notifier" do
     it "returns a performance notifier" do
       expect(described_class.performance_notifier)

data/spec/performance_notifier_spec.rb

@@ -2,11 +2,13 @@ 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' }
+  let(:queues) { 'https://api.airbrake.io/api/v5/projects/1/queues-stats' }
 
   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: '')
+    stub_request(:put, queues).to_return(status: 200, body: '')
 
     Airbrake::Config.instance = Airbrake::Config.new(
       project_id: 1,
@@ -120,6 +122,46 @@ RSpec.describe Airbrake::PerformanceNotifier do
       ).to have_been_made
     end
 
+    it "sends full queue" do
+      subject.notify(
+        Airbrake::Queue.new(
+          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)
+        )
+      )
+      subject.close
+
+      expect(
+        a_request(:put, queues).with(body: /
+          \A{"queues":\[{
+            "queue":"emails",
+            "errorCount":2,
+            "time":"2018-01-01T00:49:00\+00:00",
+            "count":1,
+            "sum":60000.0,
+            "sumsq":3600000000.0,
+            "tdigest":"AAAAAkA0AAAAAAAAAAAAAUdqYAAB",
+            "groups":{
+              "redis":{
+                "count":1,
+                "sum":131.0,
+                "sumsq":17161.0,
+                "tdigest":"AAAAAkA0AAAAAAAAAAAAAUMDAAAB"
+              },
+              "sql":{
+                "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(
@@ -284,6 +326,55 @@ RSpec.describe Airbrake::PerformanceNotifier do
       ).to have_been_made
     end
 
+    it "groups queues by queue key" do
+      subject.notify(
+        Airbrake::Queue.new(
+          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)
+        )
+      )
+      subject.notify(
+        Airbrake::Queue.new(
+          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)
+        )
+      )
+      subject.close
+
+      expect(
+        a_request(:put, queues).with(body: /
+          \A{"queues":\[{
+            "queue":"emails",
+            "errorCount":5,
+            "time":"2018-01-01T00:49:00\+00:00",
+            "count":2,
+            "sum":120000.0,
+            "sumsq":7200000000.0,
+            "tdigest":"AAAAAkA0AAAAAAAAAAAAAUdqYAAC",
+            "groups":{
+              "redis":{
+                "count":2,
+                "sum":262.0,
+                "sumsq":34322.0,
+                "tdigest":"AAAAAkA0AAAAAAAAAAAAAUMDAAAC"
+              },
+              "sql":{
+                "count":2,
+                "sum":842.0,
+                "sumsq":354482.0,
+                "tdigest":"AAAAAkA0AAAAAAAAAAAAAUPSgAAC"
+              }
+            }
+        }\]}\z/x)
+      ).to have_been_made
+    end
+
     it "returns a promise" do
       promise = subject.notify(
         Airbrake::Request.new(

data/spec/queue_spec.rb

@@ -0,0 +1,11 @@
+RSpec.describe Airbrake::Queue do
+  subject { described_class.new(queue: 'bananas', error_count: 0) }
+
+  describe "#ignore" do
+    it { is_expected.to respond_to(:ignore!) }
+  end
+
+  describe "#stash" do
+    it { is_expected.to respond_to(:stash) }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.9.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-23 00:00:00.000000000 Z
+date: 2019-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3
@@ -24,6 +24,124 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: public_suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: |
   Airbrake Ruby is a plain Ruby notifier for Airbrake (https://airbrake.io), the
   leading exception reporting service. Airbrake Ruby provides minimalist API that
@@ -62,10 +180,12 @@ files:
 - lib/airbrake-ruby/filters/sql_filter.rb
 - lib/airbrake-ruby/filters/system_exit_filter.rb
 - lib/airbrake-ruby/filters/thread_filter.rb
+- lib/airbrake-ruby/grouppable.rb
 - lib/airbrake-ruby/hash_keyable.rb
 - lib/airbrake-ruby/ignorable.rb
 - lib/airbrake-ruby/inspectable.rb
 - lib/airbrake-ruby/loggable.rb
+- lib/airbrake-ruby/mergeable.rb
 - lib/airbrake-ruby/monotonic_time.rb
 - lib/airbrake-ruby/nested_exception.rb
 - lib/airbrake-ruby/notice.rb
@@ -74,6 +194,7 @@ files:
 - lib/airbrake-ruby/performance_notifier.rb
 - lib/airbrake-ruby/promise.rb
 - lib/airbrake-ruby/query.rb
+- lib/airbrake-ruby/queue.rb
 - lib/airbrake-ruby/request.rb
 - lib/airbrake-ruby/response.rb
 - lib/airbrake-ruby/stashable.rb
@@ -126,6 +247,7 @@ files:
 - spec/performance_notifier_spec.rb
 - spec/promise_spec.rb
 - spec/query_spec.rb
+- spec/queue_spec.rb
 - spec/request_spec.rb
 - spec/response_spec.rb
 - spec/spec_helper.rb
@@ -203,6 +325,7 @@ test_files:
 - spec/notice_notifier/options_spec.rb
 - spec/filter_chain_spec.rb
 - spec/response_spec.rb
+- spec/queue_spec.rb
 - spec/code_hunk_spec.rb
 - spec/fixtures/notroot.txt
 - spec/fixtures/project_root/long_line.txt