airbrake-ruby 4.8.0 → 4.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb6fd7fd474a31d89d2b532d467f5c319399b183a5805488bbb57789bc502bef
-  data.tar.gz: 83493c7a39f6eea49668f7c94fc202c90d55efcc1d4822864a70cca03c96134f
+  metadata.gz: 6b9d78ba8789ccfa27f139a5ad0fef6b544da9bde4239dfda22cc543493bdb45
+  data.tar.gz: c32c7e64425037221491c64de8e22d548815929ec6e3a0289aad3c74f8ffedc7
 SHA512:
-  metadata.gz: 149075c2e3a3cd9f43f19f7309f8b9e46aa36bde2994bc48b80c8b66a4c675d1fef2989e2020e5bc81dc55a8e8490f18aa445307dd2212f7c2467a3186fb1c8d
-  data.tar.gz: 030edc9303bd0f1042a6aa3f3ec5b672ab58598fee90a71e6d7f6a6fed84716d2043afab9edf46b3bdd6ee9939ef6b979ad78dc37575be774663ac84e8af73a7
+  metadata.gz: 711d058e48af32390e7b92243171014122b5e454cea35afd19ca72e5fe39d04b919f0cbc95dfdf23685a3114cac14430310eb5a0c785c263d85a52ca26bab861
+  data.tar.gz: 300176c0bab2a6ddcb4b3453069be19ef5a477021ca10f68256edabc97c9d0d15b3b4a5659f2676e53071f89229b59c90ac6d0f1016d953342af8d9fc8b27581

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)
@@ -131,7 +135,7 @@ module Airbrake
     # @return [Boolean] true if the notifier was configured, false otherwise
     # @since v2.3.0
     def configured?
-      notice_notifier.configured?
+      @notice_notifier && @notice_notifier.configured?
     end
 
     # Sends an exception to Airbrake asynchronously.
@@ -251,10 +255,17 @@ module Airbrake
     #   Airbrake.notify('App crashed!') #=> raises Airbrake::Error
     #
     # @return [void]
+    # rubocop:disable Style/GuardClause, Style/IfUnlessModifier
     def close
-      notice_notifier.close
-      performance_notifier.close
+      if defined?(@notice_notifier) && @notice_notifier
+        @notice_notifier.close
+      end
+
+      if defined?(@performance_notifier) && @performance_notifier
+        @performance_notifier.close
+      end
     end
+    # rubocop:enable Style/GuardClause, Style/IfUnlessModifier
 
     # Pings the Airbrake Deploy API endpoint about the occurred deploy.
     #
@@ -317,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.
@@ -332,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
@@ -347,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]
@@ -360,9 +369,18 @@ module Airbrake
       performance_notifier.notify(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.
+    # 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 = {})
+      request = Request.new(request_info)
+      request.stash.merge!(stash)
+      performance_notifier.notify_sync(request)
+    end
+
+    # 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.
@@ -372,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]
@@ -395,6 +412,17 @@ module Airbrake
       performance_notifier.notify(query)
     end
 
+    # 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 = {})
+      query = Query.new(query_info)
+      query.stash.merge!(stash)
+      performance_notifier.notify_sync(query)
+    end
+
     # Increments performance breakdown statistics of a certain route.
     #
     # @example
@@ -403,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
@@ -412,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]
@@ -423,6 +451,53 @@ module Airbrake
       performance_notifier.notify(performance_breakdown)
     end
 
