Add new sidekiq config (#2581)

Author: sl0thentr0py

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Unreleased
 
+### Features
+
+- Add new sidekiq config `report_only_dead_jobs` ([#2581](https://github.com/getsentry/sentry-ruby/pull/2581))
+
 ### Bug Fixes
 
 - Gracefully fail on malformed utf-8 breadcrumb message ([#2582](https://github.com/getsentry/sentry-ruby/pull/2582))

sentry-sidekiq/lib/sentry/sidekiq/configuration.rb

@@ -21,8 +21,12 @@ class Configuration
       # retry if it fails.
       attr_accessor :report_after_job_retries
 
+      # Only report jobs that don't have `dead: false` set in the job's `sidekiq_options`
+      attr_accessor :report_only_dead_jobs
+
       def initialize
         @report_after_job_retries = false
+        @report_only_dead_jobs = false
       end
     end
   end

sentry-sidekiq/lib/sentry/sidekiq/error_handler.rb

@@ -31,6 +31,9 @@ def call(ex, context, sidekiq_config = nil)
           end
         end
 
+        # See if we want to ignore jobs that have dead: false
+        return if Sentry.configuration.sidekiq.report_only_dead_jobs && context.dig(:job, "dead") == false
+
         # Check if the retry count is below the attempt_threshold
         attempt_threshold = context.dig(:job, "attempt_threshold")
         if attempt_threshold && retryable?(context)

sentry-sidekiq/spec/sentry/sidekiq_spec.rb

@@ -143,6 +143,28 @@ def retry_last_failed_job
     end
   end
 
+  context "with config.report_only_dead_jobs = true" do
+    before do
+      Sentry.configuration.sidekiq.report_only_dead_jobs = true
+    end
+
+    it "reports normal jobs" do
+      worker = Class.new(SadWorker)
+      worker.sidekiq_options retry: 0
+      execute_worker(processor, worker)
+
+      expect(transport.events.count).to eq(1)
+    end
+
+    it "does not report jobs with dead: false" do
+      worker = Class.new(SadWorker)
+      worker.sidekiq_options retry: 0, dead: false
+      execute_worker(processor, worker)
+
+      expect(transport.events.count).to eq(0)
+    end
+  end
+
   context "with config.report_after_job_retries = true" do
     before do
       Sentry.configuration.sidekiq.report_after_job_retries = true