sentry-rails 4.1.7 → 4.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e101fa2f42e1bf68db025a8c02a391ee510cfb43d286c63156397efcbcc1f6a
-  data.tar.gz: 8673fc2ff559d18b09c41b05e373116feb1ae7b04cbe4de5f99637afaf05c8da
+  metadata.gz: 7ecadcb6d10a87fe8d032001ac1b970da69e7037f4b7a6d7378992ae2b232258
+  data.tar.gz: 2a517ac4894d2dfdbe9e626fee8bfe11f5b984204598c22f082daeac9c4e7995
 SHA512:
-  metadata.gz: 156a36ae19a647b1b17e4278108296356339363f659d714b24dfcc095c14d59ae01ef85bc08c0c1a3331e401522bd7130214432a2a931f40fdeedff0ef6a0bcb
-  data.tar.gz: 897b9c2f0d82266b2725cbbd30bd8478fda5e1c3dae80927e6e3f73917d8ab417066c1be545b552a39d1ed6560f5ca8c16e0247cbf3199d3cabe110f41cd175c
+  metadata.gz: f5ab30a925984910229746fc86f03f217198f3eb28fae3f0348c2fa876c227558aab0bdde1aa572c88f8f9b5452c317089851bd5de6859c2f249756d611a0015
+  data.tar.gz: b4b59011dd1d8142453c2dc5794b6cc6a8b6c350afd0f41109f85ca00390b4a19f7131874daae57cfc458ad14d0ff2bea78cbd34a5a3dff0dcf25bb92e4a139b

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,68 @@
 # Changelog
 
+## 4.3.1
+
+- Only apply background worker patch if ActiveRecord is loaded [#1350](https://github.com/getsentry/sentry-ruby/pull/1350)
+  - Fixes [#1342](https://github.com/getsentry/sentry-ruby/issues/1342) and [#1346](https://github.com/getsentry/sentry-ruby/issues/1346)
+
+## 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)
@@ -75,4 +138,3 @@ Release test
 ## 0.1.0
 
 First version
-

data/Gemfile

@@ -8,15 +8,25 @@ 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", "~> 3.0"
+gem "rspec-retry"
 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"
 

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,7 @@
 require "sentry-ruby"
 require "sentry/integrable"
 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,12 @@
+module Sentry
+  class BackgroundWorker
+    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

@@ -29,11 +29,16 @@ module Sentry
         Sentry::Rails.capture_exception(exception)
       end
 
-      def finish_span(span, status_code)
-        if @assets_regex.nil? || !span.name.match?(@assets_regex)
-          span.set_http_status(status_code)
-          span.finish
+      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

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/railtie.rb

@@ -22,8 +22,10 @@ module Sentry
 
       configure_project_root
       configure_sentry_logger
+      configure_trusted_proxies
       extend_controller_methods
       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
       setup_backtrace_cleanup_callback
@@ -39,6 +41,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)
@@ -52,6 +58,10 @@ module Sentry
       end
     end
 
+    def patch_background_worker
+      require "sentry/rails/background_worker"
+    end
+
     def inject_breadcrumbs_logger
       if Sentry.configuration.breadcrumbs_logger.include?(:active_support_logger)
         require 'sentry/rails/breadcrumb/active_support_logger'

data/lib/sentry/rails/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Rails
-    VERSION = "4.1.7"
+    VERSION = "4.3.1"
   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.7
+  version: 4.3.1
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2021-03-19 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,20 @@ 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