sentry-rails 4.2.2 → 4.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e22a278e6c74ad09c754d5270c227c1dd0989c90654d2f3f55d3ca06e06ad577
-  data.tar.gz: c3bed6941cf8abdc306d20fd6ef7ebcecf08bb246b05921002423ac984a20d2b
+  metadata.gz: f1790a49cf858500aa57dd9290d37e794bb969b7b961e11047e8df61a090ec95
+  data.tar.gz: a9626020e87f157e1eed1c2f49296f796406958e789c379915fbecf5da49ff9a
 SHA512:
-  metadata.gz: bdda28d73217516a73ffdf82ddc81687649255623a38ebcd3f9aa52d98bdf6ced7882a13c1d9dae8509eda5e1bc82a99c2762c8c5e89cd27153a98e81ba7d691
-  data.tar.gz: 396aaacdf3db30251891de7bf4c5e6e5c27f5ce69eb6c9fc157f5fc70dada5c4fa782dac0dcf6050c6a8cf2474f680d801f4a7dac555b20f990aca077e8cfbc9
+  metadata.gz: 7d2d760f4fa7ac34e39294169f8be9c19d9ff7e19fb1c7a89d3205ff843b626bf90f89ee516b248539d180ac347c907ca23c55953033eb1d8588fd15e57f833c
+  data.tar.gz: 3fd609010fba1eef3a56ce52a5f09e7d58ad5f43f1c3b039d4deed3bdb89f276da434a2e76d2b6f06d79ae85c4ebb7daa24179503b607d3b6be23808005565ce

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,34 @@
 # Changelog
 
+## 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)
+  - 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)

data/Gemfile

@@ -17,11 +17,13 @@ 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"

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

@@ -8,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
@@ -19,10 +19,18 @@ 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(
@@ -36,6 +44,13 @@ module Sentry
         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)
         Sentry.configuration.rails.skippable_job_adapters.include?(job.class.queue_adapter.class.to_s)
       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

@@ -5,6 +5,7 @@ module Sentry
     add_post_initialization_callback do
       @rails = Sentry::Rails::Configuration.new
       @excluded_exceptions = @excluded_exceptions.concat(Sentry::Rails::IGNORE_DEFAULT)
+      @logger = ::Rails.logger
     end
   end
 

data/lib/sentry/rails/railtie.rb

@@ -1,11 +1,6 @@
-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
@@ -21,12 +16,12 @@ 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)
-      override_streaming_reporter
-      override_file_handler if app.config.public_file_server.enabled
+      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
@@ -36,10 +31,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
@@ -50,6 +41,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
@@ -57,6 +52,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'
@@ -73,12 +72,16 @@ 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
+      require "sentry/rails/overrides/file_handler"
+
       ActiveSupport.on_load :action_controller do
         ActionDispatch::FileHandler.send(:prepend, Sentry::Rails::Overrides::FileHandler)
       end

data/lib/sentry/rails/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Rails
-    VERSION = "4.2.2"
+    VERSION = "4.3.3"
   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.2.0"
+  spec.add_dependency "railties", ">= 5.0"
+  spec.add_dependency "sentry-ruby-core", "~> 4.3.0"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 4.2.2
+  version: 4.3.3
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2021-03-26 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.2.0
+        version: 4.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.3.0
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -62,6 +62,7 @@ files:
 - 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