lib/sentry/rails/active_job.rb
# frozen_string_literal: true require "set" module Sentry module Rails module ActiveJobExtensions def perform_now if !Sentry.initialized? || already_supported_by_sentry_integration? super else SentryReporter.record(self) do super end end end def already_supported_by_sentry_integration? Sentry.configuration.rails.skippable_job_adapters.include?(self.class.queue_adapter.class.to_s) end class SentryReporter OP_NAME = "queue.active_job" SPAN_ORIGIN = "auto.queue.active_job" EVENT_HANDLERS = { "enqueue_retry.active_job" => :retry_handler } class << self def record(job, &block) Sentry.with_scope do |scope| begin scope.set_transaction_name(job.class.name, source: :task) transaction = Sentry.start_transaction( name: scope.transaction_name, source: scope.transaction_source, op: OP_NAME, origin: SPAN_ORIGIN ) scope.set_span(transaction) if transaction yield.tap do finish_sentry_transaction(transaction, 200) end rescue Exception => e # rubocop:disable Lint/RescueException finish_sentry_transaction(transaction, 500) capture_exception(job, e) raise end end end def capture_exception(job, e) Sentry::Rails.capture_exception( e, extra: sentry_context(job), tags: { job_id: job.job_id, provider_job_id: job.provider_job_id } ) end def register_event_handlers EVENT_HANDLERS.each do |name, handler| subscribers << ActiveSupport::Notifications.subscribe(name) do |*args| public_send(handler, *args) end end end def detach_event_handlers subscribers.each do |subscriber| ActiveSupport::Notifications.unsubscribe(subscriber) end subscribers.clear end # This handler does not capture error unless `active_job_report_on_retry_error` is true def retry_handler(*args) handle_error_event(*args) do |job, error| return if !Sentry.initialized? || job.already_supported_by_sentry_integration? return unless Sentry.configuration.rails.active_job_report_on_retry_error capture_exception(job, error) end end def handle_error_event(*args) event = ActiveSupport::Notifications::Event.new(*args) yield(event.payload[:job], event.payload[:error]) end def finish_sentry_transaction(transaction, status) return unless transaction transaction.set_http_status(status) transaction.finish end def sentry_context(job) { active_job: job.class.name, arguments: sentry_serialize_arguments(job.arguments), scheduled_at: job.scheduled_at, job_id: job.job_id, provider_job_id: job.provider_job_id, locale: job.locale } end def sentry_serialize_arguments(argument) case argument when Range if (argument.begin || argument.end).is_a?(ActiveSupport::TimeWithZone) argument.to_s else argument.map { |v| sentry_serialize_arguments(v) } end when Hash argument.transform_values { |v| sentry_serialize_arguments(v) } when Array, Enumerable argument.map { |v| sentry_serialize_arguments(v) } when ->(v) { v.respond_to?(:to_global_id) } argument.to_global_id.to_s rescue argument else argument end end private def subscribers @__subscribers__ ||= Set.new end end end end end end