+    # Increments performance breakdown statistics of a certain route
+    # synchronously.
+    # @since v4.10.0
+    # @see .notify_performance_breakdown
+    def notify_performance_breakdown_sync(breakdown_info, stash = {})
+      performance_breakdown = PerformanceBreakdown.new(breakdown_info)
+      performance_breakdown.stash.merge!(stash)
+      performance_notifier.notify_sync(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
+    # @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]
+    # @since v4.9.0
+    # @see .notify_queue_sync
+    def notify_queue(queue_info, stash = {})
+      queue = Queue.new(queue_info)
+      queue.stash.merge!(stash)
+      performance_notifier.notify(queue)
+    end
+
+    # Increments statistics of a certain queue (worker) synchronously.
+    # @since v4.10.0
+    # @see .notify_queue
+    def notify_queue_sync(queue_info, stash = {})
+      queue = Queue.new(queue_info)
+      queue.stash.merge!(stash)
+      performance_notifier.notify_sync(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.
@@ -480,7 +555,7 @@ module Airbrake
     # @return [void]
     # @since v4.2.2
     def reset
-      close if notice_notifier && configured?
+      close
 
       self.performance_notifier = PerformanceNotifier.new
       self.notice_notifier = NoticeNotifier.new
@@ -506,10 +581,11 @@ module Airbrake
         Airbrake::Filters::RootDirectoryFilter,
         Airbrake::Filters::GitRevisionFilter,
         Airbrake::Filters::GitRepositoryFilter,
-        Airbrake::Filters::GitLastCheckoutFilter
+        Airbrake::Filters::GitLastCheckoutFilter,
       ].each do |filter|
         notice_notifier.add_filter(filter.new(config.root_directory))
       end
     end
   end
 end
+# rubocop:enable Metrics/ModuleLength

data/lib/airbrake-ruby/async_sender.rb

@@ -54,7 +54,7 @@ module Airbrake
         ThreadPool.new(
           worker_size: @config.workers,
           queue_size: @config.queue_size,
-          block: proc { |args| sender.send(*args) }
+          block: proc { |args| sender.send(*args) },
         )
       end
     end
@@ -71,8 +71,8 @@ module Airbrake
           message: error[:message],
           backtrace: error[:backtrace].map do |line|
             "#{line[:file]}:#{line[:line]} in `#{line[:function]}'"
-          end.join("\n")
-        )
+          end.join("\n"),
+        ),
       )
       promise.reject("AsyncSender has reached its capacity of #{@config.queue_size}")
     end

data/lib/airbrake-ruby/backtrace.rb

@@ -147,13 +147,13 @@ module Airbrake
           return {
             file: match[:file],
             line: (Integer(match[:line]) if match[:line]),
-            function: match[:function]
+            function: match[:function],
           }
         end
 
         logger.error(
           "can't parse '#{stackframe}' (please file an issue so we can fix " \
-          "it: https://github.com/airbrake/airbrake-ruby/issues/new)"
+          "it: https://github.com/airbrake/airbrake-ruby/issues/new)",
         )
         { file: nil, line: nil, function: stackframe }
       end

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/code_hunk.rb

@@ -30,7 +30,7 @@ module Airbrake
       Airbrake::FileCache[file] ||= File.foreach(file)
     rescue StandardError => ex
       logger.error(
-        "#{self.class.name}: can't read code hunk for #{file}: #{ex}"
+        "#{self.class.name}: can't read code hunk for #{file}: #{ex}",
       )
       nil
     end

data/lib/airbrake-ruby/config.rb

@@ -132,7 +132,7 @@ module Airbrake
 
       self.root_directory = File.realpath(
         (defined?(Bundler) && Bundler.root) ||
-        Dir.pwd
+        Dir.pwd,
       )
 
       self.versions = {}

data/lib/airbrake-ruby/config/validator.rb

@@ -29,7 +29,7 @@ module Airbrake
             return promise.reject(
               "the 'environment' option must be configured " \
               "with a Symbol (or String), but '#{config.environment.class}' was " \
-              "provided: #{config.environment}"
+              "provided: #{config.environment}",
             )
           end
 
@@ -46,7 +46,7 @@ module Airbrake
 
           if ignored_environment?(config)
             return promise.reject(
-              "current environment '#{config.environment}' is ignored"
+              "current environment '#{config.environment}' is ignored",
             )
           end
 
