airbrake 9.4.0 → 11.0.1

data/lib/airbrake/rails/excon_subscriber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'airbrake/rails/event'
 
 module Airbrake
@@ -6,6 +8,8 @@ module Airbrake
     # @since v9.2.0
     class Excon
       def call(*args)
+        return unless Airbrake::Config.instance.performance_stats
+
         routes = Airbrake::Rack::RequestStore[:routes]
         return if !routes || routes.none?
 

data/lib/airbrake/rails/http.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HTTP
   # Monkey-patch to measure request timing.
   class Client

data/lib/airbrake/rails/http_client.rb

@@ -1,10 +1,16 @@
-# Monkey-patch to measure request timing.
-class HTTPClient
-  alias do_get_without_airbrake do_get_block
+# frozen_string_literal: true
 
-  def do_get_block(request, proxy, connection, &block)
-    Airbrake::Rack.capture_timing(:http) do
-      do_get_without_airbrake(request, proxy, connection, &block)
+module Airbrake
+  module Rails
+    # Allows measuring request timing.
+    module HTTPClient
+      def do_get_block(request, proxy, connection, &block)
+        Airbrake::Rack.capture_timing(:http) do
+          super(request, proxy, connection, &block)
+        end
+      end
     end
   end
 end
+
+HTTPClient.prepend(Airbrake::Rails::HTTPClient)

data/lib/airbrake/rails/net_http.rb

@@ -1,10 +1,18 @@
-# Monkey-patch Net::HTTP to benchmark it.
-Net::HTTP.class_eval do
-  alias_method :request_without_airbrake, :request
+# frozen_string_literal: true
 
-  def request(request, *args, &block)
-    Airbrake::Rack.capture_timing(:http) do
-      request_without_airbrake(request, *args, &block)
+module Airbrake
+  module Rails
+    # Monkey-patch Net::HTTP to benchmark it.
+    # @api private
+    # @since v10.0.2
+    module NetHttp
+      def request(request, *args, &block)
+        Airbrake::Rack.capture_timing(:http) do
+          super(request, *args, &block)
+        end
+      end
     end
   end
 end
+
+Net::HTTP.prepend(Airbrake::Rails::NetHttp)

