sentry-rails 5.10.0 → 5.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7eadae379dbfc72a3685f48b7379a52c1fea827eb4c57d1eba6565f87cad406f
-  data.tar.gz: 81a628792cffda07caed69c4fc5191c77f27da32cfe70226bfac3aeda3951c33
+  metadata.gz: 8a6aa240a1333c8d01ce8db9c622057faec2e4879b39b9a209a9156e4e5eb37a
+  data.tar.gz: bb73a1d4d80a2438a497907e7c7fb32bc321f35b232be1324767febb1c4885f9
 SHA512:
-  metadata.gz: 0b8575d57dd6be491b3221c40a62864ac183a26274717f122a67d61300f093ff215e38ad182a301db9cc0f57e1d3a257e564bb845aca86429b96574baf901c2a
-  data.tar.gz: 68e82698caa67fb3d5d7643e86379015dde236ffd38de7a560af0e207d48928643becc8918b7f4aa48cf533c849b4b6f3496f3cc9513f61408545e80e8811212
+  metadata.gz: e64aeb3142b11c51aabe1f7fa75f0a89e8b3e908e38b34be43704dba2f3288eb132fd0860f944e218a393b9cc6b1cb10c0ec63af4d1224f5030075ba9b749855
+  data.tar.gz: dfb5c2f71936de177e980b1bb6adb53de739a8cc19f1ae0d6c2dcba2463c703d6c86ecdeb89781c9df448c86a47b25e74c38e01cc91fc0e4cedbeba57fa95ebd

data/.gitignore

@@ -5,7 +5,7 @@
 /doc/
 /pkg/
 /spec/reports/
-/spec/dummy/test_rails_app/db
+/spec/dummy/test_rails_app/db*
 /tmp/
 
 # rspec failure tracking

data/Gemfile

@@ -11,7 +11,7 @@ platform :jruby do
 end
 
 rails_version = ENV["RAILS_VERSION"]
-rails_version = "7.0.0" if rails_version.nil?
+rails_version = "7.1.0" if rails_version.nil?
 rails_version = Gem::Version.new(rails_version)
 
 if rails_version < Gem::Version.new("6.0.0")
@@ -20,10 +20,13 @@ else
   gem "sqlite3", platform: :ruby
 end
 
-if rails_version > Gem::Version.new("7.0.0")
+if rails_version >= Gem::Version.new("7.2.0.alpha")
   gem "rails", github: "rails/rails"
+elsif rails_version >= Gem::Version.new("7.1.0")
+  gem "rails", "~> #{rails_version}"
 else
   gem "rails", "~> #{rails_version}"
+  gem "psych", "~> 3.0.0"
 end
 
 gem "mini_magick"
@@ -39,17 +42,25 @@ gem 'simplecov'
 gem "simplecov-cobertura", "~> 1.4"
 gem "rexml"
 
-# https://github.com/flavorjones/loofah/pull/267
-# loofah changed the required ruby version in a patch so we need to explicitly pin it
-gem "loofah", "2.20.0" if RUBY_VERSION.to_f < 2.5
+ruby_version = Gem::Version.new(RUBY_VERSION)
 
-gem "rake", "~> 12.0"
+if ruby_version < Gem::Version.new("2.5.0")
+  # https://github.com/flavorjones/loofah/pull/267
+  # loofah changed the required ruby version in a patch so we need to explicitly pin it
+  gem "loofah", "2.20.0"
+end
 
-if RUBY_VERSION.to_f >= 2.6
+if ruby_version >= Gem::Version.new("2.6.0")
   gem "debug", github: "ruby/debug", platform: :ruby
   gem "irb"
+
+  if ruby_version >= Gem::Version.new("3.0.0")
+    gem "ruby-lsp-rspec"
+  end
 end
 
+gem "rake", "~> 12.0"
+
 gem "pry"
 
 gem "benchmark-ips"

data/README.md

