sentry-rails 0.1.2 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a0780603b519760f8819b1e9245514d479f5c55595d7a5d91a09ea1d72d1ea9
-  data.tar.gz: d2137a13dd2f272298027818a2fd076c2b4a7b70bad18bd028b39a1fe95f9109
+  metadata.gz: f1ded72e004f25631844145fc5a86d4e4a20e90417a42ac608a91b92fd5a0702
+  data.tar.gz: 5b36ca31d954d72c0ee3f0407b3ad201285809b45439d580ccad910cf5f68d6f
 SHA512:
-  metadata.gz: 0c0a349aded55ded8dc9c1d758cb1d23ee30ee08fbe063f58b842d31436a1e282d66dfea089441f71c6519ed4df340ea4bb6a3293832bc9301edfc5c3509243a
-  data.tar.gz: ba5ed5414046187fcb7d1481e0808ff98bc35b91f61cd7481a5cba104e177fc36a3961fc6c23e871e9e7a2cc2cb8d6f8650b5ff21bc5cbc9c866a03d7fe654c4
+  metadata.gz: b91264b7393b702a5f4e08e8ac37836dd97e5055eb214b37faa704930bb56ef681edbc7baabc8fcced668d2a78c4d10ab039715036a8196f6734a7ef5f429467
+  data.tar.gz: bb6d1c2a6c051922126ba745350f1c003cf928309a6507867084f1a1833dd160a2ac6637cd909caadf69ac848d66a8789a1286409267c7aefbb74453836833c2

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 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
+- Tracing support
+
 ## 0.1.2
 
 Fix require reference

data/Gemfile

@@ -4,7 +4,11 @@ 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
+gem "sqlite3", platform: :ruby
 
 gem "rails", "~> #{rails_version}"
 gem "rspec-rails", "~> 4.0"
@@ -18,3 +22,8 @@ gem "sidekiq"
 gem "sentry-ruby", path: "../sentry-ruby"
 
 gem "pry"
+
+gem "benchmark-ips"
+gem "benchmark_driver"
+gem "benchmark-ipsa"
+gem "benchmark-memory"

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/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec).tap do |task|
+  task.rspec_opts = "--order rand"
+end
 
 task :default => :spec

data/lib/sentry/rails.rb

@@ -1,6 +1,7 @@
 require "sentry-ruby"
 require "sentry/rails/configuration"
 require "sentry/rails/railtie"
+require "sentry/rails/tracing"
 
 module Sentry
   module Rails

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_exception.rb → capture_exceptions.rb}

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

data/lib/sentry/rails/railtie.rb

@@ -1,5 +1,5 @@
 require "rails"
-require "sentry/rails/capture_exception"
+require "sentry/rails/capture_exceptions"
 require "sentry/rails/backtrace_cleaner"
 require "sentry/rails/controller_methods"
 require "sentry/rails/controller_transaction"
@@ -8,11 +8,33 @@ 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::Rails::CaptureExceptions
     end
 
-    initializer 'sentry.action_controller' do
+    config.after_initialize do
+      next unless Sentry.initialized?
+
+      configure_sentry_logger
+      extend_controller_methods
+      extend_active_job
+      override_exceptions_handling
+      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
@@ -20,26 +42,22 @@ 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
-
+    def override_exceptions_handling
       if Sentry.configuration.rails.report_rescued_exceptions
         require 'sentry/rails/overrides/debug_exceptions_catcher'
         if defined?(::ActionDispatch::DebugExceptions)
@@ -52,14 +70,17 @@ module Sentry
       end
     end
 
-    initializer 'sentry.active_job' do
-      ActiveSupport.on_load :active_job do
-        require 'sentry/rails/active_job'
+    def override_streaming_reporter
+      ActiveSupport.on_load :action_view do
+        ActionView::StreamingTemplateRenderer::Body.send(:prepend, Sentry::Rails::Overrides::StreamingReporter)
       end
     end
 
-    # rake_tasks do
-    #   require 'sentry/integrations/tasks'
-    # end
+    def activate_tracing
+      if Sentry.configuration.tracing_enabled?
+        Sentry::Rails::Tracing.subscribe_tracing_events
+        Sentry::Rails::Tracing.patch_active_support_notifications
+      end
+    end
   end
 end

data/lib/sentry/rails/tracing.rb

