sentry-rails 4.1.3 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81491f8d74dfb70ff29222476cc66bb08bf2e3b7e2b013b881a8c79b9992ca04
-  data.tar.gz: c2be7c2616fa93da1a096b4352b9b353745cc6972c27df72933908e700f7666a
+  metadata.gz: 88b2f50f7497ed668cc86fda80d8bbd653e3e01b3a7d3c3f7643e5de81de697c
+  data.tar.gz: e2ee2b20c9a85f947f4fcfe4f5c68b82226336aa54c73b5c116e767307bb4cd0
 SHA512:
-  metadata.gz: 8d3b47180e068af27983bf72ab65b15bd0a96a312ab414f52b6724d82f1fbf17cab8093122778ed62b3990f5a9bd8ad8d32713562395bce88cd0b984f3490320
-  data.tar.gz: 02226dc92b5d3f4ee08d95cc5710f4ee534cf2f5a71c1f8124ee5135948038e39b238e1e674874cb4810589b05d46a26c21040069f589e37cb389fbab9463979
+  metadata.gz: 1c86549b0348fec623ed863f9f11147d6cf04c20a7c8cd4ba96755959084f8d8436a8ee768edf5011230b7dfe62155aafcca7f1aaebf298a30d2dff1799c9310
+  data.tar.gz: f6ee86657ef5960e22fe72c826b86ee0992a16769416429ab791821b2d974672ebe83d3c8fead135554ad2acdda6c0f59ad4a1c291d0ae3e6e7dc8d1584dfee4

data/CHANGELOG.md

@@ -1,5 +1,70 @@
 # Changelog
 
