sentry-rails 4.3.1 → 4.4.0.pre.beta.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ecadcb6d10a87fe8d032001ac1b970da69e7037f4b7a6d7378992ae2b232258
-  data.tar.gz: 2a517ac4894d2dfdbe9e626fee8bfe11f5b984204598c22f082daeac9c4e7995
+  metadata.gz: 1abbd4e00c660384cf961b09d8d8a2d98148336adf9ed7b766f73ca24c08cf33
+  data.tar.gz: ca6bba663f5db7948e5078e77e38e7dbfb30bf9849c885fd5645a62e422bbb97
 SHA512:
-  metadata.gz: f5ab30a925984910229746fc86f03f217198f3eb28fae3f0348c2fa876c227558aab0bdde1aa572c88f8f9b5452c317089851bd5de6859c2f249756d611a0015
-  data.tar.gz: b4b59011dd1d8142453c2dc5794b6cc6a8b6c350afd0f41109f85ca00390b4a19f7131874daae57cfc458ad14d0ff2bea78cbd34a5a3dff0dcf25bb92e4a139b
+  metadata.gz: 2a05541ee2a1441ed70055b909d3c04b87b931df16c70e0c076d2ed44cda60146e1680c4326fb0e55a96dd598b1171cd4fcb6cbcaeab9110936c7a6a9048601b
+  data.tar.gz: 9374e863588b2a926c05b8e2e0ed295d46813d9ebae9b98061e1dcc6329cb2ffcd3c617f66ef77e2c171e5a30c401fbefde0beed2717d382289bf2c161649fb2

data/.craft.yml

@@ -11,9 +11,10 @@ artifactProvider:
   name: github
 targets:
     - name: gem
-    - name: github
-      tagPrefix: sentry-rails-v
     - name: registry
       type: sdk
       config:
           canonical: 'gem:sentry-rails'
+    - name: github
+      tagPrefix: sentry-rails-v
+      changelog: sentry-rails/CHANGELOG.md

data/CHANGELOG.md

@@ -1,5 +1,48 @@
 # Changelog
 