data/lib/airbrake/rails/railtie.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module Airbrake
+  module Rails
+    # This railtie works for any Rails application that supports railties (Rails
+    # 3.2+ apps). It makes Airbrake Ruby work with Rails and report errors
+    # occurring in the application automatically.
+    #
+    # rubocop:disable Metrics/BlockLength
+    class Railtie < ::Rails::Railtie
+      initializer('airbrake.middleware') do |app|
+        # Since Rails 3.2 the ActionDispatch::DebugExceptions middleware is
+        # responsible for logging exceptions and showing a debugging page in
+        # case the request is local. We want to insert our middleware after
+        # DebugExceptions, so we don't notify Airbrake about local requests.
+
+        if ::Rails.version.to_i >= 5
+          # Avoid the warning about deprecated strings.
+          # Insert after DebugExceptions, since ConnectionManagement doesn't
+          # exist in Rails 5 anymore.
+          app.config.middleware.insert_after(
+            ActionDispatch::DebugExceptions,
+            Airbrake::Rack::Middleware,
+          )
+        elsif defined?(::ActiveRecord::ConnectionAdapters::ConnectionManagement)
+          # Insert after ConnectionManagement to avoid DB connection leakage:
+          # https://github.com/airbrake/airbrake/pull/568
+          app.config.middleware.insert_after(
+            ::ActiveRecord::ConnectionAdapters::ConnectionManagement,
+            'Airbrake::Rack::Middleware',
+          )
+        else
+          # Insert after DebugExceptions for apps without ActiveRecord.
+          app.config.middleware.insert_after(
+            ActionDispatch::DebugExceptions,
+            'Airbrake::Rack::Middleware',
+          )
+        end
+      end
+
+      rake_tasks do
+        # Report exceptions occurring in Rake tasks.
+        require 'airbrake/rake'
+
+        # Defines tasks such as `airbrake:test` & `airbrake:deploy`.
+        require 'airbrake/rake/tasks'
+      end
+
+      initializer('airbrake.action_controller') do
+        ActiveSupport.on_load(:action_controller, run_once: true) do
+          # Patches ActionController with methods that allow us to retrieve
+          # interesting request data. Appends that information to notices.
+          require 'airbrake/rails/action_controller'
+          include Airbrake::Rails::ActionController
+
+          # Cache route information for the duration of the request.
+          require 'airbrake/rails/action_controller_route_subscriber'
+          ActiveSupport::Notifications.subscribe(
+            'start_processing.action_controller',
+            Airbrake::Rails::ActionControllerRouteSubscriber.new,
+          )
+
+          # Send route stats.
+          require 'airbrake/rails/action_controller_notify_subscriber'
+          ActiveSupport::Notifications.subscribe(
+            'process_action.action_controller',
+            Airbrake::Rails::ActionControllerNotifySubscriber.new,
+          )
+
+          # Send performance breakdown: where a request spends its time.
+          require 'airbrake/rails/action_controller_performance_breakdown_subscriber'
+          ActiveSupport::Notifications.subscribe(
+            'process_action.action_controller',
+            Airbrake::Rails::ActionControllerPerformanceBreakdownSubscriber.new,
+          )
+
+          require 'airbrake/rails/net_http' if defined?(Net) && defined?(Net::HTTP)
+          require 'airbrake/rails/curb' if defined?(Curl) && defined?(Curl::CURB_VERSION)
+          require 'airbrake/rails/http' if defined?(HTTP) && defined?(HTTP::Client)
+          require 'airbrake/rails/http_client' if defined?(HTTPClient)
+          require 'airbrake/rails/typhoeus' if defined?(Typhoeus)
+
+          if defined?(Excon)
+            require 'airbrake/rails/excon_subscriber'
+            ActiveSupport::Notifications.subscribe(/excon/, Airbrake::Rails::Excon.new)
+            ::Excon.defaults[:instrumentor] = ActiveSupport::Notifications
+          end
+        end
+      end
+
+      initializer('airbrake.active_record') do
+        ActiveSupport.on_load(:active_record, run_once: true) do
+          # Reports exceptions occurring in some bugged ActiveRecord callbacks.
+          # Applicable only to the versions of Rails lower than 4.2.
+          if defined?(::Rails) &&
+             Gem::Version.new(::Rails.version) <= Gem::Version.new('4.2')
+            require 'airbrake/rails/active_record'
+            include Airbrake::Rails::ActiveRecord
+          end
+
+          if defined?(ActiveRecord)
+            # Send SQL queries.
+            require 'airbrake/rails/active_record_subscriber'
+            ActiveSupport::Notifications.subscribe(
+              'sql.active_record', Airbrake::Rails::ActiveRecordSubscriber.new
+            )
+
+            # Filter out parameters from SQL body.
+            if ::ActiveRecord::Base.respond_to?(:connection_db_config)
+              # Rails 6.1+ deprecates "connection_config" in favor of
+              # "connection_db_config", so we need an updated call.
+              Airbrake.add_performance_filter(
+                Airbrake::Filters::SqlFilter.new(
+                  ::ActiveRecord::Base.connection_db_config.configuration_hash[:adapter],
+                ),
+              )
+            else
+              Airbrake.add_performance_filter(
+                Airbrake::Filters::SqlFilter.new(
+                  ::ActiveRecord::Base.connection_config[:adapter],
+                ),
+              )
+            end
+          end
+        end
+      end
+
+      initializer('airbrake.active_job') do
+        ActiveSupport.on_load(:active_job, run_once: true) do
+          # Reports exceptions occurring in ActiveJob jobs.
+          require 'airbrake/rails/active_job'
+          include Airbrake::Rails::ActiveJob
+        end
+      end
+
+      initializer('airbrake.action_cable') do
+        ActiveSupport.on_load(:action_cable, run_once: true) do
+          # Reports exceptions occurring in ActionCable connections.
+          require 'airbrake/rails/action_cable'
+        end
+      end
+
+      runner do
+        at_exit do
+          Airbrake.notify_sync($ERROR_INFO) if $ERROR_INFO
+        end
+      end
+    end
+    # rubocop:enable Metrics/BlockLength
+  end
+end

data/lib/airbrake/rails/typhoeus.rb

@@ -1,12 +1,16 @@
-module Typhoeus
-  # Monkey-patch to measure request timing.
-  class Request
-    alias run_without_airbrake run
+# frozen_string_literal: true
 
-    def run
-      Airbrake::Rack.capture_timing(:http) do
-        run_without_airbrake
+module Airbrake
+  module Rails
+    # Allow measuring request timing.
+    module TyphoeusRequest
+      def run
+        Airbrake::Rack.capture_timing(:http) do
+          super
+        end
       end
     end
   end
 end
+
+Typhoeus::Request.prepend(Airbrake::Rails::TyphoeusRequest)

data/lib/airbrake/rake.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This is not bulletproof, but if this file is executed before a task
 # definition, we can grab tasks descriptions and locations.
 # See: https://goo.gl/ksn6PE
@@ -30,7 +32,7 @@ module Rake
       notice[:params].merge!(
         rake_task: task_info,
         execute_args: args,
-        argv: ARGV.join(' ')
+        argv: ARGV.join(' '),
       )
 
       Airbrake.notify_sync(notice)

data/lib/airbrake/rake/tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'airbrake-ruby'
 
 namespace :airbrake do
@@ -55,7 +57,7 @@ namespace :airbrake do
       username: ENV['USERNAME'],
       revision: ENV['REVISION'],
       repository: ENV['REPOSITORY'],
-      version: ENV['VERSION']
+      version: ENV['VERSION'],
     }
     promise = Airbrake.notify_deploy(deploy_params)
     promise.then do
@@ -69,7 +71,7 @@ namespace :airbrake do
     app = ENV['HEROKU_APP']
 
     config = Bundler.with_clean_env do