+## 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)
+- Fix project root detection [#1242](https://github.com/getsentry/sentry-ruby/pull/1242)
+- Use sentry-ruby-core as the main SDK dependency [#1244](https://github.com/getsentry/sentry-ruby/pull/1244)
+
+## 4.1.5
+
+- Add `ActionDispatch::Http::MimeNegotiation::InvalidType` to the list of default ignored Rails exceptions [#1215](https://github.com/getsentry/sentry-ruby/pull/1215) (by @agrobbin)
+- Continue ActiveJob execution if Sentry is not initialized [#1217](https://github.com/getsentry/sentry-ruby/pull/1217)
+  - Fixes [#1211](https://github.com/getsentry/sentry-ruby/issues/1211) and [#1216](https://github.com/getsentry/sentry-ruby/issues/1216)
+- Only extend ActiveJob when it's defined [#1218](https://github.com/getsentry/sentry-ruby/pull/1218)
+  - Fixes [#1210](https://github.com/getsentry/sentry-ruby/issues/1210)
+- Filter out redundant event/payload from breadcrumbs logger [#1222](https://github.com/getsentry/sentry-ruby/pull/1222)
+- Copy request env before Rails' ShowExceptions middleware [#1223](https://github.com/getsentry/sentry-ruby/pull/1223)
+- Don't subscribe render_partial and render_collection events [#1224](https://github.com/getsentry/sentry-ruby/pull/1224)
+
+## 4.1.4
+
+- Don't include headers & request info in tracing span or breadcrumb [#1199](https://github.com/getsentry/sentry-ruby/pull/1199)
+- Don't run RescuedExceptionInterceptor unless Sentry is initialized [#1204](https://github.com/getsentry/sentry-ruby/pull/1204)
+
 ## 4.1.3
 
 - Remove DelayedJobAdapter from ignored list [#1179](https://github.com/getsentry/sentry-ruby/pull/1179)
@@ -47,4 +112,3 @@ Release test
 ## 0.1.0
 
 First version
-

data/Gemfile

@@ -11,12 +11,16 @@ gem "jdbc-sqlite3", platform: :jruby
 gem "sqlite3", platform: :ruby
 
 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/Makefile

@@ -0,0 +1,3 @@
+build:
+	bundle install
+	gem build sentry-rails.gemspec

data/README.md

@@ -44,7 +44,7 @@ Sentry.init do |config|
   # the default value is true
   config.rails.report_rescued_exceptions = true
 
-  # this gem also provides a new breadcrumb logger that accepts instrumentaions from ActiveSupport
+  # this gem also provides a new breadcrumb logger that accepts instrumentations from ActiveSupport
   # it's not activated by default, but you can enable it with
   config.breadcrumbs_logger = [:active_support_logger]
 end

data/app/jobs/sentry/send_event_job.rb

@@ -0,0 +1,20 @@
+return unless defined?(ActiveJob)
+
+module Sentry
+  parent_job =
+    if defined?(ApplicationJob)
+      ApplicationJob
+    else
+      ActiveJob::Base
+    end
+
+  class SendEventJob < parent_job
+    self.log_arguments = false if ::Rails.version.to_f >= 6.1
+    discard_on ActiveJob::DeserializationError # this will prevent infinite loop when there's an issue deserializing SentryJob
+
+    def perform(event, hint = {})
+      Sentry.send_event(event, hint)
+    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,19 +1,19 @@
 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|
-            if already_supported_by_specific_integration?(job)
-              block.call
-            else
-              Sentry.with_scope do
-                capture_and_reraise_with_sentry(job, block)
+            if Sentry.initialized?
+              if already_supported_by_specific_integration?(job)
+                block.call
+              else
+                Sentry.with_scope do
+                  capture_and_reraise_with_sentry(job, block)
+                end
               end
+            else
+              block.call
             end
           end
         end
@@ -25,28 +25,30 @@ module Sentry
         rescue_handler_result = rescue_with_handler(e)
         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 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/breadcrumb/active_support_logger.rb

@@ -3,7 +3,18 @@ module Sentry
     module Breadcrumb
       module ActiveSupportLogger
         class << self
+          IGNORED_DATA_TYPES = [:request, :headers, :exception, :exception_object]
+
           def add(name, started, _finished, _unique_id, data)
+            # skip Rails' internal events
+            return if name.start_with?("!")
+
+            if data.is_a?(Hash)
+              # we should only mutate the copy of the data
+              data = data.dup
+              cleanup_data(data)
+            end
+
             crumb = Sentry::Breadcrumb.new(
               data: data,
               category: name,
@@ -12,6 +23,12 @@ 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

@@ -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,21 @@ 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 finish_span(span, status_code)
+        if @assets_regex.nil? || !span.name.match?(@assets_regex)
+          span.set_http_status(status_code)
+          span.finish
+        end
+      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
@@ -20,9 +20,9 @@ module Sentry
       'ActionController::RoutingError',
       'ActionController::UnknownAction',
       'ActionController::UnknownFormat',
+      'ActionDispatch::Http::MimeNegotiation::InvalidType',
       'ActionController::UnknownHttpMethod',
       'ActionDispatch::Http::Parameters::ParseError',
-      'ActiveJob::DeserializationError', # Can cause infinite loops
       'ActiveRecord::RecordNotFound'
     ].freeze
     class Configuration
@@ -32,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

@@ -4,8 +4,8 @@ require "sentry/rails/rescued_exception_interceptor"
 require "sentry/rails/backtrace_cleaner"
 require "sentry/rails/controller_methods"
 require "sentry/rails/controller_transaction"
-require "sentry/rails/active_job"
 require "sentry/rails/overrides/streaming_reporter"
+require "sentry/rails/overrides/file_handler"
 
 module Sentry
   class Railtie < ::Rails::Railtie
@@ -17,23 +17,35 @@ 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
+      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
     end
 
+    def configure_project_root
+      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
+
     def extend_active_job
+      require "sentry/rails/active_job"
       ActiveJob::Base.send(:prepend, Sentry::Rails::ActiveJobExtensions)
     end
 
@@ -66,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

@@ -6,9 +6,22 @@ module Sentry
       end
 
       def call(env)
+        return @app.call(env) unless Sentry.initialized?
+
         begin
           @app.call(env)
         rescue => e
+          request = ActionDispatch::Request.new(env)
+
+          # Rails' ShowExceptions#render_exception will mutate env for the exceptions app
+          # 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
+            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
           raise e
         end

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/tracing/action_controller_subscriber.rb

@@ -15,6 +15,9 @@ module Sentry
               description: "#{controller}##{action}",
               duration: duration
             ) do |span|
+              payload = payload.dup
+              payload.delete(:headers)
+              payload.delete(:request)
               span.set_data(:payload, payload)
               span.set_http_status(payload[:status])
             end

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

@@ -2,19 +2,11 @@ module Sentry
   module Rails
     module Tracing
       class ActionViewSubscriber < AbstractSubscriber
-        EVENT_NAMES = ["render_template.action_view", "render_partial.action_view", "render_collection.action_view"]
+        EVENT_NAME = "render_template.action_view".freeze
 
         def self.subscribe!
-          EVENT_NAMES.each do |event_name|
-            subscribe_to_event(event_name) do |event_name, duration, payload|
-              record_on_current_span(op: event_name, start_timestamp: payload[:start_timestamp], description: payload[:identifier], duration: duration)
-            end
-          end
-        end
-
-        def self.unsubscribe!
-          EVENT_NAMES.each do |event_name|
-            ActiveSupport::Notifications.unsubscribe(event_name)
+          subscribe_to_event(EVENT_NAME) do |event_name, duration, payload|
+            record_on_current_span(op: event_name, start_timestamp: payload[:start_timestamp], description: payload[:identifier], duration: duration)
           end
         end
       end

data/lib/sentry/rails/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Rails
-    VERSION = "4.1.3"
+    VERSION = "4.2.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/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/sentry-rails/CHANGELOG.md"
 
   spec.bindir        = "exe"
   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", "~> 4.1.2"
+  spec.add_dependency "sentry-ruby-core", "~> 4.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 4.1.3
+  version: 4.2.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-04 00:00:00.000000000 Z
+date: 2021-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: sentry-ruby
+  name: sentry-ruby-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: 4.2.0
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -49,13 +49,14 @@ files:
 - ".craft.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
+- app/jobs/sentry/send_event_job.rb
 - bin/console
 - bin/setup
 - lib/sentry-rails.rb
@@ -67,6 +68,8 @@ files:
 - 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
@@ -83,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/CHANGELOG.md
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/master/sentry-rails/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.5
-before_install: gem install bundler -v 2.1.1