Add config.sidekiq.report_after_job_retries

When set to true, `sentry-sidekiq` only reports exceptions when the job
has been fully retried.

Author: st0012

sentry-sidekiq/lib/sentry-sidekiq.rb

@@ -2,6 +2,7 @@
 require "sentry-ruby"
 require "sentry/integrable"
 require "sentry/sidekiq/version"
+require "sentry/sidekiq/configuration"
 require "sentry/sidekiq/error_handler"
 require "sentry/sidekiq/sentry_context_middleware"
 

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

@@ -0,0 +1,21 @@
+module Sentry
+  class Configuration
+    attr_reader :sidekiq
+
+    add_post_initialization_callback do
+      @sidekiq = Sentry::Sidekiq::Configuration.new
+    end
+  end
+
+  module Sidekiq
+    class Configuration
+      # Set this option to true if you want Sentry to only capture the last job
+      # retry if it fails.
+      attr_accessor :report_after_job_retries
+
+      def initialize
+        @report_after_job_retries = false
+      end
+    end
+  end
+end

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

@@ -11,6 +11,15 @@ def call(ex, context)
         scope = Sentry.get_current_scope
         scope.set_transaction_name(context_filter.transaction_name) unless scope.transaction_name
 
+        retry_option = context.dig(:job, "retry")
+
+        if Sentry.configuration.sidekiq.report_after_job_retries && retry_option.is_a?(Integer)
+          retry_count = context.dig(:job, "retry_count")
+          if retry_count.nil? || retry_count < retry_option - 1
+            return
+          end
+        end
+
         Sentry::Sidekiq.capture_exception(
           ex,
           contexts: { sidekiq: context_filter.filtered },

sentry-sidekiq/spec/sentry/sidekiq/configuration_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+RSpec.describe Sentry::Sidekiq::Configuration do
+  it "adds #delayed_job option to Sentry::Configuration" do
+    config = Sentry::Configuration.new
+
+    expect(config.sidekiq).to be_a(described_class)
+  end
+
+  describe "#report_after_job_retries" do
+    it "has correct default value" do
+      expect(subject.report_after_job_retries).to eq(false)
+    end
+  end
+end

sentry-sidekiq/spec/sentry/sidekiq_spec.rb

@@ -89,6 +89,33 @@
     expect(retry_set.count).to eq(1)
   end
 
+  context "with config.report_after_job_retries = true" do
+    before do
+      Sentry.configuration.sidekiq.report_after_job_retries = true
+    end
+
+    it "doesn't report the error until retries are exhuasted" do
+      execute_worker(processor, RetryWorker)
+
+      expect(transport.events.count).to eq(0)
+
+      expect(retry_set.count).to eq(1)
+
+      retry_set.first.add_to_queue
+      job = queue.first
+      work = Sidekiq::BasicFetch::UnitOfWork.new('queue:default', job.value)
+      process_work(processor, work)
+      expect(transport.events.count).to eq(1)
+    end
+
+    it "doesn't affect no-retry jobs" do
+      execute_worker(processor, SadWorker)
+
+      expect(transport.events.count).to eq(1)
+      expect(retry_set.count).to eq(1)
+    end
+  end
+
   context "when tracing is enabled" do
     before do
       perform_basic_setup do |config|

sentry-sidekiq/spec/spec_helper.rb

@@ -133,6 +133,16 @@ def perform
   end
 end
 
+class RetryWorker
+  include Sidekiq::Worker
+
+  sidekiq_options retry: 1
+
+  def perform
+    1/0
+  end
+end
+
 def execute_worker(processor, klass)
   klass_options = klass.sidekiq_options_hash || {}
   options = {}