sentry-sidekiq 5.20.1 → 5.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a4d7ced8fb73d400732c4f0a29e1a5a2ce71701f7592ade0c6a29c7490ce935
-  data.tar.gz: 8c757b3826d25059f4923077080dd1e4e39a3caea22c45518a63910dd5965cef
+  metadata.gz: 83fbb1f91441c9adf737eaf26f68e5161de49eaf18cbcfb3f64ca104f1de4076
+  data.tar.gz: eb15ed9917c8677b982bfa5a81a080b80da54084051a5975ff0b678175ee0a38
 SHA512:
-  metadata.gz: f128cb5a76b95111a9be6f8cfb703f6a0ec20770af90d26e1aea547d034bd5b91d3ae3aa059f70106b1ebaab5df4907a455ef0945fe7f2b812b09c89aebe6885
-  data.tar.gz: 85fd7f607d2c62c59ba8721166e9f1c4c88a1aba5faa0ae43a48b4ea7a025a666f36aa5cb0d26635358152431616d6d03996603a775e6f3a0239027b962fbc6b
+  metadata.gz: 54831f113983325cc42c0e6bdf1765a01b1bf7769cade041270ab3c0475bb14ef95ee71b6461cf95f4c1139f0cfeea82cab0c846b3a4dad6e814bfa4fec423bc
+  data.tar.gz: 4bf2ad8e03051cf927c5f11c404bfe0a93e2cc17fc91f10b0233da2d14dc36cef4f20cf1386b871dcce982a857c8c617441495ab4a20f8bca5a1c9f6f45ef96c

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 git_source(:github) { |name| "https://github.com/#{name}.git" }
 
@@ -10,9 +12,6 @@ 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)
@@ -26,4 +25,6 @@ end
 
 gem "rails", "> 5.0.0"
 
+gem "timecop"
+
 eval_gemfile File.expand_path("../Gemfile", __dir__)

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

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/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
@@ -34,6 +60,22 @@ module Sentry
 
           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,3 +1,5 @@
+# frozen_string_literal: true
+
 require "sentry/sidekiq/context_filter"
 
 module Sentry

data/lib/sentry/sidekiq/sentry_context_middleware.rb

@@ -4,11 +4,24 @@ require "sentry/sidekiq/context_filter"
 
 module Sentry
   module Sidekiq
+    module Helpers
+      def set_span_data(span, id:, queue:, latency: nil, retry_count: nil)
+        if span
+          span.set_data("messaging.message.id", id)
+          span.set_data("messaging.destination.name", queue)
+          span.set_data("messaging.message.receive.latency", latency) if latency
+          span.set_data("messaging.message.retry.count", retry_count) if retry_count
+        end
+      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 +36,12 @@ 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)
+
+          set_span_data(transaction, id: job["jid"], queue: queue, latency: ((Time.now.to_f - job["enqueued_at"]) * 1000).to_i, retry_count: job["retry_count"] || 0)
+        end
 
         begin
           yield
@@ -63,13 +81,20 @@ 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
+
+        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.20.1"
+    VERSION = "5.22.0"
   end
 end

data/lib/sentry-sidekiq.rb

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

data/sentry-sidekiq.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/sentry/sidekiq/version"
 
 Gem::Specification.new do |spec|
@@ -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.20.1"
+  spec.add_dependency "sentry-ruby", "~> 5.22.0"
   spec.add_dependency "sidekiq", ">= 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-sidekiq
 version: !ruby/object:Gem::Version
-  version: 5.20.1
+  version: 5.22.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-27 00:00:00.000000000 Z
+date: 2024-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sentry-ruby
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.20.1
+        version: 5.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.20.1
+        version: 5.22.0
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -69,15 +69,15 @@ files:
 - lib/sentry/sidekiq/sentry_context_middleware.rb
 - lib/sentry/sidekiq/version.rb
 - sentry-sidekiq.gemspec
-homepage: https://github.com/getsentry/sentry-ruby/tree/5.20.1/sentry-sidekiq
+homepage: https://github.com/getsentry/sentry-ruby/tree/5.22.0/sentry-sidekiq
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.20.1/sentry-sidekiq
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.20.1/sentry-sidekiq
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.20.1/CHANGELOG.md
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.22.0/sentry-sidekiq
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.22.0/sentry-sidekiq
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.22.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/sentry-sidekiq/5.20.1
+  documentation_uri: http://www.rubydoc.info/gems/sentry-sidekiq/5.22.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: A gem that provides Sidekiq integration for the Sentry error logger