+## 4.4.0-beta.0
+
+### Features
+
+- Make tracing subscribers configurable [#1344](https://github.com/getsentry/sentry-ruby/pull/1344) 
+
+```ruby
+# current default:
+# - Sentry::Rails::Tracing::ActionControllerSubscriber
+# - Sentry::Rails::Tracing::ActionViewSubscriber
+# - Sentry::Rails::Tracing::ActiveRecordSubscriber
+
+# you can add a new subscriber
+config.rails.tracing_subscribers << MySubscriber
+# or replace the set completely
+config.rails.tracing_subscribers = [MySubscriber]
+```
+
+### Bug Fixes
+
+- Report exceptions from the interceptor middleware for exceptions app [#1379](https://github.com/getsentry/sentry-ruby/pull/1379)
+  - Fixes [#1371](https://github.com/getsentry/sentry-ruby/issues/1371)
+- Re-position CaptureExceptions middleware to reduce tracing noise [#1405](https://github.com/getsentry/sentry-ruby/pull/1405) 
+
+## 4.3.4
+
+- Don't assign Rails.logger if it's not present [#1387](https://github.com/getsentry/sentry-ruby/pull/1387)
+  - Fixes [#1386](https://github.com/getsentry/sentry-ruby/issues/1386)
+
+## 4.3.3
+
+- Correctly set the SDK's logger in sentry-rails [#1363](https://github.com/getsentry/sentry-ruby/pull/1363)
+  - Fixes [#1361](https://github.com/getsentry/sentry-ruby/issues/1361)
+
+## 4.3.3-beta.0
+
+- Minimize sentry-rails' dependency requirement [#1352](https://github.com/getsentry/sentry-ruby/pull/1352)
+
+## 4.3.2
+
+- Avoid recording SendEventJob's transaction [#1351](https://github.com/getsentry/sentry-ruby/pull/1351)
+  - Fixes [#1348](https://github.com/getsentry/sentry-ruby/issues/1348)
+
 ## 4.3.1
 
 - Only apply background worker patch if ActiveRecord is loaded [#1350](https://github.com/getsentry/sentry-ruby/pull/1350)

data/app/jobs/sentry/send_event_job.rb

@@ -22,6 +22,11 @@ if defined?(ActiveJob)
       end
 
       def perform(event, hint = {})
+        # users don't need the tracing result of this job
+        if transaction = Sentry.get_current_scope.span
+          transaction.instance_variable_set(:@sampled, false)
+        end
+
         Sentry.send_event(event, hint)
       end
     end

data/lib/sentry/rails.rb

@@ -1,3 +1,4 @@
+require "rails"
 require "sentry-ruby"
 require "sentry/integrable"
 require "sentry/rails/configuration"

data/lib/sentry/rails/capture_exceptions.rb

@@ -12,6 +12,7 @@ module Sentry
       private
 
       def collect_exception(env)
+        return nil if env["sentry.already_captured"]
         super || env["action_dispatch.exception"] || env["sentry.rescued_exception"]
       end
 
@@ -30,15 +31,15 @@ module Sentry
       end
 
       def start_transaction(env, scope)
-        transaction = super
+        sentry_trace = env["HTTP_SENTRY_TRACE"]
+        options = { name: scope.transaction_name, op: transaction_op }
 
-        return unless transaction
-
-        if @assets_regex && transaction.name.match?(@assets_regex)
-          transaction.instance_variable_set(:@sampled, false)
+        if @assets_regex && scope.transaction_name.match?(@assets_regex)
+          options.merge!(sampled: false)
         end
 
-        transaction
+        transaction = Sentry::Transaction.from_sentry_trace(sentry_trace, **options) if sentry_trace
+        Sentry.start_transaction(transaction: transaction, **options)
       end
     end
   end

data/lib/sentry/rails/configuration.rb

@@ -1,3 +1,7 @@
+require "sentry/rails/tracing/action_controller_subscriber"
+require "sentry/rails/tracing/action_view_subscriber"
+require "sentry/rails/tracing/active_record_subscriber"
+
 module Sentry
   class Configuration
     attr_reader :rails
@@ -5,6 +9,17 @@ module Sentry
     add_post_initialization_callback do
       @rails = Sentry::Rails::Configuration.new
       @excluded_exceptions = @excluded_exceptions.concat(Sentry::Rails::IGNORE_DEFAULT)
+
+      if ::Rails.logger
+        @logger = ::Rails.logger
+      else
+        @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`
+          MSG
+        end
+      end
     end
   end
 
@@ -36,10 +51,16 @@ module Sentry
       # In those cases, we should skip ActiveJob's reporting to avoid duplicated reports.
       attr_accessor :skippable_job_adapters
 
+      attr_accessor :tracing_subscribers
+
       def initialize
         @report_rescued_exceptions = true
-        # TODO: Remove this in 4.2.0
         @skippable_job_adapters = []
+        @tracing_subscribers = Set.new([
+          Sentry::Rails::Tracing::ActionControllerSubscriber,
+          Sentry::Rails::Tracing::ActionViewSubscriber,
+          Sentry::Rails::Tracing::ActiveRecordSubscriber
+        ])
       end
     end
   end

data/lib/sentry/rails/railtie.rb

@@ -1,18 +1,13 @@
-require "rails"
 require "sentry/rails/capture_exceptions"
 require "sentry/rails/rescued_exception_interceptor"
 require "sentry/rails/backtrace_cleaner"
-require "sentry/rails/controller_methods"
-require "sentry/rails/controller_transaction"
-require "sentry/rails/overrides/streaming_reporter"
-require "sentry/rails/overrides/file_handler"
 
 module Sentry
   class Railtie < ::Rails::Railtie
     # middlewares can't be injected after initialize
     initializer "sentry.use_rack_middleware" do |app|
-      # need to be placed at first to capture as many errors as possible
-      app.config.middleware.insert 0, Sentry::Rails::CaptureExceptions
+      # placed after all the file-sending middlewares so we can avoid unnecessary transactions
+      app.config.middleware.insert_after ActionDispatch::Executor, Sentry::Rails::CaptureExceptions
       # need to be placed at last to smuggle app exceptions via env
       app.config.middleware.use(Sentry::Rails::RescuedExceptionInterceptor)
     end
@@ -21,13 +16,11 @@ module Sentry
       next unless Sentry.initialized?
 
       configure_project_root
-      configure_sentry_logger
       configure_trusted_proxies
-      extend_controller_methods
+      extend_controller_methods if defined?(ActionController)
       extend_active_job if defined?(ActiveJob)
       patch_background_worker if defined?(ActiveRecord)
-      override_streaming_reporter
-      override_file_handler if app.config.public_file_server.enabled
+      override_streaming_reporter if defined?(ActionView)
       setup_backtrace_cleanup_callback
       inject_breadcrumbs_logger
       activate_tracing
@@ -37,10 +30,6 @@ module Sentry
       Sentry.configuration.project_root = ::Rails.root.to_s
     end
 
-    def configure_sentry_logger
-      Sentry.configuration.logger = ::Rails.logger
-    end
-
     def configure_trusted_proxies
       Sentry.configuration.trusted_proxies += Array(::Rails.application.config.action_dispatch.trusted_proxies)
     end
@@ -51,6 +40,10 @@ module Sentry
     end
 
     def extend_controller_methods
+      require "sentry/rails/controller_methods"
+      require "sentry/rails/controller_transaction"
+      require "sentry/rails/overrides/streaming_reporter"
+
       ActiveSupport.on_load :action_controller do
         include Sentry::Rails::ControllerMethods
         include Sentry::Rails::ControllerTransaction
@@ -78,19 +71,17 @@ module Sentry
     end
 
     def override_streaming_reporter
+      require "sentry/rails/overrides/streaming_reporter"
+
       ActiveSupport.on_load :action_view do
         ActionView::StreamingTemplateRenderer::Body.send(:prepend, Sentry::Rails::Overrides::StreamingReporter)
       end
     end
 
-    def override_file_handler
-      ActiveSupport.on_load :action_controller do
-        ActionDispatch::FileHandler.send(:prepend, Sentry::Rails::Overrides::FileHandler)
-      end
-    end
-
     def activate_tracing
       if Sentry.configuration.tracing_enabled?
+        subscribers = Sentry.configuration.rails.tracing_subscribers
+        Sentry::Rails::Tracing.register_subscribers(subscribers)
         Sentry::Rails::Tracing.subscribe_tracing_events
         Sentry::Rails::Tracing.patch_active_support_notifications
       end

data/lib/sentry/rails/rescued_exception_interceptor.rb

@@ -20,12 +20,21 @@ module Sentry
             copied_env = scope.rack_env.dup
             copied_env["sentry.original_transaction"] = scope.transaction_name
             scope.set_rack_env(copied_env)
+
+            if report_rescued_exceptions?
+              Sentry::Rails.capture_exception(e)
+              env["sentry.already_captured"] = true
+            end
           end
 
-          env["sentry.rescued_exception"] = e if Sentry.configuration.rails.report_rescued_exceptions
+          env["sentry.rescued_exception"] = e if report_rescued_exceptions?
           raise e
         end
       end
+
+      def report_rescued_exceptions?
+        Sentry.configuration.rails.report_rescued_exceptions
+      end
     end
   end
 end

data/lib/sentry/rails/tracing.rb

@@ -1,18 +1,19 @@
-require "sentry/rails/tracing/abstract_subscriber"
-require "sentry/rails/tracing/active_record_subscriber"
-require "sentry/rails/tracing/action_controller_subscriber"
-require "sentry/rails/tracing/action_view_subscriber"
-
 module Sentry
   module Rails
     module Tracing
-      AVAILABLE_SUBSCRIBERS = [ActionViewSubscriber, ActiveRecordSubscriber, ActionControllerSubscriber]
+      def self.register_subscribers(subscribers)
+        @subscribers = subscribers
+      end
+
+      def self.subscribers
+        @subscribers
+      end
 
       def self.subscribe_tracing_events
         # need to avoid duplicated subscription
         return if @subscribed
 
-        AVAILABLE_SUBSCRIBERS.each(&:subscribe!)
+        subscribers.each(&:subscribe!)
 
         @subscribed = true
       end
@@ -20,7 +21,7 @@ module Sentry
       def self.unsubscribe_tracing_events
         return unless @subscribed
 
-        AVAILABLE_SUBSCRIBERS.each(&:unsubscribe!)
+        subscribers.each(&:unsubscribe!)
 
         @subscribed = false
       end

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

@@ -1,3 +1,5 @@
+require "sentry/rails/tracing/abstract_subscriber"
+
 module Sentry
   module Rails
     module Tracing

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

@@ -1,3 +1,5 @@
+require "sentry/rails/tracing/abstract_subscriber"
+
 module Sentry
   module Rails
     module Tracing

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

@@ -1,3 +1,5 @@
+require "sentry/rails/tracing/abstract_subscriber"
+
 module Sentry
   module Rails
     module Tracing

data/lib/sentry/rails/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Rails
-    VERSION = "4.3.1"
+    VERSION = "4.4.0-beta.0"
   end
 end

data/sentry-rails.gemspec

@@ -22,6 +22,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails", ">= 5.0"
-  spec.add_dependency "sentry-ruby-core", "~> 4.3.0"
+  spec.add_dependency "railties", ">= 5.0"
+  spec.add_dependency "sentry-ruby-core", "~> 4.4.0.pre.beta"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 4.4.0.pre.beta.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-19 00:00:00.000000000 Z
+date: 2021-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.3.0
+        version: 4.4.0.pre.beta
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.3.0
+        version: 4.4.0.pre.beta
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -70,7 +70,6 @@ files:
 - lib/sentry/rails/controller_methods.rb
 - lib/sentry/rails/controller_transaction.rb
 - lib/sentry/rails/engine.rb
-- lib/sentry/rails/overrides/file_handler.rb
 - lib/sentry/rails/overrides/streaming_reporter.rb
 - lib/sentry/rails/railtie.rb
 - lib/sentry/rails/rescued_exception_interceptor.rb
@@ -99,11 +98,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: A gem that provides Rails integration for the Sentry error logger

data/lib/sentry/rails/overrides/file_handler.rb

@@ -1,16 +0,0 @@
-module Sentry
-  module Rails
-    module Overrides
-      module FileHandler
-        def serve(*args)
-          if Sentry.initialized? && current_transaction = Sentry.get_current_scope.span
-            # we don't want to expose a setter for @sampled just for this case
-            current_transaction.instance_variable_set(:@sampled, false)
-          end
-
-          super
-        end
-      end
-    end
-  end
-end