@@ -74,7 +74,7 @@ module Airbrake
           if config.ignore_environments.any? && config.environment.nil?
             config.logger.warn(
               "#{LOG_LABEL} the 'environment' option is not set, " \
-              "'ignore_environments' has no effect"
+              "'ignore_environments' has no effect",
             )
           end
 

data/lib/airbrake-ruby/deploy_notifier.rb

@@ -27,7 +27,7 @@ module Airbrake
       @sender.send(
         deploy_info,
         promise,
-        URI.join(@config.host, "api/v4/projects/#{@config.project_id}/deploys")
+        URI.join(@config.host, "api/v4/projects/#{@config.project_id}/deploys"),
       )
 
       promise

data/lib/airbrake-ruby/filters/exception_attributes_filter.rb

@@ -22,13 +22,13 @@ module Airbrake
           attributes = exception.to_airbrake
         rescue StandardError => ex
           logger.error(
-            "#{LOG_LABEL} #{exception.class}#to_airbrake failed. #{ex.class}: #{ex}"
+            "#{LOG_LABEL} #{exception.class}#to_airbrake failed. #{ex.class}: #{ex}",
           )
         end
 
         unless attributes.is_a?(Hash)
           logger.error(
-            "#{LOG_LABEL} #{self.class}: wanted Hash, got #{attributes.class}"
+            "#{LOG_LABEL} #{self.class}: wanted Hash, got #{attributes.class}",
           )
           return
         end

data/lib/airbrake-ruby/filters/git_last_checkout_filter.rb

@@ -52,7 +52,7 @@ module Airbrake
         parts = line.chomp.split("\t").first.split(' ')
         if parts.size < MIN_HEAD_COLS
           logger.error(
-            "#{LOG_LABEL} Airbrake::#{self.class.name}: can't parse line: #{line}"
+            "#{LOG_LABEL} Airbrake::#{self.class.name}: can't parse line: #{line}",
           )
           return
         end
@@ -62,7 +62,7 @@ module Airbrake
           username: author[0..1].join(' '),
           email: parts[-3][1..-2],
           revision: parts[1],
-          time: timestamp(parts[-2].to_i)
+          time: timestamp(parts[-2].to_i),
         }
       end
       # rubocop:enable Metrics/AbcSize

data/lib/airbrake-ruby/filters/keys_filter.rb

@@ -124,7 +124,7 @@ module Airbrake
 
         logger.error(
           "#{LOG_LABEL} one of the patterns in #{self.class} is invalid. " \
-          "Known patterns: #{@patterns}"
+          "Known patterns: #{@patterns}",
         )
       end
 

data/lib/airbrake-ruby/filters/sql_filter.rb

@@ -64,7 +64,7 @@ module Airbrake
         cassandra: %i[
           single_quotes uuids numeric_literals boolean_literals
           hexadecimal_literals comments multi_line_comments
-        ].freeze
+        ].freeze,
       }.freeze
 
       # @return [Hash{Symbol=>Regexp}] a set of regexps to check for unmatches
@@ -76,7 +76,7 @@ module Airbrake
         sqlite: %r{'|/\*|\*/},
         cassandra: %r{'|/\*|\*/},
         oracle: %r{'|/\*|\*/},
-        oracle_enhanced: %r{'|/\*|\*/}
+        oracle_enhanced: %r{'|/\*|\*/},
       }.freeze
 
       # @return [Array<Regexp>] the list of queries to be ignored
@@ -89,7 +89,7 @@ module Airbrake
         /FROM pg_attribute/i,
         /FROM pg_index/i,
         /FROM pg_class/i,
-        /FROM pg_type/i
+        /FROM pg_type/i,
       ].freeze
 
       def initialize(dialect)

data/lib/airbrake-ruby/filters/thread_filter.rb

@@ -16,7 +16,7 @@ module Airbrake
         String,
         Symbol,
         Regexp,
-        Numeric
+        Numeric,
       ].freeze
 
       # Variables starting with this prefix are not attached to a notice.

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