sentry-rails 4.1.6 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 577efe95018b382a927d9078662707a033c579fa37757467e9cbdbead6ddadb1
-  data.tar.gz: d99a6385af1d142f446649bd4df596299c8ace976ca333313897335e3dabe44f
+  metadata.gz: 7f1aafc591c356c77484bf061be1d4f8968588270e083d6ee94ada2f80054282
+  data.tar.gz: 74e40b15bdc17962037fd2b78b6695de5a405335a186f373c644dcb61b75aab6
 SHA512:
-  metadata.gz: 899fd5096e17f61dc6d0186cdcb87c93c555dce397bd5c4e4ade88fd704e320290e7fb2a7cbfebb9eaf21a188e6e3823d0f7e298db645eb438110d93831d7d1e
-  data.tar.gz: 1f16fc8dd1e35c38d7a6b78449ae586bae30d9f611c98d43cb6f497f7a21accb84d6552f7eaddb41a0cb32adb01b597b67e41173266f27c562b8242a7291ae7d
+  metadata.gz: 279ad65af3f35928746b8365bc494bf0384fde465414c1211cb565289bb7cbf1157c0649da6c835e4bbb79b928005eebba2805f387a52a57170bba876279b0fb
+  data.tar.gz: 6bf36d990e2c7f3ab51d8e5bb6bd2ec6873d924f2baa72796145502b2b4f04eea055c8c22a06a6bb8f0cbe92b2c92b15a7e29262f21252fce98be579f7e3fc38

data/.gitignore

@@ -5,6 +5,7 @@
 /doc/
 /pkg/
 /spec/reports/
+/spec/support/test_rails_app/db
 /tmp/
 
 # rspec failure tracking

data/CHANGELOG.md

@@ -1,5 +1,69 @@
 # Changelog
 
+## 4.3.0
+
+### Features
+
+- Support performance monitoring on ActiveJob execution [#1304](https://github.com/getsentry/sentry-ruby/pull/1304)
+
+### Bug Fixes
+
+- Prevent background workers from holding ActiveRecord connections [#1320](https://github.com/getsentry/sentry-ruby/pull/1320)
+
+## 4.2.2
+
+- Always define Sentry::SendEventJob to avoid eager load issues [#1286](https://github.com/getsentry/sentry-ruby/pull/1286)
+  - Fixes [#1283](https://github.com/getsentry/sentry-ruby/issues/1283)
+
+## 4.2.1
+
+- Add additional checks to SendEventJob's definition [#1275](https://github.com/getsentry/sentry-ruby/pull/1275)
+  - Fixes [#1270](https://github.com/getsentry/sentry-ruby/issues/1270)
+  - Fixes [#1277](https://github.com/getsentry/sentry-ruby/issues/1277)
+
+## 4.2.0
+
+### Features
+
+- Make sentry-rails a Rails engine and provide default job class for async [#1181](https://github.com/getsentry/sentry-ruby/pull/1181)
+
+`sentry-rails` now provides a default ActiveJob class for sending events asynchronously. You can use it directly without define your own one:
+
+```ruby
+config.async = lambda { |event, hint| Sentry::SendEventJob.perform_later(event, hint) }
+```
+
+- Add configuration option for trusted proxies [#1126](https://github.com/getsentry/sentry-ruby/pull/1126)
+
+`sentry-rails` now injects `Rails.application.config.action_dispatch.trusted_proxies` into `Sentry.configuration.trusted_proxies` automatically.
+
+- Allow users to configure ActiveJob adapters to ignore [#1256](https://github.com/getsentry/sentry-ruby/pull/1256)
+
+```ruby
+# sentry-rails will skip active_job reporting for jobs that use ActiveJob::QueueAdapters::SidekiqAdapter
+# you should use this option when:
+# - you don't want to see events from a certain adapter
+# - you already have a better reporting setup for the adapter (like having `sentry-sidekiq` installed)
+config.rails.skippable_job_adapters = ["ActiveJob::QueueAdapters::SidekiqAdapter"]
+```
+
+- Tag `job_id` and `provider_job_id` on ActiveJob events [#1259](https://github.com/getsentry/sentry-ruby/pull/1259)
+
+<img width="1330" alt="example of tagged event" src="https://user-images.githubusercontent.com/5079556/106389781-3a03f100-6420-11eb-810c-a99869eb26dd.png">
+
+- Use another method for post initialization callback [#1261](https://github.com/getsentry/sentry-ruby/pull/1261)
+
+### Bug Fixes
+
+- Inspect exception cause by default & don't exclude ActiveJob::DeserializationError [#1180](https://github.com/getsentry/sentry-ruby/pull/1180)
+  - Fixes [#1071](https://github.com/getsentry/sentry-ruby/issues/1071)
+
+## 4.1.7
+
+- Use env to carry original transaction name [#1255](https://github.com/getsentry/sentry-ruby/pull/1255)
+- Fix duration of tracing event in Rails 5 [#1254](https://github.com/getsentry/sentry-ruby/pull/1254) (by @abcang)
+- Filter out static file transaction [#1247](https://github.com/getsentry/sentry-ruby/pull/1247)
+
 ## 4.1.6
 
 - Prevent exceptions app from overriding event's transaction name [#1230](https://github.com/getsentry/sentry-ruby/pull/1230)
@@ -69,4 +133,3 @@ Release test
 ## 0.1.0
 
 First version
-

data/Gemfile

@@ -8,15 +8,24 @@ rails_version = "6.1.0" if rails_version.nil?
 
 gem 'activerecord-jdbcmysql-adapter', platform: :jruby
 gem "jdbc-sqlite3", platform: :jruby
-gem "sqlite3", platform: :ruby
+
+if rails_version.to_f < 6
+  gem "sqlite3", "~> 1.3.0", platform: :ruby
+else
+  gem "sqlite3", platform: :ruby
+end
 
 gem "rails", "~> #{rails_version}"
+gem "sprockets-rails"
 gem "rspec-rails", "~> 4.0"
 gem "codecov", "0.2.12"
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.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"

data/app/jobs/sentry/send_event_job.rb

@@ -0,0 +1,34 @@
+if defined?(ActiveJob)
+  module Sentry
+    parent_job =
+      if defined?(::ApplicationJob) && ::ApplicationJob.ancestors.include?(::ActiveJob::Base)
+        ::ApplicationJob
+      else
+        ::ActiveJob::Base
+      end
+
+    class SendEventJob < parent_job
+      # the event argument is usually large and creates noise
+      self.log_arguments = false if respond_to?(:log_arguments=)
+
+      # this will prevent infinite loop when there's an issue deserializing SentryJob
+      if respond_to?(:discard_on)
+        discard_on ActiveJob::DeserializationError
+      else
+        # mimic what discard_on does for Rails 5.0
+        rescue_from ActiveJob::DeserializationError do
+          logger.error "Discarded #{self.class} due to a #{exception}. The original exception was #{error.cause.inspect}."
+        end
+      end
+
+      def perform(event, hint = {})
+        Sentry.send_event(event, hint)
+      end
+    end
+  end
+else
+  module Sentry
+    class SendEventJob; end
+  end
+end
+

data/lib/sentry/rails.rb

@@ -1,6 +1,8 @@
 require "sentry-ruby"
 require "sentry/integrable"
+require "sentry/rails/background_worker"
 require "sentry/rails/configuration"
+require "sentry/rails/engine"
 require "sentry/rails/railtie"
 require "sentry/rails/tracing"
 

data/lib/sentry/rails/active_job.rb

@@ -1,10 +1,6 @@
 module Sentry
   module Rails
     module ActiveJobExtensions
-      ALREADY_SUPPORTED_SENTRY_ADAPTERS = %w(
-        ActiveJob::QueueAdapters::SidekiqAdapter
-      ).freeze
-
       def self.included(base)
         base.class_eval do
           around_perform do |job, block|
@@ -12,8 +8,8 @@ module Sentry
               if already_supported_by_specific_integration?(job)
                 block.call
               else
-                Sentry.with_scope do
-                  capture_and_reraise_with_sentry(job, block)
+                Sentry.with_scope do |scope|
+                  capture_and_reraise_with_sentry(job, scope, block)
                 end
               end
             else
@@ -23,34 +19,51 @@ module Sentry
         end
       end
 
-      def capture_and_reraise_with_sentry(job, block)
+      def capture_and_reraise_with_sentry(job, scope, block)
+        scope.set_transaction_name(job.class.name)
+        transaction = Sentry.start_transaction(name: scope.transaction_name, op: "active_job")
+
+        scope.set_span(transaction) if transaction
+
         block.call
+
+        finish_transaction(transaction, 200)
       rescue Exception => e # rubocop:disable Lint/RescueException
         rescue_handler_result = rescue_with_handler(e)
+        finish_transaction(transaction, 500)
         return rescue_handler_result if rescue_handler_result
 
-        Sentry::Rails.capture_exception(e, extra: sentry_context(job))
+        Sentry::Rails.capture_exception(
+          e,
+          extra: sentry_context(job),
+          tags: {
+            job_id: job.job_id,
+            provider_job_id: job.provider_job_id
+          }
+        )
         raise e
       end
 
+      def finish_transaction(transaction, status)
+        return unless transaction
+
+        transaction.set_http_status(status)
+        transaction.finish
+      end
+
       def already_supported_by_specific_integration?(job)
-        ALREADY_SUPPORTED_SENTRY_ADAPTERS.include?(job.class.queue_adapter.class.to_s)
+        Sentry.configuration.rails.skippable_job_adapters.include?(job.class.queue_adapter.class.to_s)
       end
 
       def sentry_context(job)
-        ctx = {
-          :active_job => job.class.name,
-          :arguments => job.arguments,
-          :scheduled_at => job.scheduled_at,
-          :job_id => job.job_id,
-          :locale => job.locale
+        {
+          active_job: job.class.name,
+          arguments: job.arguments,
+          scheduled_at: job.scheduled_at,
+          job_id: job.job_id,
+          provider_job_id: job.provider_job_id,
+          locale: job.locale
         }
-        # Add provider_job_id details if Rails 5
-        if job.respond_to?(:provider_job_id)
-          ctx[:provider_job_id] = job.provider_job_id
-        end
-
-        ctx
       end
     end
   end

data/lib/sentry/rails/background_worker.rb

@@ -0,0 +1,14 @@
+module Sentry
+  class BackgroundWorker
+    alias_method :original_perform, :perform
+
+    def perform(&block)
+      @executor.post do
+        # make sure the background worker returns AR connection if it accidentally acquire one during serialization
+        ActiveRecord::Base.connection_pool.with_connection do
+          block.call
+        end
+      end
+    end
+  end
+end

data/lib/sentry/rails/capture_exceptions.rb

@@ -1,6 +1,14 @@
 module Sentry
   module Rails
     class CaptureExceptions < Sentry::Rack::CaptureExceptions
+      def initialize(app)
+        super
+
+        if defined?(::Sprockets::Rails)
+          @assets_regex = %r(\A/{0,2}#{::Rails.application.config.assets.prefix})
+        end
+      end
+
       private
 
       def collect_exception(env)
@@ -12,8 +20,26 @@ module Sentry
       end
 
       def capture_exception(exception)
+        current_scope = Sentry.get_current_scope
+
+        if original_transaction = current_scope.rack_env["sentry.original_transaction"]
+          current_scope.set_transaction_name(original_transaction)
+        end
+
         Sentry::Rails.capture_exception(exception)
       end
+
+      def start_transaction(env, scope)
+        transaction = super
+
+        return unless transaction
+
+        if @assets_regex && transaction.name.match?(@assets_regex)
+          transaction.instance_variable_set(:@sampled, false)
+        end
+
+        transaction
+      end
     end
   end
 end

data/lib/sentry/rails/configuration.rb

@@ -2,7 +2,7 @@ module Sentry
   class Configuration
     attr_reader :rails
 
-    def post_initialization_callback
+    add_post_initialization_callback do
       @rails = Sentry::Rails::Configuration.new
       @excluded_exceptions = @excluded_exceptions.concat(Sentry::Rails::IGNORE_DEFAULT)
     end
@@ -23,7 +23,6 @@ module Sentry
       'ActionDispatch::Http::MimeNegotiation::InvalidType',
       'ActionController::UnknownHttpMethod',
       'ActionDispatch::Http::Parameters::ParseError',
-      'ActiveJob::DeserializationError', # Can cause infinite loops
       'ActiveRecord::RecordNotFound'
     ].freeze
     class Configuration
@@ -33,8 +32,14 @@ module Sentry
       # will report exceptions even when they are rescued by these middlewares.
       attr_accessor :report_rescued_exceptions
 
+      # Some adapters, like sidekiq, already have their own sentry integration.
+      # In those cases, we should skip ActiveJob's reporting to avoid duplicated reports.
+      attr_accessor :skippable_job_adapters
+
       def initialize
         @report_rescued_exceptions = true
+        # TODO: Remove this in 4.2.0
+        @skippable_job_adapters = []
       end
     end
   end

data/lib/sentry/rails/engine.rb

@@ -0,0 +1,5 @@
+module Sentry
+  class Engine < ::Rails::Engine
+    isolate_namespace Sentry
+  end
+end

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

@@ -0,0 +1,16 @@
+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

data/lib/sentry/rails/railtie.rb

@@ -5,6 +5,7 @@ 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
@@ -16,14 +17,16 @@ module Sentry
       app.config.middleware.use(Sentry::Rails::RescuedExceptionInterceptor)
     end
 
-    config.after_initialize do
+    config.after_initialize do |app|
       next unless Sentry.initialized?
 
       configure_project_root
       configure_sentry_logger
+      configure_trusted_proxies
       extend_controller_methods
       extend_active_job if defined?(ActiveJob)
       override_streaming_reporter
+      override_file_handler if app.config.public_file_server.enabled
       setup_backtrace_cleanup_callback
       inject_breadcrumbs_logger
       activate_tracing
@@ -37,6 +40,10 @@ module Sentry
       Sentry.configuration.logger = ::Rails.logger
     end
 
+    def configure_trusted_proxies
+      Sentry.configuration.trusted_proxies += Array(::Rails.application.config.action_dispatch.trusted_proxies)
+    end
+
     def extend_active_job
       require "sentry/rails/active_job"
       ActiveJob::Base.send(:prepend, Sentry::Rails::ActiveJobExtensions)
@@ -71,6 +78,12 @@ module Sentry
       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?
         Sentry::Rails::Tracing.subscribe_tracing_events

data/lib/sentry/rails/rescued_exception_interceptor.rb

@@ -17,14 +17,9 @@ module Sentry
           # so we need to hold a copy of env to report the accurate data (like request's url)
           if request.show_exceptions?
             scope = Sentry.get_current_scope
-            scope.set_rack_env(scope.rack_env.dup)
-            transaction = scope.transaction_name
-
-            # we also need to make sure the transaction name won't be overridden by the exceptions app
-            scope.add_event_processor do |event, hint|
-              event.transaction = transaction
-              event
-            end
+            copied_env = scope.rack_env.dup
+            copied_env["sentry.original_transaction"] = scope.transaction_name
+            scope.set_rack_env(copied_env)
           end
 
           env["sentry.rescued_exception"] = e if Sentry.configuration.rails.report_rescued_exceptions

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

@@ -14,11 +14,11 @@ module Sentry
 
           def subscribe_to_event(event_name)
             if ::Rails.version.to_i == 5
-              ActiveSupport::Notifications.subscribe(event_name) do |_, start, finish, _, payload|
+              ActiveSupport::Notifications.subscribe(event_name) do |*args|
                 next unless Tracing.get_current_transaction
 
-                duration = finish.to_f - start.to_f
-                yield(event_name, duration, payload)
+                event = ActiveSupport::Notifications::Event.new(*args)
+                yield(event_name, event.duration, event.payload)
               end
             else
               ActiveSupport::Notifications.subscribe(event_name) do |event|

data/lib/sentry/rails/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Rails
-    VERSION = "4.1.6"
+    VERSION = "4.3.0"
   end
 end

data/sentry-rails.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rails", ">= 5.0"
-  spec.add_dependency "sentry-ruby-core", "~> 4.1.2"
+  spec.add_dependency "sentry-ruby-core", "~> 4.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 4.1.6
+  version: 4.3.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-28 00:00:00.000000000 Z
+date: 2021-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: 4.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: 4.3.0
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -56,17 +56,21 @@ files:
 - Makefile
 - README.md
 - Rakefile
+- app/jobs/sentry/send_event_job.rb
 - bin/console
 - bin/setup
 - lib/sentry-rails.rb
 - lib/sentry/rails.rb
 - lib/sentry/rails/active_job.rb
+- lib/sentry/rails/background_worker.rb
 - lib/sentry/rails/backtrace_cleaner.rb
 - lib/sentry/rails/breadcrumb/active_support_logger.rb
 - lib/sentry/rails/capture_exceptions.rb
 - lib/sentry/rails/configuration.rb
 - 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