class Bugsnag::Sidekiq

Extracts and attaches Sidekiq job and queue information to an error report

Constants

FRAMEWORK_ATTRIBUTES

Public Class Methods

configure_server(server) click to toggle source
# File lib/bugsnag/integrations/sidekiq.rb, line 51
def self.configure_server(server)
  if Bugsnag::Sidekiq.sidekiq_supports_error_handlers
    server.error_handlers << proc do |ex, _context, _config = nil|
      Bugsnag::Sidekiq.notify(ex)
      Bugsnag.configuration.clear_request_data
    end
  end

  server.server_middleware do |chain|
    chain.add ::Bugsnag::Sidekiq
  end
end
new() click to toggle source
# File lib/bugsnag/integrations/sidekiq.rb, line 15
def initialize
  Bugsnag.configuration.internal_middleware.use(Bugsnag::Middleware::Sidekiq)
  Bugsnag.configuration.detected_app_type = "sidekiq"
  Bugsnag.configuration.runtime_versions["sidekiq"] = ::Sidekiq::VERSION
end
notify(exception) click to toggle source
# File lib/bugsnag/integrations/sidekiq.rb, line 37
def self.notify(exception)
  Bugsnag.notify(exception, true) do |report|
    report.severity = "error"
    report.severity_reason = {
      :type => Bugsnag::Report::UNHANDLED_EXCEPTION_MIDDLEWARE,
      :attributes => FRAMEWORK_ATTRIBUTES
    }
  end
end
sidekiq_supports_error_handlers() click to toggle source
# File lib/bugsnag/integrations/sidekiq.rb, line 47
def self.sidekiq_supports_error_handlers
  Gem::Version.new(::Sidekiq::VERSION) >= Gem::Version.new('3.0.0')
end

Public Instance Methods

call(worker, msg, queue) { || ... } click to toggle source
# File lib/bugsnag/integrations/sidekiq.rb, line 21
def call(worker, msg, queue)
  # store msg/queue in thread local state to be read by Bugsnag::Middleware::Sidekiq
  Bugsnag.configuration.set_request_data(:sidekiq, { :msg => msg, :queue => queue })
  error_raised = false
  yield
rescue Exception => ex
  error_raised = true
  self.class.notify(ex) unless self.class.sidekiq_supports_error_handlers
  raise
ensure
  # if an error was raised and error handlers are installed, the data will be cleared after
  # the notification is sent. Otherwise, the data must be cleared.
  keep_data = error_raised && self.class.sidekiq_supports_error_handlers
  Bugsnag.configuration.clear_request_data unless keep_data
end