sentry-rails 4.3.3 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1790a49cf858500aa57dd9290d37e794bb969b7b961e11047e8df61a090ec95
-  data.tar.gz: a9626020e87f157e1eed1c2f49296f796406958e789c379915fbecf5da49ff9a
+  metadata.gz: 5dacfb4f5f23d9d37bef25d05d7c7c6783e6c0e5578e706112ed5e69f9314a54
+  data.tar.gz: e78a4adf974cc0b9769e8b8bcf9dcf92a920548f5811ec7f4aeeb65d0ca73493
 SHA512:
-  metadata.gz: 7d2d760f4fa7ac34e39294169f8be9c19d9ff7e19fb1c7a89d3205ff843b626bf90f89ee516b248539d180ac347c907ca23c55953033eb1d8588fd15e57f833c
-  data.tar.gz: 3fd609010fba1eef3a56ce52a5f09e7d58ad5f43f1c3b039d4deed3bdb89f276da434a2e76d2b6f06d79ae85c4ebb7daa24179503b607d3b6be23808005565ce
+  metadata.gz: d79b9b8b316ac7af02a138b81bfa7a303c6f18e4a6edd5f75101b9d6e1ff93ec6ab5290ae163eca98b4dfba89631f9c0710b6405eb3c123bc3fbec94480ee297
+  data.tar.gz: 4fb8951a0bd157f59b0b969f8b3745873f93c1bb75d1d4824d959330e4c1565613b01c42b7ca92627e3a305c5dc085940b2ca7cc8ae735011dbe483e8e6f1237

data/.craft.yml

@@ -11,9 +11,9 @@ 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

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+Individual gem's changelog has been deprecated. Please check the [project changelog](https://github.com/getsentry/sentry-ruby/blob/master/CHANGELOG.md).
+
+## 4.4.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)

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,7 +9,17 @@ module Sentry
     add_post_initialization_callback do
       @rails = Sentry::Rails::Configuration.new
       @excluded_exceptions = @excluded_exceptions.concat(Sentry::Rails::IGNORE_DEFAULT)
-      @logger = ::Rails.logger
+
+      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
 
@@ -37,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

@@ -6,8 +6,8 @@ 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,12 +21,16 @@ module Sentry
       extend_active_job if defined?(ActiveJob)
       patch_background_worker if defined?(ActiveRecord)
       override_streaming_reporter if defined?(ActionView)
-      override_file_handler if defined?(ActionDispatch) && app.config.public_file_server.enabled
       setup_backtrace_cleanup_callback
       inject_breadcrumbs_logger
       activate_tracing
     end
 
+    runner do
+      next unless Sentry.initialized?
+      Sentry.configuration.background_worker_threads = 0
+    end
+
     def configure_project_root
       Sentry.configuration.project_root = ::Rails.root.to_s
     end
@@ -79,16 +83,10 @@ module Sentry
       end
     end
 
-    def override_file_handler
-      require "sentry/rails/overrides/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.3"
+    VERSION = "4.5.0"
   end
 end

data/sentry-rails.gemspec

@@ -16,12 +16,12 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/sentry-rails/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
 
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "railties", ">= 5.0"
-  spec.add_dependency "sentry-ruby-core", "~> 4.3.0"
+  spec.add_dependency "sentry-ruby-core", "~> 4.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 4.3.3
+  version: 4.5.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-26 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.3.0
+        version: 4.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.3.0
+        version: 4.5.0
 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
@@ -87,7 +86,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/getsentry/sentry-ruby
   source_code_uri: https://github.com/getsentry/sentry-ruby
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/master/sentry-rails/CHANGELOG.md
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -103,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 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