sentry-rails 4.3.4 → 4.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48f0349352e2f19b3be18c7ea0e5b7a600ad72d01ed1d2ce4052e55b7df471c3
-  data.tar.gz: 7f2c6d5f3e2f2ec40cd797e81856951beced5fde6897cc993dfa8c2046ba7800
+  metadata.gz: 1e0dee67e1b51a9ca85ea36f5d740b94f1fc343c5fdc2b7dc04d3ae31a49559e
+  data.tar.gz: 332e269d839197cf59059a14c80ec59408b9d3d4fbac68b49fa3fb96f570f2ca
 SHA512:
-  metadata.gz: 0eef4c4a1a50168a669fdf786f78842ca45c6c0d04e1ec1b9f783ad86f0a70bf94a40b6207ab8334a6cfaec953bdbdbe7dc8f04c3301dbf62a02656ebb0e24b8
-  data.tar.gz: c5d28ee621ed6ad90a520a6e5c8fce8047a38907a493c706c5bb9f77304884b70e0564ddc90689214a0e919e6a8f6ea5d3ecbfea44de3c32bf934a74dd9459ec
+  metadata.gz: 4240894f140b915157eb8984c7c5c8d468212bb04162e35b7f1d162771bbe51e693dfacf3056c15f4d046a66f2f17c069d4fd948a1e0005731629f603cc56398
+  data.tar.gz: 670f13e2bd13862784fec3fc91fd6ed6c9c2291a9fa285b55bdaa113557919fdce60258d8c869dc679d152f033f63dad7c87456bca7ad09438d85418d0b2c21a

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,31 @@
 # 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)

data/Gemfile

@@ -2,6 +2,7 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in sentry-ruby.gemspec
 gemspec
+gem "sentry-ruby", path: "../sentry-ruby"
 
 rails_version = ENV["RAILS_VERSION"]
 rails_version = "6.1.0" if rails_version.nil?
@@ -18,6 +19,8 @@ end
 gem "rails", "~> #{rails_version}"
 gem "sprockets-rails"
 
+gem "sidekiq"
+
 gem "rspec", "~> 3.0"
 gem "rspec-retry"
 gem "rspec-rails", "~> 4.0"
@@ -25,13 +28,8 @@ gem "codecov", "0.2.12"
 
 gem "rake", "~> 12.0"
 
-# TODO: Remove this if https://github.com/jruby/jruby/issues/6547 is addressed
-gem "i18n", "<= 1.8.7"
-
-gem "sidekiq"
-
-gem "sentry-ruby", path: "../sentry-ruby"
-
+gem "object_tracer"
+gem "debug", github: "ruby/debug" if RUBY_VERSION.to_f >= 2.6
 gem "pry"
 
 gem "benchmark-ips"

data/lib/sentry/rails/breadcrumb/active_support_logger.rb

@@ -1,9 +1,11 @@
+require "sentry/rails/instrument_payload_cleanup_helper"
+
 module Sentry
   module Rails
     module Breadcrumb
       module ActiveSupportLogger
         class << self
-          IGNORED_DATA_TYPES = [:request, :headers, :exception, :exception_object]
+          include InstrumentPayloadCleanupHelper
 
           def add(name, started, _finished, _unique_id, data)
             # skip Rails' internal events
@@ -23,12 +25,6 @@ module Sentry
             Sentry.add_breadcrumb(crumb)
           end
 
-          def cleanup_data(data)
-            IGNORED_DATA_TYPES.each do |key|
-              data.delete(key) if data.key?(key)
-            end
-          end
-
           def inject
             @subscriber = ::ActiveSupport::Notifications.subscribe(/.*/) do |name, started, finished, unique_id, data|
               # we only record events that has a started timestamp

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
@@ -47,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/instrument_payload_cleanup_helper.rb

@@ -0,0 +1,13 @@
+module Sentry
+  module Rails
+    module InstrumentPayloadCleanupHelper
+      IGNORED_DATA_TYPES = [:request, :response, :headers, :exception, :exception_object]
+
+      def cleanup_data(data)
+        IGNORED_DATA_TYPES.each do |key|
+          data.delete(key) if data.key?(key)
+        end
+      end
+    end
+  end
+end

data/lib/sentry/rails/railtie.rb

@@ -6,27 +6,37 @@ 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
 
+    # because the extension works by registering the around_perform callcack, it should always be ran
+    # before the application is eager-loaded (before user's jobs register their own callbacks)
+    # See https://github.com/getsentry/sentry-ruby/issues/1249#issuecomment-853871871 for the detail explanation
+    initializer "sentry.extend_active_job", before: :eager_load! do |app|
+      extend_active_job if defined?(ActiveJob)
+    end
+
     config.after_initialize do |app|
       next unless Sentry.initialized?
 
       configure_project_root
       configure_trusted_proxies
       extend_controller_methods if defined?(ActionController)
-      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 +89,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,7 +1,12 @@
+require "sentry/rails/tracing/abstract_subscriber"
+require "sentry/rails/instrument_payload_cleanup_helper"
+
 module Sentry
   module Rails
     module Tracing
       class ActionControllerSubscriber < AbstractSubscriber
+        extend InstrumentPayloadCleanupHelper
+
         EVENT_NAME = "process_action.action_controller".freeze
 
         def self.subscribe!
@@ -16,8 +21,7 @@ module Sentry
               duration: duration
             ) do |span|
               payload = payload.dup
-              payload.delete(:headers)
-              payload.delete(:request)
+              cleanup_data(payload)
               span.set_data(:payload, payload)
               span.set_http_status(payload[:status])
             end

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.4"
+    VERSION = "4.5.1"
   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.4
+  version: 4.5.1
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-06 00:00:00.000000000 Z
+date: 2021-06-04 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,7 @@ 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/instrument_payload_cleanup_helper.rb
 - lib/sentry/rails/overrides/streaming_reporter.rb
 - lib/sentry/rails/railtie.rb
 - lib/sentry/rails/rescued_exception_interceptor.rb
@@ -87,7 +87,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 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+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