sentry-rails 5.17.3 → 5.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d004cdd6b80d76424d8684494a6a0565b5f5440ada51a6878280baa0a0c174e7
-  data.tar.gz: 747ed1691526ff296e90d697ab61bf6f6abfe5c63687904f7a1a12afa9a833d6
+  metadata.gz: 0eadc69b5a0f19fb1fbde82ca580c5385990637ab2080a21c81c4a03ffeb81a5
+  data.tar.gz: 44bf3e89893bde541f38ad15974d6e91db4cf153ad9e37f167ee54b7c32bd00e
 SHA512:
-  metadata.gz: dec86deec8fd26222ddc97c7568d471bdea6c75caaae49b4793f37e5235d81537b026e336136ad3b734101b15f16ebeeeb546d99c6255a4a93ed305ef758be74
-  data.tar.gz: b0ff142977ad7ece0e73a40cd3f434a2bb967efb6cc2040e5feb9448cf3963acfa535efb14d095efaf2f235923c3780f2f1a532cb9287344774e33b955618263
+  metadata.gz: b1924626717ccb8103871a7f24bf77c36db5e98c232a3a60cf3b0bab69d6a27f0bce3bf97bd326bdadddd3172354d8616c35c5e0087a08e0a44b6e0c7f7f706f
+  data.tar.gz: 41fc7b2f3573624f821807ff0409b2138a1d249ef8c5fa7e6a271b5225ba20da61c7912933665554c72ffd3ea80356d57534f17ce9ad3f7a7bb1050ceb5a5da4

data/lib/generators/sentry_generator.rb

@@ -0,0 +1,19 @@
+require "rails/generators/base"
+
+class SentryGenerator < ::Rails::Generators::Base
+  class_option :dsn, type: :string, desc: "Sentry DSN"
+
+  def copy_initializer_file
+    dsn = options[:dsn] ? "'#{options[:dsn]}'" : "ENV['SENTRY_DSN']"
+
+    create_file "config/initializers/sentry.rb", <<~RUBY
+      # frozen_string_literal: true
+
+      Sentry.init do |config|
+        config.breadcrumbs_logger = [:active_support_logger]
+        config.dsn = #{dsn}
+        config.enable_tracing = true
+      end
+    RUBY
+  end
+end

data/lib/sentry/rails/action_cable.rb

@@ -3,6 +3,7 @@ module Sentry
     module ActionCableExtensions
       class ErrorHandler
         OP_NAME = "websocket.server".freeze
+        SPAN_ORIGIN = "auto.http.rails.actioncable"
 
         class << self
           def capture(connection, transaction_name:, extra_context: nil, &block)
@@ -33,7 +34,13 @@ module Sentry
           end
 
           def start_transaction(env, scope)
-            options = { name: scope.transaction_name, source: scope.transaction_source, op: OP_NAME }
+            options = {
+              name: scope.transaction_name,
+              source: scope.transaction_source,
+              op: OP_NAME,
+              origin: SPAN_ORIGIN
+            }
+
             transaction = Sentry.continue_trace(env, **options)
             Sentry.start_transaction(transaction: transaction, **options)
           end

data/lib/sentry/rails/active_job.rb

@@ -17,6 +17,7 @@ module Sentry
 
       class SentryReporter
         OP_NAME = "queue.active_job".freeze
+        SPAN_ORIGIN = "auto.queue.active_job".freeze
 
         class << self
           def record(job, &block)
@@ -27,7 +28,12 @@ module Sentry
                   if job.is_a?(::Sentry::SendEventJob)
                     nil
                   else
-                    Sentry.start_transaction(name: scope.transaction_name, source: scope.transaction_source, op: OP_NAME)
+                    Sentry.start_transaction(
+                      name: scope.transaction_name,
+                      source: scope.transaction_source,
+                      op: OP_NAME,
+                      origin: SPAN_ORIGIN
+                    )
                   end
 
                 scope.set_span(transaction) if transaction

data/lib/sentry/rails/capture_exceptions.rb

@@ -2,6 +2,7 @@ module Sentry
   module Rails
     class CaptureExceptions < Sentry::Rack::CaptureExceptions
       RAILS_7_1 = Gem::Version.new(::Rails.version) >= Gem::Version.new("7.1.0.alpha")
+      SPAN_ORIGIN = 'auto.http.rails'.freeze
 
       def initialize(_)
         super
@@ -32,7 +33,12 @@ module Sentry
       end
 
       def start_transaction(env, scope)
-        options = { name: scope.transaction_name, source: scope.transaction_source, op: transaction_op }
+        options = {
+          name: scope.transaction_name,
+          source: scope.transaction_source,
+          op: transaction_op,
+          origin: SPAN_ORIGIN
+        }
 
         if @assets_regexp && scope.transaction_name.match?(@assets_regexp)
           options.merge!(sampled: false)

data/lib/sentry/rails/configuration.rb

@@ -126,6 +126,14 @@ module Sentry
 
       attr_accessor :tracing_subscribers
 
+      # When the ActiveRecordSubscriber is enabled, capture the source location of the query in the span data.
+      # This is enabled by default, but can be disabled by setting this to false.
+      attr_accessor :enable_db_query_source
+
+      # The threshold in milliseconds for the ActiveRecordSubscriber to capture the source location of the query
+      # in the span data. Default is 100ms.
+      attr_accessor :db_query_source_threshold_ms
+
       # sentry-rails by default skips asset request' transactions by checking if the path matches
       #
       # ```rb
@@ -157,6 +165,8 @@ module Sentry
           Sentry::Rails::Tracing::ActiveRecordSubscriber,
           Sentry::Rails::Tracing::ActiveStorageSubscriber
         ])
+        @enable_db_query_source = true
+        @db_query_source_threshold_ms = 100
         @active_support_logger_subscription_items = Sentry::Rails::ACTIVE_SUPPORT_LOGGER_SUBSCRIPTION_ITEMS_DEFAULT.dup
       end
     end

data/lib/sentry/rails/controller_transaction.rb

@@ -1,6 +1,8 @@
 module Sentry
   module Rails
     module ControllerTransaction
+      SPAN_ORIGIN = 'auto.view.rails'.freeze
+
       def self.included(base)
         base.prepend_around_action(:sentry_around_action)
       end
@@ -11,7 +13,7 @@ module Sentry
         if Sentry.initialized?
           transaction_name = "#{self.class}##{action_name}"
           Sentry.get_current_scope.set_transaction_name(transaction_name, source: :view)
-          Sentry.with_child_span(op: "view.process_action.action_controller", description: transaction_name) do |child_span|
+          Sentry.with_child_span(op: "view.process_action.action_controller", description: transaction_name, origin: SPAN_ORIGIN) do |child_span|
             if child_span
               begin
                 result = yield

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

@@ -9,6 +9,7 @@ module Sentry
 
         EVENT_NAMES = ["process_action.action_controller"].freeze
         OP_NAME = "view.process_action.action_controller".freeze
+        SPAN_ORIGIN = "auto.view.rails".freeze
 
         def self.subscribe!
           Sentry.logger.warn <<~MSG
@@ -22,6 +23,7 @@ module Sentry
 
             record_on_current_span(
               op: OP_NAME,
+              origin: SPAN_ORIGIN,
               start_timestamp: payload[START_TIMESTAMP_NAME],
               description: "#{controller}##{action}",
               duration: duration

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

@@ -6,10 +6,17 @@ module Sentry
       class ActionViewSubscriber < AbstractSubscriber
         EVENT_NAMES = ["render_template.action_view"].freeze
         SPAN_PREFIX = "template.".freeze
+        SPAN_ORIGIN = "auto.template.rails".freeze
 
         def self.subscribe!
           subscribe_to_event(EVENT_NAMES) do |event_name, duration, payload|
-            record_on_current_span(op: SPAN_PREFIX + event_name, start_timestamp: payload[START_TIMESTAMP_NAME], description: payload[:identifier], duration: duration)
+            record_on_current_span(
+              op: SPAN_PREFIX + event_name,
+              origin: SPAN_ORIGIN,
+              start_timestamp: payload[START_TIMESTAMP_NAME],
+              description: payload[:identifier],
+              duration: duration
+            )
           end
         end
       end

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

@@ -6,40 +6,98 @@ module Sentry
       class ActiveRecordSubscriber < AbstractSubscriber
         EVENT_NAMES = ["sql.active_record"].freeze
         SPAN_PREFIX = "db.".freeze
+        SPAN_ORIGIN = "auto.db.rails".freeze
         EXCLUDED_EVENTS = ["SCHEMA", "TRANSACTION"].freeze
 
-        def self.subscribe!
-          subscribe_to_event(EVENT_NAMES) do |event_name, duration, payload|
-            next if EXCLUDED_EVENTS.include? payload[:name]
+        SUPPORT_SOURCE_LOCATION = ActiveSupport::BacktraceCleaner.method_defined?(:clean_frame)
 
-            record_on_current_span(op: SPAN_PREFIX + event_name, start_timestamp: payload[START_TIMESTAMP_NAME], description: payload[:sql], duration: duration) do |span|
-              span.set_tag(:cached, true) if payload.fetch(:cached, false) # cached key is only set for hits in the QueryCache, from Rails 5.1
+        if SUPPORT_SOURCE_LOCATION
+          # Need to be specific down to the lib path so queries generated in specs don't get ignored
+          SENTRY_RUBY_PATH = File.join(Gem::Specification.find_by_name("sentry-ruby").full_gem_path, "lib")
+          SENTRY_RAILS_PATH = File.join(Gem::Specification.find_by_name("sentry-rails").full_gem_path, "lib")
 
-              connection = payload[:connection]
+          class_attribute :backtrace_cleaner, default: (ActiveSupport::BacktraceCleaner.new.tap do |cleaner|
+            cleaner.add_silencer { |line| line.include?(SENTRY_RUBY_PATH) || line.include?(SENTRY_RAILS_PATH) }
+          end)
+        end
 
-              if payload[:connection_id]
-                span.set_data(:connection_id, payload[:connection_id])
+        class << self
+          def subscribe!
+            record_query_source = SUPPORT_SOURCE_LOCATION && Sentry.configuration.rails.enable_db_query_source
+            query_source_threshold = Sentry.configuration.rails.db_query_source_threshold_ms
 
-                # we fallback to the base connection on rails < 6.0.0 since the payload doesn't have it
-                connection ||= ActiveRecord::Base.connection_pool.connections.find { |conn| conn.object_id == payload[:connection_id] }
-              end
+            subscribe_to_event(EVENT_NAMES) do |event_name, duration, payload|
+              next if EXCLUDED_EVENTS.include? payload[:name]
+
+              record_on_current_span(
+                op: SPAN_PREFIX + event_name,
+                origin: SPAN_ORIGIN,
+                start_timestamp: payload[START_TIMESTAMP_NAME],
+                description: payload[:sql],
+                duration: duration
+              ) do |span|
+                span.set_tag(:cached, true) if payload.fetch(:cached, false) # cached key is only set for hits in the QueryCache, from Rails 5.1
 
-              next unless connection
+                connection = payload[:connection]
 
-              db_config =
-                if connection.pool.respond_to?(:db_config)
-                  connection.pool.db_config.configuration_hash
-                elsif connection.pool.respond_to?(:spec)
-                  connection.pool.spec.config
+                if payload[:connection_id]
+                  span.set_data(:connection_id, payload[:connection_id])
+
+                  # we fallback to the base connection on rails < 6.0.0 since the payload doesn't have it
+                  connection ||= ActiveRecord::Base.connection_pool.connections.find { |conn| conn.object_id == payload[:connection_id] }
                 end
 
-              next unless db_config
+                next unless connection
+
+                db_config =
+                  if connection.pool.respond_to?(:db_config)
+                    connection.pool.db_config.configuration_hash
+                  elsif connection.pool.respond_to?(:spec)
+                    connection.pool.spec.config
+                  end
+
+                next unless db_config
+
+                span.set_data(Span::DataConventions::DB_SYSTEM, db_config[:adapter]) if db_config[:adapter]
+                span.set_data(Span::DataConventions::DB_NAME, db_config[:database]) if db_config[:database]
+                span.set_data(Span::DataConventions::SERVER_ADDRESS, db_config[:host]) if db_config[:host]
+                span.set_data(Span::DataConventions::SERVER_PORT, db_config[:port]) if db_config[:port]
+                span.set_data(Span::DataConventions::SERVER_SOCKET_ADDRESS, db_config[:socket]) if db_config[:socket]
+
+                next unless record_query_source
+
+                # both duration and query_source_threshold are in ms
+                next unless duration >= query_source_threshold
 
-              span.set_data(Span::DataConventions::DB_SYSTEM, db_config[:adapter]) if db_config[:adapter]
-              span.set_data(Span::DataConventions::DB_NAME, db_config[:database]) if db_config[:database]
-              span.set_data(Span::DataConventions::SERVER_ADDRESS, db_config[:host]) if db_config[:host]
-              span.set_data(Span::DataConventions::SERVER_PORT, db_config[:port]) if db_config[:port]
-              span.set_data(Span::DataConventions::SERVER_SOCKET_ADDRESS, db_config[:socket]) if db_config[:socket]
+                source_location = query_source_location
+
+                if source_location
+                  backtrace_line = Sentry::Backtrace::Line.parse(source_location)
+                  span.set_data(Span::DataConventions::FILEPATH, backtrace_line.file) if backtrace_line.file
+                  span.set_data(Span::DataConventions::LINENO, backtrace_line.number) if backtrace_line.number
+                  span.set_data(Span::DataConventions::FUNCTION, backtrace_line.method) if backtrace_line.method
+                  # Only JRuby has namespace in the backtrace
+                  span.set_data(Span::DataConventions::NAMESPACE, backtrace_line.module_name) if backtrace_line.module_name
+                end
+              end
+            end
+          end
+
+          # Thread.each_caller_location is an API added in Ruby 3.2 that doesn't always collect the entire stack like
+          # Kernel#caller or #caller_locations do. See https://github.com/rails/rails/pull/49095 for more context.
+          if SUPPORT_SOURCE_LOCATION && Thread.respond_to?(:each_caller_location)
+            def query_source_location
+              Thread.each_caller_location do |location|
+                frame = backtrace_cleaner.clean_frame(location)
+                return frame if frame
+              end
+              nil
+            end
+          else
+            # Since Sentry is mostly used in production, we don't want to fallback to the slower implementation
+            # and adds potentially big overhead to the application.
+            def query_source_location
+              nil
             end
           end
         end

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

@@ -19,9 +19,17 @@ module Sentry
           analyze.active_storage
         ].freeze
 
