sentry-rails 0.2.0 → 4.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e7eaef0b61e66058c293dd473a41a8a45af0c1547325099540d81f7802be480
-  data.tar.gz: c67ee2d0741a7822c43b3d29ad3d44a8590a032abe0727487dd88e09934f9449
+  metadata.gz: 8d6a1afa9da4c0ec517f7cf0b494f7965f9d6b30450ed005face3d28d541430e
+  data.tar.gz: 21a9be637731b712e430eee4652a3b98d7eef0475c7027833172b2dfb8a414fd
 SHA512:
-  metadata.gz: 82bbf7256864d79f10863c730508e7d0f24c0923ec0fbf77446584db1ecae1b04dcfb9e1de45367e3c0528848bd8e41d3db6d45e7d6be6eada7e2abd4e47c808
-  data.tar.gz: 661da577ee137848c260fcd019413b0efd7b0cc7756f90b33ba4f049446f3b1439439929e50b8ffddbfa08c1d6e907aa7f7e04761630b5cfaf81f29fe2ec1589
+  metadata.gz: 8d9c22704d42808bb82104540524468e696da6e24340b6e79216c1dfd0510a8e30099915fb9502c676ecc4f399d7bf29c48468708e2b29a2b9b656a771c8264d
+  data.tar.gz: 4eaff646e0096e0221c4389ff65ce50cd80a8ed4c03673718c1a5990b7a02f5d4639dffcb02a8622bc5f1f5b563c8c0dcaad8af77a72577d577c1744c81529a5

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Changelog
 
