sentry-rails 5.23.0 → 5.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e9b3a12f684b8d2343bec99058ac57b4ec38883af10977180a008c259279636
-  data.tar.gz: 975b1799c52917d8610229cbda2258544cbf2a4399913dbbb2952f1149650177
+  metadata.gz: 5c15eae4b0c41144ee4cb68d4e291a33ac37d8ab0373b509a9a04578adb76cca
+  data.tar.gz: ef7cd4138884bcb785afc73c5e7276ad97a69976f220160fdd1f090fd0319496
 SHA512:
-  metadata.gz: 817dfe044c5d88e457ceae741efc3674669e961d6619e62b3187019f2fc1db7a5e9dd52b15d1f777f50eba579edf9a317779fec2c5d07b160bae99fb4ded7475
-  data.tar.gz: da9c29234fe2956dc9e5455f36c10124287cf0113b4a3d3b9fdf8886034f67c25c42a662b88188f8ae28bb7fc40c2f8b61fa7c0e212d505c2914cc41488a0e41
+  metadata.gz: a89c4ff40235a704ed0beb92f8f2810f7466ca53897e0c24e851198d1a70d11b4a2cee245cfe9acc43165198d7642fc358a256be3db3e361c4cbd24178cb8a44
+  data.tar.gz: 4de89a962252b9ad7cb6b6d94d604367ab86bec25fe4a36526dc62bb509d28ee2acdbdeb7897b61868c1f7878315fe9137edb04a14aa48257eb71976b1da4350

data/lib/sentry/rails/active_job.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "set"
+
 module Sentry
   module Rails
     module ActiveJobExtensions
@@ -21,6 +23,10 @@ module Sentry
         OP_NAME = "queue.active_job"
         SPAN_ORIGIN = "auto.queue.active_job"
 
+        EVENT_HANDLERS = {
+          "enqueue_retry.active_job" => :retry_handler
+        }
+
         class << self
           def record(job, &block)
             Sentry.with_scope do |scope|
@@ -46,19 +52,54 @@ module Sentry
               rescue Exception => e # rubocop:disable Lint/RescueException
                 finish_sentry_transaction(transaction, 500)
 
-                Sentry::Rails.capture_exception(
-                  e,
-                  extra: sentry_context(job),
-                  tags: {
-                    job_id: job.job_id,
-                    provider_job_id: job.provider_job_id
-                  }
-                )
+                capture_exception(job, e)
+
                 raise
               end
             end
           end
 
+          def capture_exception(job, e)
+            Sentry::Rails.capture_exception(
+              e,
+              extra: sentry_context(job),
+              tags: {
+                job_id: job.job_id,
+                provider_job_id: job.provider_job_id
+              }
+            )
+          end
+
+          def register_event_handlers
+            EVENT_HANDLERS.each do |name, handler|
+              subscribers << ActiveSupport::Notifications.subscribe(name) do |*args|
+                public_send(handler, *args)
+              end
+            end
+          end
+
+          def detach_event_handlers
+            subscribers.each do |subscriber|
+              ActiveSupport::Notifications.unsubscribe(subscriber)
+            end
+            subscribers.clear
+          end
+
+          # This handler does not capture error unless `active_job_report_on_retry_error` is true
+          def retry_handler(*args)
+            handle_error_event(*args) do |job, error|
+              return if !Sentry.initialized? || job.already_supported_by_sentry_integration?
+              return unless Sentry.configuration.rails.active_job_report_on_retry_error
+
+              capture_exception(job, error)
+            end
+          end
+
+          def handle_error_event(*args)
+            event = ActiveSupport::Notifications::Event.new(*args)
+            yield(event.payload[:job], event.payload[:error])
+          end
+
           def finish_sentry_transaction(transaction, status)
             return unless transaction
 
@@ -95,6 +136,12 @@ module Sentry
               argument
             end
           end
+
+          private
+
+          def subscribers
+            @__subscribers__ ||= Set.new
+          end
         end
       end
     end

data/lib/sentry/rails/configuration.rb

@@ -17,12 +17,12 @@ module Sentry
       if ::Rails.logger
         if defined?(::ActiveSupport::BroadcastLogger) && ::Rails.logger.is_a?(::ActiveSupport::BroadcastLogger)
           dupped_broadcasts = ::Rails.logger.broadcasts.map(&:dup)
-          @logger = ::ActiveSupport::BroadcastLogger.new(*dupped_broadcasts)
+          self.sdk_logger = ::ActiveSupport::BroadcastLogger.new(*dupped_broadcasts)
         else
