sentry-rails 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a0780603b519760f8819b1e9245514d479f5c55595d7a5d91a09ea1d72d1ea9
-  data.tar.gz: d2137a13dd2f272298027818a2fd076c2b4a7b70bad18bd028b39a1fe95f9109
+  metadata.gz: 9e7eaef0b61e66058c293dd473a41a8a45af0c1547325099540d81f7802be480
+  data.tar.gz: c67ee2d0741a7822c43b3d29ad3d44a8590a032abe0727487dd88e09934f9449
 SHA512:
-  metadata.gz: 0c0a349aded55ded8dc9c1d758cb1d23ee30ee08fbe063f58b842d31436a1e282d66dfea089441f71c6519ed4df340ea4bb6a3293832bc9301edfc5c3509243a
-  data.tar.gz: ba5ed5414046187fcb7d1481e0808ff98bc35b91f61cd7481a5cba104e177fc36a3961fc6c23e871e9e7a2cc2cb8d6f8650b5ff21bc5cbc9c866a03d7fe654c4
+  metadata.gz: 82bbf7256864d79f10863c730508e7d0f24c0923ec0fbf77446584db1ecae1b04dcfb9e1de45367e3c0528848bd8e41d3db6d45e7d6be6eada7e2abd4e47c808
+  data.tar.gz: 661da577ee137848c260fcd019413b0efd7b0cc7756f90b33ba4f049446f3b1439439929e50b8ffddbfa08c1d6e907aa7f7e04761630b5cfaf81f29fe2ec1589

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.2.0
+
+- Multiple fixes and refactorings
+- Tracing support
+
 ## 0.1.2
 
 Fix require reference

data/Gemfile

@@ -6,6 +6,10 @@ gemspec
 rails_version = ENV["RAILS_VERSION"]
 rails_version = "6.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"
 gem "codecov"
@@ -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/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/railtie.rb

@@ -10,6 +10,7 @@ module Sentry
   class Railtie < ::Rails::Railtie
     initializer "sentry.use_rack_middleware" do |app|
       app.config.middleware.insert 0, Sentry::Rails::CaptureException
+      app.config.middleware.insert 0, Sentry::Rack::Tracing
     end
 
     initializer 'sentry.action_controller' do
@@ -50,6 +51,11 @@ module Sentry
 
         exceptions_class.send(:prepend, Sentry::Rails::Overrides::DebugExceptionsCatcher)
       end
+
+      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

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 = "0.2.0"
   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", ">= 0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-13 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -70,6 +70,11 @@ files:
 - 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