+        SPAN_ORIGIN = "auto.file.rails".freeze
+
         def self.subscribe!
           subscribe_to_event(EVENT_NAMES) do |event_name, duration, payload|
-            record_on_current_span(op: "file.#{event_name}".freeze, start_timestamp: payload[START_TIMESTAMP_NAME], description: payload[:service], duration: duration) do |span|
+            record_on_current_span(
+              op: "file.#{event_name}".freeze,
+              origin: SPAN_ORIGIN,
+              start_timestamp: payload[START_TIMESTAMP_NAME],
+              description: payload[:service],
+              duration: duration
+            ) do |span|
               payload.each do |key, value|
                 span.set_data(key, value) unless key == START_TIMESTAMP_NAME
               end

data/lib/sentry/rails/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Rails
-    VERSION = "5.17.3"
+    VERSION = "5.18.0"
   end
 end

data/sentry-rails.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "railties", ">= 5.0"
-  spec.add_dependency "sentry-ruby", "~> 5.17.3"
+  spec.add_dependency "sentry-ruby", "~> 5.18.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 5.17.3
+  version: 5.18.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-11 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.17.3
+        version: 5.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.17.3
+        version: 5.18.0
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -57,6 +57,7 @@ files:
 - app/jobs/sentry/send_event_job.rb
 - bin/console
 - bin/setup
+- lib/generators/sentry_generator.rb
 - lib/sentry-rails.rb
 - lib/sentry/rails.rb
 - lib/sentry/rails/action_cable.rb