-          @logger = ::Rails.logger.dup
+          self.sdk_logger = ::Rails.logger.dup
         end
       else
-        @logger.warn(Sentry::LOGGER_PROGNAME) do
+        sdk_logger.warn(Sentry::LOGGER_PROGNAME) do
           <<~MSG
           sentry-rails can't detect Rails.logger. it may be caused by misplacement of the SDK initialization code
           please make sure you place the Sentry.init block under the `config/initializers` folder, e.g. `config/initializers/sentry.rb`
@@ -156,6 +156,9 @@ module Sentry
       # @return [Hash<String, Array<Symbol>>]
       attr_accessor :active_support_logger_subscription_items
 
+      # Set this option to true if you want Sentry to capture each retry failure
+      attr_accessor :active_job_report_on_retry_error
+
       def initialize
         @register_error_subscriber = false
         @report_rescued_exceptions = true
@@ -172,6 +175,7 @@ module Sentry
         @enable_db_query_source = true
         @db_query_source_threshold_ms = 100
         @active_support_logger_subscription_items = Sentry::Rails::ACTIVE_SUPPORT_LOGGER_SUBSCRIPTION_ITEMS_DEFAULT.dup
+        @active_job_report_on_retry_error = false
       end
     end
   end

data/lib/sentry/rails/railtie.rb

@@ -51,6 +51,11 @@ module Sentry
       activate_tracing
 
       register_error_subscriber(app) if ::Rails.version.to_f >= 7.0 && Sentry.configuration.rails.register_error_subscriber
+
+      # Presence of ActiveJob is no longer a reliable cue
+      if defined?(Sentry::Rails::ActiveJobExtensions)
+        Sentry::Rails::ActiveJobExtensions::SentryReporter.register_event_handlers
+      end
     end
 
     runner do

data/lib/sentry/rails/tracing/action_controller_subscriber.rb

@@ -14,7 +14,7 @@ module Sentry
         SPAN_ORIGIN = "auto.view.rails"
 
         def self.subscribe!
-          Sentry.logger.warn <<~MSG
+          Sentry.sdk_logger.warn <<~MSG
             DEPRECATION WARNING: sentry-rails has changed its approach on controller span recording and #{self.name} is now depreacted.
             Please stop using or referencing #{self.name} as it will be removed in the next major release.
           MSG

data/lib/sentry/rails/tracing/active_storage_subscriber.rb

@@ -33,7 +33,10 @@ module Sentry
               duration: duration
             ) do |span|
               payload.each do |key, value|
-                span.set_data(key, value) unless key == START_TIMESTAMP_NAME
+                next if key == START_TIMESTAMP_NAME
+                next if key == :key && !Sentry.configuration.send_default_pii
+
+                span.set_data(key, value)
               end
             end
           end

data/lib/sentry/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Sentry
   module Rails
-    VERSION = "5.23.0"
+    VERSION = "5.24.0"
   end
 end

data/sentry-rails.gemspec

@@ -31,5 +31,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "railties", ">= 5.0"
-  spec.add_dependency "sentry-ruby", "~> 5.23.0"
+  spec.add_dependency "sentry-ruby", "~> 5.24.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 5.23.0
+  version: 5.24.0
 platform: ruby
 authors:
 - Sentry Team
 bindir: exe
 cert_chain: []
-date: 2025-03-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -29,21 +29,21 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.23.0
+        version: 5.24.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.23.0
+        version: 5.24.0
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE.txt
+- README.md
 files:
 - ".gitignore"
 - ".rspec"
@@ -84,15 +84,15 @@ files:
 - lib/sentry/rails/tracing/active_support_subscriber.rb
 - lib/sentry/rails/version.rb
 - sentry-rails.gemspec
-homepage: https://github.com/getsentry/sentry-ruby/tree/5.23.0/sentry-rails
+homepage: https://github.com/getsentry/sentry-ruby/tree/5.24.0/sentry-rails
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.23.0/sentry-rails
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.23.0/sentry-rails
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.23.0/CHANGELOG.md
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.24.0/sentry-rails
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.24.0/sentry-rails
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.24.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/sentry-rails/5.23.0
+  documentation_uri: http://www.rubydoc.info/gems/sentry-rails/5.24.0
 rdoc_options: []
 require_paths:
 - lib
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A gem that provides Rails integration for the Sentry error logger
 test_files: []