@@ -0,0 +1,65 @@
+require "sentry/rails/tracing/abstract_subscriber"
+require "sentry/rails/tracing/active_record_subscriber"
+require "sentry/rails/tracing/action_controller_subscriber"
+require "sentry/rails/tracing/action_view_subscriber"
+
+module Sentry
+  module Rails
+    module Tracing
+      AVAILABLE_SUBSCRIBERS = [ActionViewSubscriber, ActiveRecordSubscriber, ActionControllerSubscriber]
+
+      def self.subscribe_tracing_events
+        # need to avoid duplicated subscription
+        return if @subscribed
+
+        AVAILABLE_SUBSCRIBERS.each(&:subscribe!)
+
+        @subscribed = true
+      end
+
+      def self.unsubscribe_tracing_events
+        return unless @subscribed
+
+        AVAILABLE_SUBSCRIBERS.each(&:unsubscribe!)
+
+        @subscribed = false
+      end
+
+      # this is necessary because instrumentation events don't record absolute start/finish time
+      # so we need to retrieve the correct time this way
+      def self.patch_active_support_notifications
+        unless ::ActiveSupport::Notifications::Instrumenter.ancestors.include?(SentryNotificationExtension)
+          ::ActiveSupport::Notifications::Instrumenter.send(:prepend, SentryNotificationExtension)
+        end
+
+        SentryNotificationExtension.module_eval do
+          def instrument(name, payload = {}, &block)
+            is_public_event = name[0] != "!"
+
+            payload[:start_timestamp] = Time.now.utc.to_f if is_public_event
+
+            super(name, payload, &block)
+          end
+        end
+      end
+
+      def self.remove_active_support_notifications_patch
+        if ::ActiveSupport::Notifications::Instrumenter.ancestors.include?(SentryNotificationExtension)
+          SentryNotificationExtension.module_eval do
+            def instrument(name, payload = {}, &block)
+              super
+            end
+          end
+        end
+      end
+
+      def self.get_current_transaction
+        Sentry.get_current_scope.get_transaction
+      end
+
+      # it's just a container for the extended method
+      module SentryNotificationExtension
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+module Sentry
+  module Rails
+    module Tracing
+      class AbstractSubscriber
+
+        class << self
+          def subscribe!
+            raise NotImplementedError
+          end
+
+          def unsubscribe!
+            ActiveSupport::Notifications.unsubscribe(self::EVENT_NAME)
+          end
+
+          def subscribe_to_event(event_name)
+            if ::Rails.version.to_i == 5
+              ActiveSupport::Notifications.subscribe(event_name) do |_, start, finish, _, payload|
+                next unless Tracing.get_current_transaction
+
+                duration = finish.to_f - start.to_f
+                yield(event_name, duration, payload)
+              end
+            else
+              ActiveSupport::Notifications.subscribe(event_name) do |event|
+                next unless Tracing.get_current_transaction
+
+                yield(event_name, event.duration, event.payload)
+              end
+            end
+          end
+
+          def record_on_current_span(duration:, **options)
+            return unless options[:start_timestamp]
+
+            scope = Sentry.get_current_scope
+            transaction = scope.get_transaction
+            return unless transaction && transaction.sampled
+
+            span = transaction.start_child(**options)
+            # duration in ActiveSupport is computed in millisecond
+            # so we need to covert it as second before calculating the timestamp
+            span.set_timestamp(span.start_timestamp + duration / 1000)
+            yield(span) if block_given?
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Sentry
+  module Rails
+    module Tracing
+      class ActionControllerSubscriber < AbstractSubscriber
+        EVENT_NAME = "process_action.action_controller".freeze
+
+        def self.subscribe!
+          subscribe_to_event(EVENT_NAME) do |event_name, duration, payload|
+            controller = payload[:controller]
+            action = payload[:action]
+
+            record_on_current_span(
+              op: event_name,
+              start_timestamp: payload[:start_timestamp],
+              description: "#{controller}##{action}",
+              duration: duration
+            ) do |span|
+              span.set_data(:payload, payload)
+              span.set_http_status(payload[:status])
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Sentry
+  module Rails
+    module Tracing
+      class ActionViewSubscriber < AbstractSubscriber
+        EVENT_NAMES = ["render_template.action_view", "render_partial.action_view", "render_collection.action_view"]
+
+        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)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Sentry
+  module Rails
+    module Tracing
+      class ActiveRecordSubscriber < AbstractSubscriber
+        EVENT_NAME = "sql.active_record".freeze
+        EXCLUDED_EVENTS = ["SCHEMA", "TRANSACTION"].freeze
+
+        def self.subscribe!
+          subscribe_to_event(EVENT_NAME) do |event_name, duration, payload|
+            next if EXCLUDED_EVENTS.include? payload[:name]
+
+            record_on_current_span(op: event_name, start_timestamp: payload[:start_timestamp], description: payload[:sql], duration: duration) do |span|
+              span.set_data(:connection_id, payload[:connection_id])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sentry/rails/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 4.1.1
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-13 00:00:00.000000000 Z
+date: 2020-12-21 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'
+        version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.1.0
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -63,13 +63,18 @@ 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/tracing.rb
+- lib/sentry/rails/tracing/abstract_subscriber.rb
+- lib/sentry/rails/tracing/action_controller_subscriber.rb
+- lib/sentry/rails/tracing/action_view_subscriber.rb
+- lib/sentry/rails/tracing/active_record_subscriber.rb
 - lib/sentry/rails/version.rb
 - sentry-rails.gemspec
 homepage: https://github.com/getsentry/sentry-ruby