sentry-sidekiq 5.19.0 → 5.28.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41e6321e26f56fb048d1c360ea5121e32f0a6dc2b015da1b4e1ed2a81b658de0
-  data.tar.gz: b173d81283a38d46991d796ed927e052068905eafd35ac307cb90f10080cc903
+  metadata.gz: dae59f48a8af139f938dfaf4b9662797c9320bbf2920486d3521e5140f719360
+  data.tar.gz: 38a0197810f80a084c28740da6d3dfe26977e31e62d534aeead78946b284730c
 SHA512:
-  metadata.gz: 1d3c7ca9f379c3e248a762e1f8ade65a4e66ad9e796b17a157ccdc0bca2f426764d0722072e69c119919944f69e01d9535be1b06de40333353e10579bbb0faca
-  data.tar.gz: 072e73ad9ce4d76c9839b8a60c0fd927f2090914d4575fcf102cf16c3e499865c19a8d47be916931f368498bed67dafa737247483f2b9dcdcb07cd6d92149ef5
+  metadata.gz: 67cc29b6a0db050a3e9926a4c83ec81d4b1e19f7669289017d03aa07e63f82397cfe78c9f28f2349eb512ad1a7dbe27dd24c233aefc97f79fd0eb67b3d4992d1
+  data.tar.gz: 3e0a0e79502deaf39465e0d758a2af169c430fa5e520ea0839b1cbee032d23f35df5c6bcbea43047092953ca7199ece729f637bdd9c142efacc8dd852aaffc4f

data/Gemfile

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 git_source(:github) { |name| "https://github.com/#{name}.git" }
 
+eval_gemfile "../Gemfile.dev"
+
 # Specify your gem's dependencies in sentry-ruby.gemspec
 gemspec
+
 gem "sentry-ruby", path: "../sentry-ruby"
 gem "sentry-rails", path: "../sentry-rails"
 
@@ -10,20 +15,29 @@ gem "sentry-rails", path: "../sentry-rails"
 # loofah changed the required ruby version in a patch so we need to explicitly pin it
 gem "loofah", "2.20.0" if RUBY_VERSION.to_f < 2.5
 
-# For https://github.com/ruby/psych/issues/655
-gem "psych", "5.1.0"
-
-sidekiq_version = ENV["SIDEKIQ_VERSION"]
-sidekiq_version = "7.0" if sidekiq_version.nil?
-sidekiq_version = Gem::Version.new(sidekiq_version)
+if ENV["SIDEKIQ_MAIN"]
+  gem "sidekiq", github: "sidekiq/sidekiq", branch: "main"
+  sidekiq_version = "main"
+else
+  sidekiq_version = ENV["SIDEKIQ_VERSION"]
+  sidekiq_version = "7.0" if sidekiq_version.nil?
+  sidekiq_version = Gem::Version.new(sidekiq_version)
 
-gem "sidekiq", "~> #{sidekiq_version}"
+  gem "sidekiq", "~> #{sidekiq_version}"
+end
 
-if RUBY_VERSION.to_f >= 2.7 && sidekiq_version >= Gem::Version.new("6.0")
+if sidekiq_version == "main" || RUBY_VERSION.to_f >= 2.7 && sidekiq_version >= Gem::Version.new("6.0")
   gem "sidekiq-cron"
-  gem "sidekiq-scheduler"
+
+  if sidekiq_version == "main" || sidekiq_version >= Gem::Version.new("8.0")
+    gem "sidekiq-scheduler", "~> 6.0.0.beta"
+  else
+    gem "sidekiq-scheduler", "~> 5.0.0"
+  end
 end
 
 gem "rails", "> 5.0.0"
 
-eval_gemfile File.expand_path("../Gemfile", __dir__)
+gem "timecop"
+
+gem "vernier", platforms: :ruby if RUBY_VERSION >= "3.2.1"

data/Makefile

@@ -1,7 +1,3 @@
 build:
 	bundle install
 	gem build sentry-sidekiq.gemspec
-
-test:
-	WITH_SENTRY_RAILS=1 bundle exec rspec spec/sentry/rails_spec.rb
-	bundle exec rspec

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "sentry/ruby"

data/example/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gem "sidekiq"

data/example/error_worker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "sidekiq"
 require "sentry-sidekiq"
 

data/lib/sentry/sidekiq/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   class Configuration
     attr_reader :sidekiq
@@ -9,15 +11,26 @@ module Sentry
   end
 
   module Sidekiq
-    IGNORE_DEFAULT = ["Sidekiq::JobRetry::Skip"]
+    IGNORE_DEFAULT = [
+      "Sidekiq::JobRetry::Skip",
+      "Sidekiq::JobRetry::Handled"
+    ]
 
     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
 
+      # Only report jobs that don't have `dead: false` set in the job's `sidekiq_options`
+      attr_accessor :report_only_dead_jobs
+
+      # Whether we should inject headers while enqueuing the job in order to have a connected trace
+      attr_accessor :propagate_traces
+
       def initialize
         @report_after_job_retries = false
+        @report_only_dead_jobs = false
+        @propagate_traces = true
       end
     end
   end

data/lib/sentry/sidekiq/context_filter.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Sentry
   module Sidekiq
     class ContextFilter
-      ACTIVEJOB_RESERVED_PREFIX_REGEX = /^_aj_/.freeze
-      SIDEKIQ_NAME = "Sidekiq".freeze
+      ACTIVEJOB_RESERVED_PREFIX_REGEX = /^_aj_/
+      SIDEKIQ_NAME = "Sidekiq"
 
       attr_reader :context
 

data/lib/sentry/sidekiq/cron/helpers.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Sentry
+  module Sidekiq
+    module Cron
+      module Helpers
+        # This is used by Cron::Job and Scheduler
+        def self.monitor_config(cron)
+          cron_parts = cron.strip.split(" ")
+
+          if cron_parts.length > 5
+            timezone = cron_parts.pop
+            cron_without_timezone = cron_parts.join(" ")
+
+            Sentry::Cron::MonitorConfig.from_crontab(cron_without_timezone, timezone: timezone)
+          else
+            Sentry::Cron::MonitorConfig.from_crontab(cron)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sentry/sidekiq/cron/job.rb

@@ -12,6 +12,32 @@ module Sentry
   module Sidekiq
     module Cron
       module Job
+        def self.enqueueing_method
+          ::Sidekiq::Cron::Job.instance_methods.include?(:enque!) ? :enque! : :enqueue!
+        end
+
+        define_method(enqueueing_method) do |*args|
+          # make sure the current thread has a clean hub
+          Sentry.clone_hub_to_current_thread
+
+          Sentry.with_scope do |scope|
+            Sentry.with_session_tracking do
+              begin
+                scope.set_transaction_name("#{name} (#{klass})")
+
+                transaction = start_transaction(scope)
+                scope.set_span(transaction) if transaction
+                super(*args)
+
+                finish_transaction(transaction, 200)
+              rescue
+                finish_transaction(transaction, 500)
+                raise
+              end
+            end
+          end
+        end
+
         def save
           # validation failed, do nothing
           return false unless super
@@ -19,21 +45,43 @@ module Sentry
           # fail gracefully if can't find class
           klass_const =
             begin
-              ::Sidekiq::Cron::Support.constantize(klass.to_s)
+              if ::Sidekiq::Cron::Support.respond_to?(:safe_constantize)
+                ::Sidekiq::Cron::Support.safe_constantize(klass.to_s)
+              else
+                ::Sidekiq::Cron::Support.constantize(klass.to_s)
+              end
             rescue NameError
               return true
             end
 
+          return true if klass_const.nil? # Sidekiq::Cron returns nil if class is not found
+
           # only patch if not explicitly included in job by user
           unless klass_const.send(:ancestors).include?(Sentry::Cron::MonitorCheckIns)
             klass_const.send(:include, Sentry::Cron::MonitorCheckIns)
             klass_const.send(:sentry_monitor_check_ins,
-                             slug: name,
-                             monitor_config: Sentry::Cron::MonitorConfig.from_crontab(cron))
+                             slug: name.to_s,
+                             monitor_config: Sentry::Sidekiq::Cron::Helpers.monitor_config(parsed_cron.original))
           end
 
           true
         end
+
+        def start_transaction(scope)
+          Sentry.start_transaction(
+            name: scope.transaction_name,
+            source: scope.transaction_source,
+            op: "queue.sidekiq-cron",
+            origin: "auto.queue.sidekiq.cron"
+          )
+        end
+
+        def finish_transaction(transaction, status_code)
+          return unless transaction
+
+          transaction.set_http_status(status_code)
+          transaction.finish
+        end
       end
     end
   end

data/lib/sentry/sidekiq/error_handler.rb

@@ -1,4 +1,6 @@
-require 'sentry/sidekiq/context_filter'
+# frozen_string_literal: true
+
+require "sentry/sidekiq/context_filter"
 
 module Sentry
   module Sidekiq
@@ -29,6 +31,22 @@ module Sentry
           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)
+          attempt_threshold = attempt_threshold.to_i
+          retry_count = context.dig(:job, "retry_count")
+          # attempt 1 - retry_count is nil
+          # attempt 2 - this is your first retry so retry_count is 0
+          # attempt 3 - you have retried once, retry_count is 1
+          attempt = retry_count.nil? ? 1 : retry_count.to_i + 2
+
+          return if attempt < attempt_threshold
+        end
+
         Sentry::Sidekiq.capture_exception(
           ex,
           contexts: { sidekiq: context_filter.filtered },

data/lib/sentry/sidekiq/sentry_context_middleware.rb

@@ -1,14 +1,41 @@
 # frozen_string_literal: true
 
-require 'sentry/sidekiq/context_filter'
+require "sentry/sidekiq/context_filter"
 
 module Sentry
   module Sidekiq
+    module Helpers
+      def set_span_data(span, id:, queue:, latency: nil, retry_count: nil)
+        return unless span
+
+        span.set_data(Span::DataConventions::MESSAGING_MESSAGE_ID, id)
+        span.set_data(Span::DataConventions::MESSAGING_DESTINATION_NAME, queue)
+        span.set_data(Span::DataConventions::MESSAGING_MESSAGE_RECEIVE_LATENCY, latency) if latency
+        span.set_data(Span::DataConventions::MESSAGING_MESSAGE_RETRY_COUNT, retry_count) if retry_count
+      end
+
+      if ::Gem::Version.new(::Sidekiq::VERSION) >= ::Gem::Version.new("8.0.0")
+        def calculate_latency(job)
+          now_in_ms - job["enqueued_at"] if job["enqueued_at"]
+        end
+      else
+        def calculate_latency(job)
+          ((Time.now.to_f - job["enqueued_at"]) * 1000).round if job["enqueued_at"]
+        end
+      end
+
+      def now_in_ms
+        ::Process.clock_gettime(::Process::CLOCK_REALTIME, :millisecond)
+      end
+    end
+
     class SentryContextServerMiddleware
-      OP_NAME = "queue.sidekiq"
+      include Sentry::Sidekiq::Helpers
+
+      OP_NAME = "queue.process"
       SPAN_ORIGIN = "auto.queue.sidekiq"
 
-      def call(_worker, job, queue)
+      def call(worker, job, queue)
         return yield unless Sentry.initialized?
 
         context_filter = Sentry::Sidekiq::ContextFilter.new(job)
@@ -23,7 +50,20 @@ module Sentry
         scope.set_contexts(sidekiq: job.merge("queue" => queue))
         scope.set_transaction_name(context_filter.transaction_name, source: :task)
         transaction = start_transaction(scope, job["trace_propagation_headers"])
-        scope.set_span(transaction) if transaction
+
+        if transaction
+          scope.set_span(transaction)
+
+          latency = calculate_latency(job)
+
+          set_span_data(
+            transaction,
+            id: job["jid"],
+            queue: queue,
+            latency: latency,
+            retry_count: job["retry_count"] || 0
+          )
+        end
 
         begin
           yield
@@ -63,13 +103,23 @@ module Sentry
     end
 
     class SentryContextClientMiddleware
-      def call(_worker_class, job, _queue, _redis_pool)
+      include Sentry::Sidekiq::Helpers
+
+      def call(worker_class, job, queue, _redis_pool)
         return yield unless Sentry.initialized?
 
         user = Sentry.get_current_scope.user
         job["sentry_user"] = user unless user.empty?
-        job["trace_propagation_headers"] ||= Sentry.get_trace_propagation_headers
-        yield
+
+        if Sentry.configuration.sidekiq.propagate_traces
+          job["trace_propagation_headers"] ||= Sentry.get_trace_propagation_headers
+        end
+
+        Sentry.with_child_span(op: "queue.publish", description: worker_class.to_s) do |span|
+          set_span_data(span, id: job["jid"], queue: queue)
+
+          yield
+        end
       end
     end
   end

data/lib/sentry/sidekiq/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Sentry
   module Sidekiq
-    VERSION = "5.19.0"
+    VERSION = "5.28.1"
   end
 end

data/lib/sentry/sidekiq-scheduler/scheduler.rb

@@ -38,19 +38,7 @@ module Sentry
         monitor_config =
           case interval_type
           when "cron"
-            # fugit is a second order dependency of sidekiq-scheduler via rufus-scheduler
-            parsed_cron = ::Fugit.parse_cron(schedule)
-            timezone = parsed_cron.timezone
-
-            # fugit supports having the timezone part of the cron string,
-            # so we need to pull that with some hacky stuff
-            if timezone
-              parsed_cron.instance_variable_set(:@timezone, nil)
-              cron_without_timezone = parsed_cron.to_cron_s
-              Sentry::Cron::MonitorConfig.from_crontab(cron_without_timezone, timezone: timezone.name)
-            else
-              Sentry::Cron::MonitorConfig.from_crontab(schedule)
-            end
+            Sentry::Sidekiq::Cron::Helpers.monitor_config(schedule)
           when "every", "interval"
             Sentry::Cron::MonitorConfig.from_interval(rufus_job.frequency.to_i / 60, :minute)
           end

data/lib/sentry-sidekiq.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "sidekiq"
 require "sentry-ruby"
 require "sentry/integrable"
@@ -41,5 +43,6 @@ Sidekiq.configure_client do |config|
 end
 
 # patches
+require "sentry/sidekiq/cron/helpers"
 require "sentry/sidekiq/cron/job"
 require "sentry/sidekiq-scheduler/scheduler"

data/sentry-sidekiq.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/sentry/sidekiq/version"
 
 Gem::Specification.new do |spec|
@@ -11,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.platform = Gem::Platform::RUBY
   spec.required_ruby_version = '>= 2.4'
   spec.extra_rdoc_files = ["README.md", "LICENSE.txt"]
-  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples)'`.split("\n")
+  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples|\.rubocop\.yml)'`.split("\n")
 
   github_root_uri = 'https://github.com/getsentry/sentry-ruby'
   spec.homepage = "#{github_root_uri}/tree/#{spec.version}/#{spec.name}"