@@ -11,7 +11,7 @@
 
 
 [![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)
+![Build Status](https://github.com/getsentry/sentry-ruby/actions/workflows/sentry_rails_test.yml/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)

data/lib/sentry/rails/action_cable.rb

@@ -33,11 +33,8 @@ module Sentry
           end
 
           def start_transaction(env, scope)
-            sentry_trace = env["HTTP_SENTRY_TRACE"]
-            baggage = env["HTTP_BAGGAGE"]
-
             options = { name: scope.transaction_name, source: scope.transaction_source, op: OP_NAME }
-            transaction = Sentry::Transaction.from_sentry_trace(sentry_trace, baggage: baggage, **options) if sentry_trace
+            transaction = Sentry.continue_trace(env, **options)
             Sentry.start_transaction(transaction: transaction, **options)
           end
 

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

@@ -2,75 +2,13 @@ module Sentry
   module Rails
     module Breadcrumb
       module ActiveSupportLogger
-        ALLOWED_LIST = {
-          # action_controller
-          "write_fragment.action_controller" => %i[key],
-          "read_fragment.action_controller" => %i[key],
-          "exist_fragment?.action_controller" => %i[key],
-          "expire_fragment.action_controller" => %i[key],
-          "start_processing.action_controller" => %i[controller action params format method path],
-          "process_action.action_controller" => %i[controller action params format method path status view_runtime db_runtime],
-          "send_file.action_controller" => %i[path],
-          "redirect_to.action_controller" => %i[status location],
-          "halted_callback.action_controller" => %i[filter],
-          # action_dispatch
-          "process_middleware.action_dispatch" => %i[middleware],
-          # action_view
-          "render_template.action_view" => %i[identifier layout],
-          "render_partial.action_view" => %i[identifier],
-          "render_collection.action_view" => %i[identifier count cache_hits],
-          "render_layout.action_view" => %i[identifier],
-          # active_record
-          "sql.active_record" => %i[sql name statement_name cached],
-          "instantiation.active_record" => %i[record_count class_name],
-          # action_mailer
-          # not including to, from, or subject..etc. because of PII concern
-          "deliver.action_mailer" => %i[mailer date perform_deliveries],
-          "process.action_mailer" => %i[mailer action params],
-          # active_support
-          "cache_read.active_support" => %i[key store hit],
-          "cache_generate.active_support" => %i[key store],
-          "cache_fetch_hit.active_support" => %i[key store],
-          "cache_write.active_support" => %i[key store],
-          "cache_delete.active_support" => %i[key store],
-          "cache_exist?.active_support" => %i[key store],
-          # active_job
-          "enqueue_at.active_job" => %i[],
-          "enqueue.active_job" => %i[],
-          "enqueue_retry.active_job" => %i[],
-          "perform_start.active_job" => %i[],
-          "perform.active_job" => %i[],
-          "retry_stopped.active_job" => %i[],
-          "discard.active_job" => %i[],
-          # action_cable
-          "perform_action.action_cable" => %i[channel_class action],
-          "transmit.action_cable" => %i[channel_class],
-          "transmit_subscription_confirmation.action_cable" => %i[channel_class],
-          "transmit_subscription_rejection.action_cable" => %i[channel_class],
-          "broadcast.action_cable" => %i[broadcasting],
-          # active_storage
-          "service_upload.active_storage" => %i[service key checksum],
-          "service_streaming_download.active_storage" => %i[service key],
-          "service_download_chunk.active_storage" => %i[service key],
-          "service_download.active_storage" => %i[service key],
-          "service_delete.active_storage" => %i[service key],
-          "service_delete_prefixed.active_storage" => %i[service prefix],
-          "service_exist.active_storage" => %i[service key exist],
-          "service_url.active_storage" => %i[service key url],
-          "service_update_metadata.active_storage" => %i[service key],
-          "preview.active_storage" => %i[key],
-          "analyze.active_storage" => %i[analyzer],
-        }.freeze
-
         class << self
           def add(name, started, _finished, _unique_id, data)
             # skip Rails' internal events
             return if name.start_with?("!")
 
-            allowed_keys = ALLOWED_LIST[name]
-
             if data.is_a?(Hash)
-              data = data.slice(*allowed_keys)
+              data = data.slice(*@allowed_keys[name])
             end
 
             crumb = Sentry::Breadcrumb.new(
@@ -81,7 +19,9 @@ module Sentry
             Sentry.add_breadcrumb(crumb)
           end
 
-          def inject
+          def inject(allowed_keys)
+            @allowed_keys = allowed_keys
+
             @subscriber = ::ActiveSupport::Notifications.subscribe(/.*/) do |name, started, finished, unique_id, data|
               # we only record events that has a started timestamp
               if started.is_a?(Time)

data/lib/sentry/rails/capture_exceptions.rb

@@ -32,16 +32,13 @@ module Sentry
       end
 
       def start_transaction(env, scope)
-        sentry_trace = env["HTTP_SENTRY_TRACE"]
-        baggage = env["HTTP_BAGGAGE"]
-
         options = { name: scope.transaction_name, source: scope.transaction_source, op: transaction_op }
 
         if @assets_regexp && scope.transaction_name.match?(@assets_regexp)
           options.merge!(sampled: false)
         end
 
-        transaction = Sentry::Transaction.from_sentry_trace(sentry_trace, baggage: baggage, **options) if sentry_trace
+        transaction = Sentry.continue_trace(env, **options)
         Sentry.start_transaction(transaction: transaction, custom_sampling_context: { env: env }, **options)
       end
 

data/lib/sentry/rails/configuration.rb

@@ -12,7 +12,12 @@ module Sentry
       @excluded_exceptions = @excluded_exceptions.concat(Sentry::Rails::IGNORE_DEFAULT)
 
       if ::Rails.logger
-        @logger = ::Rails.logger
+        if defined?(::ActiveSupport::BroadcastLogger) && ::Rails.logger.is_a?(::ActiveSupport::BroadcastLogger)
+          dupped_broadcasts = ::Rails.logger.broadcasts.map(&:dup)
+          @logger = ::ActiveSupport::BroadcastLogger.new(*dupped_broadcasts)
+        else
+          @logger = ::Rails.logger.dup
+        end
       else
         @logger.warn(Sentry::LOGGER_PROGNAME) do
           <<~MSG
@@ -41,6 +46,67 @@ module Sentry
       'ActionDispatch::Http::Parameters::ParseError',
       'ActiveRecord::RecordNotFound'
     ].freeze
+
+    ACTIVE_SUPPORT_LOGGER_SUBSCRIPTION_ITEMS_DEFAULT = {
+      # action_controller
+      "write_fragment.action_controller" => %i[key],
+      "read_fragment.action_controller" => %i[key],
+      "exist_fragment?.action_controller" => %i[key],
+      "expire_fragment.action_controller" => %i[key],
+      "start_processing.action_controller" => %i[controller action params format method path],
+      "process_action.action_controller" => %i[controller action params format method path status view_runtime db_runtime],
+      "send_file.action_controller" => %i[path],
+      "redirect_to.action_controller" => %i[status location],
+      "halted_callback.action_controller" => %i[filter],
+      # action_dispatch
+      "process_middleware.action_dispatch" => %i[middleware],
+      # action_view
+      "render_template.action_view" => %i[identifier layout],
+      "render_partial.action_view" => %i[identifier],
+      "render_collection.action_view" => %i[identifier count cache_hits],
+      "render_layout.action_view" => %i[identifier],
+      # active_record
+      "sql.active_record" => %i[sql name statement_name cached],
+      "instantiation.active_record" => %i[record_count class_name],
+      # action_mailer
+      # not including to, from, or subject..etc. because of PII concern
+      "deliver.action_mailer" => %i[mailer date perform_deliveries],
+      "process.action_mailer" => %i[mailer action params],
+      # active_support
+      "cache_read.active_support" => %i[key store hit],
+      "cache_generate.active_support" => %i[key store],
+      "cache_fetch_hit.active_support" => %i[key store],
+      "cache_write.active_support" => %i[key store],
+      "cache_delete.active_support" => %i[key store],
+      "cache_exist?.active_support" => %i[key store],
+      # active_job
+      "enqueue_at.active_job" => %i[],
+      "enqueue.active_job" => %i[],
+      "enqueue_retry.active_job" => %i[],
+      "perform_start.active_job" => %i[],
+      "perform.active_job" => %i[],
+      "retry_stopped.active_job" => %i[],
+      "discard.active_job" => %i[],
+      # action_cable
+      "perform_action.action_cable" => %i[channel_class action],
+      "transmit.action_cable" => %i[channel_class],
+      "transmit_subscription_confirmation.action_cable" => %i[channel_class],
+      "transmit_subscription_rejection.action_cable" => %i[channel_class],
+      "broadcast.action_cable" => %i[broadcasting],
+      # active_storage
+      "service_upload.active_storage" => %i[service key checksum],
+      "service_streaming_download.active_storage" => %i[service key],
+      "service_download_chunk.active_storage" => %i[service key],
+      "service_download.active_storage" => %i[service key],
+      "service_delete.active_storage" => %i[service key],
+      "service_delete_prefixed.active_storage" => %i[service prefix],
+      "service_exist.active_storage" => %i[service key exist],
+      "service_url.active_storage" => %i[service key url],
+      "service_update_metadata.active_storage" => %i[service key],
+      "preview.active_storage" => %i[key],
+      "analyze.active_storage" => %i[analyzer],
+    }.freeze
+
     class Configuration
       # Rails 7.0 introduced a new error reporter feature, which the SDK once opted-in by default.
       # But after receiving multiple issue reports, the integration seemed to cause serious troubles to some users.
@@ -75,6 +141,10 @@ module Sentry
       # ```
       attr_accessor :assets_regexp
 
+      # Hash of subscription items that will be shown in breadcrumbs active support logger.
+      # @return [Hash<String, Array<Symbol>>]
+      attr_accessor :active_support_logger_subscription_items
+
       def initialize
         @register_error_subscriber = false
         @report_rescued_exceptions = true
@@ -87,6 +157,7 @@ module Sentry
           Sentry::Rails::Tracing::ActiveRecordSubscriber,
           Sentry::Rails::Tracing::ActiveStorageSubscriber
         ])
