sentry-rails 0.1.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12812aa43ec08e1599d09ce9e0602cd141519dc50fccf6b6e91a6b01123898c6
-  data.tar.gz: e227fc53d69083c4844f7db7a8f2321d6d13c94fe7ae56f15c568e13de20aa90
+  metadata.gz: 9e5e6de4bbd5e0e1530fcd38e5978b153c846bac123e92db1941fd8c58318eef
+  data.tar.gz: 3b0ea04fd34eab29d19052fde261954890e3ce59e8f090592e23653e1aab7a4f
 SHA512:
-  metadata.gz: e89fa75dff95ea2f9308e3250594104b3831b7578bddb80da23cde9ad15dacc0f4a1564777e2ab34acf358f16f7ee70c0900f33fac348346429f58ab732296f2
-  data.tar.gz: 1715da8885b92a56df96c48e80956d5a17d3759509a562967325f3a1be7beb7e5df893a8e0b81670c9591518f04e29e5e893c515213af446e9fa2084769ab177
+  metadata.gz: 785b7d05b9ff2a18e5e3939aeac265ae02426a617f9fda15865fc69d1d196706fcc658a4a54731dd3eb918f714e6825651002528c2f20ad0b426e5fa0b248d24
+  data.tar.gz: f9065c5331efae105803df2fcaed4e7c7cf18286d2b07ae046e1e48004cde67c0c3e171a5ca82cfae2cada9f23bb4a9ee12442fc3391415e2634389799ead5af

data/.craft.yml

@@ -12,7 +12,7 @@ artifactProvider:
 targets:
     - name: gem
     - name: github
-      tagPrefix: sentry-rails
+      tagPrefix: sentry-rails-v
     - name: registry
       type: sdk
       config:

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 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
+
 ## 0.1.1
 
 Release test

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

@@ -1,44 +1,85 @@
-# Sentry::Ruby
+<p align="center">
+  <a href="https://sentry.io" target="_blank" align="center">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+  </a>
+  <br>
+</p>
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sentry/ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+# sentry-rails, the Rails integration for Sentry's Ruby client
 
-TODO: Delete this and the text above, and describe your gem
+---
 
-## Installation
 
-Add this line to your application's Gemfile:
+[![Gem Version](https://img.shields.io/gem/v/sentry-rails.svg)](https://rubygems.org/gems/sentry-rails)
+![Build Status](https://github.com/getsentry/sentry-ruby/workflows/sentry-rails%20Test/badge.svg)
+[![Coverage Status](https://img.shields.io/codecov/c/github/getsentry/sentry-ruby/master?logo=codecov)](https://codecov.io/gh/getsentry/sentry-ruby/branch/master)
+[![Gem](https://img.shields.io/gem/dt/sentry-rails.svg)](https://rubygems.org/gems/sentry-rails/)
+[![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)
 
-```ruby
-gem 'sentry-ruby'
-```
 
-And then execute:
+[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.
+
+
+## Requirements
+
+This integration requires Rails version >= 5.0 and Ruby version >= 2.4
 
-    $ bundle install
+## Getting Started
 
-Or install it yourself as:
+### Install
 
-    $ gem install sentry-ruby
+```ruby
+gem "sentry-rails"
+```
 
-## Usage
+### Integration Specific Configuration
 
-TODO: Write usage instructions here
+This gem has a few Rails-specific configuration options
 
-## Development
+```ruby
+Sentry.init do |config|
+  # report exceptions rescued by ActionDispatch::ShowExceptions or ActionDispatch::DebugExceptions middlewares
+  # the default value is true
+  config.rails.report_rescued_exceptions = true
+
+  # this gem also provides a new breadcrumb logger that accepts instrumentaions from ActiveSupport
+  # it's not activated by default, but you can enable it with
+  config.breadcrumbs_logger = [:active_support_logger]
+end
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Performance Monitoring
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+You can activate performance monitoring by enabling traces sampling:
 
-## Contributing
+```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
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sentry-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/sentry-ruby/blob/master/CODE_OF_CONDUCT.md).
+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`
 
-## License
+To lean more about performance monitoring, please visit the [official documentation](https://docs.sentry.io/platforms/ruby/guides/rails/performance/).
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
 
-Everyone interacting in the Sentry::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sentry-ruby/blob/master/CODE_OF_CONDUCT.md).

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

@@ -0,0 +1,2 @@
+require "sentry/rails/version"
+require "sentry/rails"

data/lib/sentry/rails.rb

@@ -1,6 +1,7 @@
-require "sentry"
+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.1"
+    VERSION = "4.1.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", ">= 4.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-06 00:00:00.000000000 Z
+date: 2020-12-18 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: 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: []
@@ -58,17 +58,23 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/sentry-rails.rb
 - lib/sentry/rails.rb
 - 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