@@ -28,6 +30,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "sentry-ruby", "~> 5.19.0"
+  spec.add_dependency "sentry-ruby", "~> 5.28.1"
   spec.add_dependency "sidekiq", ">= 3.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sentry-sidekiq
 version: !ruby/object:Gem::Version
-  version: 5.19.0
+  version: 5.28.1
 platform: ruby
 authors:
 - Sentry Team
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sentry-ruby
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.19.0
+        version: 5.28.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.19.0
+        version: 5.28.1
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -43,8 +42,8 @@ email: accounts@sentry.io
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE.txt
+- README.md
 files:
 - ".gitignore"
 - ".rspec"
@@ -64,21 +63,21 @@ files:
 - lib/sentry/sidekiq-scheduler/scheduler.rb
 - lib/sentry/sidekiq/configuration.rb
 - lib/sentry/sidekiq/context_filter.rb
+- lib/sentry/sidekiq/cron/helpers.rb
 - lib/sentry/sidekiq/cron/job.rb
 - lib/sentry/sidekiq/error_handler.rb
 - lib/sentry/sidekiq/sentry_context_middleware.rb
 - lib/sentry/sidekiq/version.rb
 - sentry-sidekiq.gemspec
-homepage: https://github.com/getsentry/sentry-ruby/tree/5.19.0/sentry-sidekiq
+homepage: https://github.com/getsentry/sentry-ruby/tree/5.28.1/sentry-sidekiq
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.19.0/sentry-sidekiq
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.19.0/sentry-sidekiq
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.19.0/CHANGELOG.md
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.28.1/sentry-sidekiq
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.28.1/sentry-sidekiq
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.28.1/CHANGELOG.md
   bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/sentry-sidekiq/5.19.0
-post_install_message: 
+  documentation_uri: http://www.rubydoc.info/gems/sentry-sidekiq/5.28.1
 rdoc_options: []
 require_paths:
 - lib
@@ -93,8 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A gem that provides Sidekiq integration for the Sentry error logger
 test_files: []