+## 4.1.2
+
+- Use middleware instead of method override to handle rescued exceptions [#1168](https://github.com/getsentry/sentry-ruby/pull/1168)
+  - Fixes [#738](https://github.com/getsentry/sentry-ruby/issues/738)
+- Adopt Integrable module [#1177](https://github.com/getsentry/sentry-ruby/pull/1177)
+
+## 4.1.1
+
+- Use stricter dependency declaration [#1159](https://github.com/getsentry/sentry-ruby/pull/1159)
+
+## 4.1.0
+
+- Merge & rename 2 Rack middlewares [#1147](https://github.com/getsentry/sentry-ruby/pull/1147)
+  - Fixes [#1153](https://github.com/getsentry/sentry-ruby/pull/1153)
+  - Removed `Sentry::Rack::Tracing` middleware and renamed `Sentry::Rack::CaptureException` to `Sentry::Rack::CaptureExceptions`
+- Tidy up rails integration [#1150](https://github.com/getsentry/sentry-ruby/pull/1150)
+- Check SDK initialization before running integrations [#1151](https://github.com/getsentry/sentry-ruby/pull/1151)
+  - Fixes [#1145](https://github.com/getsentry/sentry-ruby/pull/1145)
+
+## 4.0.0
+
+- Only documents update for the official release and no API/feature changes.
+
+## 0.3.0
+
+- Major API changes: [1123](https://github.com/getsentry/sentry-ruby/pull/1123)
+
 ## 0.2.0
 
 - Multiple fixes and refactorings

data/Gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 gemspec
 
 rails_version = ENV["RAILS_VERSION"]
-rails_version = "6.0" if rails_version.nil?
+rails_version = "6.1.0" if rails_version.nil?
 
 gem 'activerecord-jdbcmysql-adapter', platform: :jruby
 gem "jdbc-sqlite3", platform: :jruby
@@ -12,7 +12,7 @@ gem "sqlite3", platform: :ruby
 
 gem "rails", "~> #{rails_version}"
 gem "rspec-rails", "~> 4.0"
-gem "codecov"
+gem "codecov", "0.2.12"
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"

data/README.md

@@ -17,7 +17,7 @@
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=sentry-rails&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=sentry-rails&package-manager=bundler&version-scheme=semver)
 
 
-[Documentation](https://docs.sentry.io/clients/ruby/) | [Bug Tracker](https://github.com/getsentry/sentry-ruby/issues) | [Forum](https://forum.sentry.io/) | IRC: irc.freenode.net, #sentry
+[Documentation](https://docs.sentry.io/platforms/ruby/guides/rails/) | [Bug Tracker](https://github.com/getsentry/sentry-ruby/issues) | [Forum](https://forum.sentry.io/) | IRC: irc.freenode.net, #sentry
 
 The official Ruby-language client and integration layer for the [Sentry](https://github.com/getsentry/sentry) error reporting API.
 
@@ -50,3 +50,36 @@ Sentry.init do |config|
 end
 ```
 
+### Performance Monitoring
+
+You can activate performance monitoring by enabling traces sampling:
+
+```ruby
+Sentry.init do |config|
+  # set a uniform sample rate between 0.0 and 1.0
+  config.traces_sample_rate = 0.2
+
+  # or control sampling dynamically
+  config.traces_sampler = lambda do |sampling_context|
+    # sampling_context[:transaction_context] contains the information about the transaction
+    # sampling_context[:parent_sampled] contains the transaction's parent's sample decision
+    true # return value can be a boolean or a float between 0.0 and 1.0
+  end
+end
+```
+
+Currently, it tracks the following Rails instrumentation events:
+
+- ActiveRecord
+  - `sql.active_record`
+- ActionController
+  - `process_action.action_controller`
+- ActionView
+  - `render_template.action_view`
+  - `render_partial.action_view`
+  - `render_collection.action_view`
+
+To lean more about performance monitoring, please visit the [official documentation](https://docs.sentry.io/platforms/ruby/guides/rails/performance/).
+
+
+

data/lib/sentry/rails.rb

@@ -1,14 +1,12 @@
 require "sentry-ruby"
+require "sentry/integrable"
 require "sentry/rails/configuration"
 require "sentry/rails/railtie"
 require "sentry/rails/tracing"
 
 module Sentry
   module Rails
-    META = { "name" => "sentry.ruby.rails", "version" => Sentry::Rails::VERSION }.freeze
-  end
-
-  def self.sdk_meta
-    Sentry::Rails::META
+    extend Integrable
+    register_integration name: "rails", version: Sentry::Rails::VERSION
   end
 end

data/lib/sentry/rails/active_job.rb

@@ -26,7 +26,7 @@ module Sentry
         rescue_handler_result = rescue_with_handler(e)
         return rescue_handler_result if rescue_handler_result
 
-        Sentry.capture_exception(e, :extra => sentry_context(job))
+        Sentry::Rails.capture_exception(e, extra: sentry_context(job))
         raise e
       end
 

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

@@ -4,16 +4,20 @@ module Sentry
       module ActiveSupportLogger
         class << self
           def add(name, started, _finished, _unique_id, data)
-            Sentry.get_current_scope.breadcrumbs.record do |crumb|
-              crumb.data = data
-              crumb.category = name
-              crumb.timestamp = started.to_i
-            end
+            crumb = Sentry::Breadcrumb.new(
+              data: data,
+              category: name,
+              timestamp: started.to_i
+            )
+            Sentry.add_breadcrumb(crumb)
           end
 
           def inject
             @subscriber = ::ActiveSupport::Notifications.subscribe(/.*/) do |name, started, finished, unique_id, data|
-              add(name, started, finished, unique_id, data)
+              # we only record events that has a started timestamp
+              if started.is_a?(Time)
+                add(name, started, finished, unique_id, data)
+              end
             end
           end
 

data/lib/sentry/rails/capture_exceptions.rb

@@ -0,0 +1,19 @@
+module Sentry
+  module Rails
+    class CaptureExceptions < Sentry::Rack::CaptureExceptions
+      private
+
+      def collect_exception(env)
+        super || env["action_dispatch.exception"] || env["sentry.rescued_exception"]
+      end
+
+      def transaction_op
+        "rails.request".freeze
+      end
+
+      def capture_exception(exception)
+        Sentry::Rails.capture_exception(exception)
+      end
+    end
+  end
+end

data/lib/sentry/rails/controller_methods.rb

@@ -3,13 +3,13 @@ module Sentry
     module ControllerMethods
       def capture_message(message, options = {})
         with_request_scope do
-          Sentry.capture_message(message, **options)
+          Sentry::Rails.capture_message(message, **options)
         end
       end
 
       def capture_exception(exception, options = {})
         with_request_scope do
-          Sentry.capture_exception(exception, **options)
+          Sentry::Rails.capture_exception(exception, **options)
         end
       end
 

data/lib/sentry/rails/controller_transaction.rb

@@ -2,10 +2,8 @@ module Sentry
   module Rails
     module ControllerTransaction
       def self.included(base)
-        base.prepend_around_action do |controller, block|
+        base.prepend_before_action do |controller|
           Sentry.get_current_scope.set_transaction_name("#{controller.class}##{controller.action_name}")
-          block.call
-          Sentry.get_current_scope.transaction_names.pop
         end
       end
     end

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

@@ -3,7 +3,7 @@ module Sentry
     module Overrides
       module StreamingReporter
         def log_error(exception)
-          Sentry.capture_exception(exception)
+          Sentry::Rails.capture_exception(exception)
           super
         end
       end
@@ -14,7 +14,7 @@ module Sentry
         end
 
         def log_error_with_raven(exception)
-          Sentry.capture_exception(exception)
+          Sentry::Rails.capture_exception(exception)
           log_error_without_raven(exception)
         end
       end

data/lib/sentry/rails/railtie.rb

@@ -1,5 +1,6 @@
 require "rails"
-require "sentry/rails/capture_exception"
+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"
@@ -8,12 +9,35 @@ require "sentry/rails/overrides/streaming_reporter"
 
 module Sentry
   class Railtie < ::Rails::Railtie
+    # middlewares can't be injected after initialize
     initializer "sentry.use_rack_middleware" do |app|
-      app.config.middleware.insert 0, Sentry::Rails::CaptureException
-      app.config.middleware.insert 0, Sentry::Rack::Tracing
+      # need to be placed at first to capture as many errors as possible
+      app.config.middleware.insert 0, Sentry::Rails::CaptureExceptions
+      # need to be placed at last to smuggle app exceptions via env
+      app.config.middleware.use(Sentry::Rails::RescuedExceptionInterceptor)
     end
 
-    initializer 'sentry.action_controller' do
+    config.after_initialize do
+      next unless Sentry.initialized?
+
+      configure_sentry_logger
+      extend_controller_methods
+      extend_active_job
+      override_streaming_reporter
+      setup_backtrace_cleanup_callback
+      inject_breadcrumbs_logger
+      activate_tracing
+    end
+
+    def configure_sentry_logger
+      Sentry.configuration.logger = ::Rails.logger
+    end
+
+    def extend_active_job
+      ActiveJob::Base.send(:prepend, Sentry::Rails::ActiveJobExtensions)
+    end
+
+    def extend_controller_methods
       ActiveSupport.on_load :action_controller do
         include Sentry::Rails::ControllerMethods
         include Sentry::Rails::ControllerTransaction
@@ -21,51 +45,32 @@ module Sentry
       end
     end
 
-    initializer 'sentry.action_view' do
-      ActiveSupport.on_load :action_view do
-        ActionView::StreamingTemplateRenderer::Body.send(:prepend, Sentry::Rails::Overrides::StreamingReporter)
+    def inject_breadcrumbs_logger
+      if Sentry.configuration.breadcrumbs_logger.include?(:active_support_logger)
+        require 'sentry/rails/breadcrumb/active_support_logger'
+        Sentry::Rails::Breadcrumb::ActiveSupportLogger.inject
       end
     end
 
-    config.after_initialize do
-      Sentry.configuration.logger = ::Rails.logger
-
+    def setup_backtrace_cleanup_callback
       backtrace_cleaner = Sentry::Rails::BacktraceCleaner.new
 
       Sentry.configuration.backtrace_cleanup_callback = lambda do |backtrace|
         backtrace_cleaner.clean(backtrace)
       end
+    end
 
-      if Sentry.configuration.breadcrumbs_logger.include?(:active_support_logger)
-        require 'sentry/rails/breadcrumb/active_support_logger'
-        Sentry::Rails::Breadcrumb::ActiveSupportLogger.inject
-      end
-
-      if Sentry.configuration.rails.report_rescued_exceptions
-        require 'sentry/rails/overrides/debug_exceptions_catcher'
-        if defined?(::ActionDispatch::DebugExceptions)
-          exceptions_class = ::ActionDispatch::DebugExceptions
-        elsif defined?(::ActionDispatch::ShowExceptions)
-          exceptions_class = ::ActionDispatch::ShowExceptions
-        end
-
-        exceptions_class.send(:prepend, Sentry::Rails::Overrides::DebugExceptionsCatcher)
+    def override_streaming_reporter
+      ActiveSupport.on_load :action_view do
+        ActionView::StreamingTemplateRenderer::Body.send(:prepend, Sentry::Rails::Overrides::StreamingReporter)
       end
+    end
 
+    def activate_tracing
       if Sentry.configuration.tracing_enabled?
         Sentry::Rails::Tracing.subscribe_tracing_events
         Sentry::Rails::Tracing.patch_active_support_notifications
       end
     end
-
-    initializer 'sentry.active_job' do
-      ActiveSupport.on_load :active_job do
-        require 'sentry/rails/active_job'
-      end
-    end
-
-    # rake_tasks do
-    #   require 'sentry/integrations/tasks'
-    # end
   end
 end

data/lib/sentry/rails/rescued_exception_interceptor.rb

@@ -0,0 +1,18 @@
+module Sentry
+  module Rails
+    class RescuedExceptionInterceptor
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        begin
+          @app.call(env)
+        rescue => e
+          env["sentry.rescued_exception"] = e if Sentry.configuration.rails.report_rescued_exceptions
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/sentry/rails/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Rails
-    VERSION = "0.2.0"
+    VERSION = "4.1.2"
   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", ">= 0.2.0"
+  spec.add_dependency "sentry-ruby", "~> 4.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 4.1.2
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-30 00:00:00.000000000 Z
+date: 2020-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,16 +28,16 @@ dependencies:
   name: sentry-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 4.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 4.1.2
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -63,13 +63,13 @@ files:
 - lib/sentry/rails/active_job.rb
 - lib/sentry/rails/backtrace_cleaner.rb
 - lib/sentry/rails/breadcrumb/active_support_logger.rb
-- lib/sentry/rails/capture_exception.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/overrides/debug_exceptions_catcher.rb
 - lib/sentry/rails/overrides/streaming_reporter.rb
 - lib/sentry/rails/railtie.rb
+- lib/sentry/rails/rescued_exception_interceptor.rb
 - lib/sentry/rails/tracing.rb
 - lib/sentry/rails/tracing/abstract_subscriber.rb
 - lib/sentry/rails/tracing/action_controller_subscriber.rb

data/lib/sentry/rails/capture_exception.rb

@@ -1,9 +0,0 @@
-module Sentry
-  module Rails
-    class CaptureException < Sentry::Rack::CaptureException
-      def collect_exception(env)
-        super || env["action_dispatch.exception"]
-      end
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-module Sentry
-  module Rails
-    module Overrides
-      module DebugExceptionsCatcher
-        def render_exception(env_or_request, exception)
-          begin
-            env = env_or_request.respond_to?(:env) ? env_or_request.env : env_or_request
-            Sentry.with_scope do |scope|
-              scope.set_rack_env(env)
-              Sentry.capture_exception(exception)
-            end
-          rescue
-          end
-          super
-        end
-      end
-    end
-  end
-end