+        @active_support_logger_subscription_items = Sentry::Rails::ACTIVE_SUPPORT_LOGGER_SUBSCRIPTION_ITEMS_DEFAULT.dup
       end
     end
   end

data/lib/sentry/rails/railtie.rb

@@ -89,7 +89,7 @@ module Sentry
     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
+        Sentry::Rails::Breadcrumb::ActiveSupportLogger.inject(Sentry.configuration.rails.active_support_logger_subscription_items)
       end
 
       if Sentry.configuration.breadcrumbs_logger.include?(:monotonic_active_support_logger)

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

@@ -13,8 +13,33 @@ module Sentry
             next if EXCLUDED_EVENTS.include? payload[:name]
 
             record_on_current_span(op: SPAN_PREFIX + event_name, start_timestamp: payload[START_TIMESTAMP_NAME], description: payload[:sql], duration: duration) do |span|
-              span.set_data(:connection_id, payload[:connection_id])
               span.set_tag(:cached, true) if payload.fetch(:cached, false) # cached key is only set for hits in the QueryCache, from Rails 5.1
+
+              connection = payload[:connection]
+
+              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
+                base_connection = ActiveRecord::Base.connection
+                connection ||= base_connection if payload[:connection_id] == base_connection.object_id
+              end
+
+              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]
             end
           end
         end

data/lib/sentry/rails/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 5.10.0
+  version: 5.14.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-04 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.10.0
+        version: 5.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.10.0
+        version: 5.14.0
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []