[solnic]

This introduces a public API for queue systems (ActiveJob, Sidekiq, GoodJob, SolidQueue etc.) to integrate with Sentry by subclassing Sentry::JobExtensions::Extension:

module MyBackend
  class SentryExtension < Sentry::JobExtensions::Extension
    def initialize
      super(name: "my_backend", integration: MyBackend::SentryIntegration, origin: "auto.queue.my_backend")
    end

    def scope_data(job:, **)
      { tags: { queue: job.queue_name } }
    end

    def messaging_data(job:, **)
      { system: "my_backend", message_id: job.job_id, destination: job.queue_name }
    end
  end
end

Integrations call the extension around enqueueing and performing a job:

extension.instrument_enqueue(job: job) { enqueue }

transaction = extension.start_job(scope: scope, job: job)
# perform the job
extension.finish_job(transaction: transaction, status: 200)

extension.capture_exception(job: job, exception: error) if extension.report_exception?(job: job, exception: error)

These record the queue.publish span and the queue.process transaction, and capture the job's exceptions. The data they record comes from hooks the subclass overrides, such as scope_data, error_data, messaging_data, will_retry?, report_exception?, record_publish_span?, extract_trace_headers, inject_trace_headers, transaction_name and span_origin.

Hooks take keyword arguments and accept keywords they don't read, so integrations can pass extra context. A failing hook is logged and the job runs without its data.

---

Closes #3117
Closes #3123

[cursor]

Stale Bugbot comment from a previous run.

[cursor]

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit f9f7593. Configure here.}