-      `heroku config --shell#{ " --app #{app}" if app }`
+      `heroku config --shell#{" --app #{app}" if app}`
     end
 
     heroku_env = config.each_line.with_object({}) do |line, h|
@@ -97,14 +99,14 @@ namespace :airbrake do
       end
     end
 
-    url = "https://airbrake.io/api/v3/projects/#{id}/heroku-deploys?key=#{key}"
+    url = ["https://airbrake.io/api/v3/projects/#{id}/heroku-deploys?key=#{key}"]
     url << "&environment=#{env}"
     url << "&repository=#{repo}" unless repo.empty?
 
-    command = %(heroku addons:create deployhooks:http --url="#{url}")
+    command = [%(heroku addons:create deployhooks:http --url="#{url.join}")]
     command << " --app #{app}" if app
 
-    puts "$ #{command}"
+    puts "$ #{command.join}"
     Bundler.with_clean_env { puts `#{command}` }
   end
 end

data/lib/airbrake/resque.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Resque
   module Failure
     # Provides Resque integration with Airbrake.
@@ -27,3 +29,33 @@ module Resque
     end
   end
 end
+
+module Resque
+  # Measures elapsed time of a job and notifies Airbrake of the execution
+  # status.
+  #
+  # @since v9.6.0
+  class Job
+    # Store the original method to use it later.
+    alias perform_without_airbrake perform
+
+    def perform
+      timing = Airbrake::Benchmark.measure do
+        perform_without_airbrake
+      end
+    rescue StandardError => exception
+      Airbrake.notify_queue_sync(
+        queue: payload['class'],
+        error_count: 1,
+        timing: 0.01,
+      )
+      raise exception
+    else
+      Airbrake.notify_queue_sync(
+        queue: payload['class'],
+        error_count: 0,
+        timing: timing,
+      )
+    end
+  end
+end

data/lib/airbrake/shoryuken.rb

@@ -1,14 +1,28 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Shoryuken
     # Provides integration with Shoryuken.
     class ErrorHandler
       # rubocop:disable Lint/RescueException
       def call(worker, queue, _sqs_msg, body)
-        yield
+        timing = Airbrake::Benchmark.measure do
+          yield
+        end
       rescue Exception => exception
         notify_airbrake(exception, worker, queue, body)
-
+        Airbrake.notify_queue(
+          queue: worker.class.to_s,
+          error_count: 1,
+          timing: 0.01,
+        )
         raise exception
+      else
+        Airbrake.notify_queue(
+          queue: worker.class.to_s,
+          error_count: 0,
+          timing: timing,
+        )
       end
       # rubocop:enable Lint/RescueException
 
@@ -24,7 +38,7 @@ module Airbrake
       def notice_context(queue, body)
         {
           queue: queue,
-          body: body.is_a?(Array) ? { batch: body } : { body: body }
+          body: body.is_a?(Array) ? { batch: body } : { body: body },
         }
       end
     end

data/lib/airbrake/sidekiq.rb

@@ -1,22 +1,35 @@
+# frozen_string_literal: true
+
 require 'airbrake/sidekiq/retryable_jobs_filter'
 
 module Airbrake
   module Sidekiq
     # Provides integration with Sidekiq v2+.
     class ErrorHandler
-      # rubocop:disable Lint/RescueException
       def call(_worker, context, _queue)
-        yield
-      rescue Exception => exception
+        timing = Airbrake::Benchmark.measure do
+          yield
+        end
+      rescue Exception => exception # rubocop:disable Lint/RescueException
         notify_airbrake(exception, context)
+        Airbrake.notify_queue(
+          queue: context['class'],
+          error_count: 1,
+          timing: 0.01,
+        )
         raise exception
+      else
+        Airbrake.notify_queue(
+          queue: context['class'],
+          error_count: 0,
+          timing: timing,
+        )
       end
-      # rubocop:enable Lint/RescueException
 
       private
 
       def notify_airbrake(exception, context)
-        Airbrake.notify(exception, context) do |notice|
+        Airbrake.notify(exception, job: context) do |notice|
           notice[:context][:component] = 'sidekiq'
           notice[:context][:action] = action(context)
         end
@@ -28,20 +41,15 @@ module Airbrake
         klass = context['class'] || context[:job] && context[:job]['class']
         return klass unless context[:job] && context[:job]['args'].first.is_a?(Hash)
         return klass unless (job_class = context[:job]['args'].first['job_class'])
+
         job_class
       end
     end
   end
 end
 
-if Sidekiq::VERSION < '3'
-  Sidekiq.configure_server do |config|
-    config.server_middleware do |chain|
-      chain.add(Airbrake::Sidekiq::ErrorHandler)
-    end
-  end
-else
-  Sidekiq.configure_server do |config|
-    config.error_handlers << Airbrake::Sidekiq::ErrorHandler.new.method(:notify_airbrake)
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add(Airbrake::Sidekiq::ErrorHandler)
   end
 end