sentry-rails 6.7.0 → 7.0.0

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

@@ -1,16 +1,22 @@
 # frozen_string_literal: true
 
+require "sentry/utils/http_tracing"
+
 module Sentry
   module Rails
     module Breadcrumb
       module ActiveSupportLogger
         class << self
+          include Sentry::Utils::HttpTracing
           def add(name, started, _finished, _unique_id, data)
+            return unless Sentry.initialized?
+
             # skip Rails' internal events
             return if name.start_with?("!")
 
             if data.is_a?(Hash)
               data = data.slice(*@allowed_keys[name])
+              filter_data_collection!(data)
             end
 
             crumb = Sentry::Breadcrumb.new(
@@ -35,6 +41,30 @@ module Sentry
           def detach
             ::ActiveSupport::Notifications.unsubscribe(@subscriber)
           end
+
+          private
+
+          def filter_data_collection!(data)
+            filter_params!(data)
+            filter_path!(data)
+          end
+
+          def filter_params!(data)
+            return unless data.key?(:params) && data[:params].is_a?(Hash)
+
+            data[:params] = Sentry.configuration.data_collection.url_query_params.filter(data[:params])
+            data.delete(:params) if data[:params].empty?
+          end
+
+          def filter_path!(data)
+            return unless data.key?(:path) && data[:path].is_a?(String)
+
+            path, query = data[:path].split("?", 2)
+            return unless query
+
+            filtered_query = filter_query_params(query)
+            data[:path] = filtered_query ? "#{path}?#{filtered_query}" : path
+          end
         end
       end
     end

data/lib/sentry/rails/capture_exceptions.rb

@@ -34,7 +34,10 @@ module Sentry
         return unless Sentry.initialized?
         return if show_exceptions?(exception, env) && !Sentry.configuration.rails.report_rescued_exceptions
 
-        Sentry::Rails.capture_exception(exception, contexts: execution_context).tap do |event|
+        options = {}
+        options[:contexts] = execution_context if Sentry.configuration.data_collection.user_info
+
+        Sentry::Rails.capture_exception(exception, **options).tap do |event|
           env[ERROR_EVENT_ID_KEY] = event.event_id if event
         end
       end

data/lib/sentry/rails/configuration.rb

@@ -35,7 +35,13 @@ module Sentry
     end
 
     after(:configured) do
-      rails.structured_logging.enabled = enable_logs if rails.structured_logging.enabled.nil?
+      collection = data_collection.url_query_params
+      if collection.mode == :deny_list
+        filter_parameters = ::Rails.application.config.filter_parameters.select do |filter|
+          filter.is_a?(String) || filter.is_a?(Symbol) || filter.is_a?(Regexp)
+        end
+        collection.terms = (Array(collection.terms) + filter_parameters).uniq
+      end
     end
   end
 
@@ -218,7 +224,7 @@ module Sentry
       }.freeze
 
       def initialize
-        @enabled = nil
+        @enabled = true
         @subscribers = DEFAULT_SUBSCRIBERS.dup
       end
 

data/lib/sentry/rails/controller_transaction.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "sentry/utils/http_tracing"
+
 module Sentry
   module Rails
     module ControllerTransaction
@@ -24,9 +26,28 @@ module Sentry
                 child_span.set_data(:format, request.format)
                 child_span.set_data(:method, request.method)
 
-                pii = Sentry.configuration.send_default_pii
-                child_span.set_data(:path, pii ? request.fullpath : request.filtered_path)
-                child_span.set_data(:params, pii ? request.params : request.filtered_parameters)
+                data_collection = Sentry.configuration.data_collection
+
+                path = request.path
+                query_parameters = request.query_parameters
+
+                if query_parameters.is_a?(Hash)
+                  filtered_query_parameters = data_collection.url_query_params.filter(query_parameters)
+
+                  unless filtered_query_parameters.empty?
+                    formatted_query = Sentry::Utils::HttpTracing.format_query(filtered_query_parameters)
+                    path = "#{path}?#{formatted_query}"
+                  end
+                end
+
+                child_span.set_data(:path, path)
+
+                # all params request + body
+                params = request.params
+                if params.is_a?(Hash)
+                  filtered_params = data_collection.url_query_params.filter(params)
+                  child_span.set_data(:params, filtered_params)
+                end
               end
 
               result

data/lib/sentry/rails/error_reporter_context.rb

@@ -9,8 +9,6 @@ module Sentry
 
       if SUPPORTS_EXECUTION_CONTEXT
         def execution_context
-          return {} unless Sentry.configuration.send_default_pii
-
           context = ::ActiveSupport::ExecutionContext.to_h
           return {} if context.empty?
 

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

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "sentry/rails/log_subscriber"
-require "sentry/rails/log_subscribers/parameter_filter"
 
 module Sentry
   module Rails
@@ -16,13 +15,10 @@ module Sentry
       # @example Usage
       #   # Enable structured logging for ActionController
       #   Sentry.init do |config|
-      #     config.enable_logs = true
       #     config.rails.structured_logging = true
       #     config.rails.structured_logging.subscribers = { action_controller: Sentry::Rails::LogSubscribers::ActionControllerSubscriber }
       #   end
       class ActionControllerSubscriber < Sentry::Rails::LogSubscriber
-        include ParameterFilter
-
         # Handle process_action.action_controller events
         #
         # @param event [ActiveSupport::Notifications::Event] The controller action event
@@ -55,9 +51,9 @@ module Sentry
             attributes[:db_runtime_ms] = payload[:db_runtime].round(2)
           end
 
-          if Sentry.configuration.send_default_pii && payload[:params]
-            filtered_params = filter_sensitive_params(payload[:params])
-            attributes[:params] = filtered_params unless filtered_params.empty?
+          if payload[:params].is_a?(Hash)
+            params = Sentry.configuration.data_collection.url_query_params.filter(payload[:params])
+            attributes[:params] = params unless params.empty?
           end
 
           level = level_for_request(payload)

data/lib/sentry/rails/log_subscribers/action_mailer_subscriber.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "sentry/rails/log_subscriber"
-require "sentry/rails/log_subscribers/parameter_filter"
 
 module Sentry
   module Rails
@@ -15,13 +14,10 @@ module Sentry
       # @example Usage
       #   # Enable structured logging for ActionMailer
       #   Sentry.init do |config|
-      #     config.enable_logs = true
       #     config.rails.structured_logging = true
       #     config.rails.structured_logging.subscribers = { action_mailer: Sentry::Rails::LogSubscribers::ActionMailerSubscriber }
       #   end
       class ActionMailerSubscriber < Sentry::Rails::LogSubscriber
-        include ParameterFilter
-
         # Handle deliver.action_mailer events
         #
         # @param event [ActiveSupport::Notifications::Event] The email delivery event
@@ -41,8 +37,8 @@ module Sentry
           attributes[:delivery_method] = payload[:delivery_method] if payload[:delivery_method]
           attributes[:date] = payload[:date].to_s if payload[:date]
 
-          if Sentry.configuration.send_default_pii
-            attributes[:message_id] = payload[:message_id] if payload[:message_id]
+          if Sentry.configuration.data_collection.user_info && payload[:message_id]
+            attributes[:message_id] = payload[:message_id]
           end
 
           message = "Email delivered via #{mailer}"
@@ -73,9 +69,9 @@ module Sentry
             duration_ms: duration
           }
 
-          if Sentry.configuration.send_default_pii && payload[:params]
-            filtered_params = filter_sensitive_params(payload[:params])
-            attributes[:params] = filtered_params unless filtered_params.empty?
+          if payload[:params].is_a?(Hash)
+            params = Sentry.configuration.data_collection.url_query_params.filter(payload[:params])
+            attributes[:params] = params unless params.empty?
           end
 
           message = "#{mailer}##{action}"

data/lib/sentry/rails/log_subscribers/active_job_subscriber.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "sentry/rails/log_subscriber"
-require "sentry/rails/log_subscribers/parameter_filter"
 
 module Sentry
   module Rails
@@ -15,13 +14,10 @@ module Sentry
       # @example Usage
       #   # Enable structured logging for ActiveJob
       #   Sentry.init do |config|
-      #     config.enable_logs = true
       #     config.rails.structured_logging = true
       #     config.rails.structured_logging.subscribers = { active_job: Sentry::Rails::LogSubscribers::ActiveJobSubscriber }
       #   end
       class ActiveJobSubscriber < Sentry::Rails::LogSubscriber
-        include ParameterFilter
-
         # Handle perform.active_job events
         #
         # @param event [ActiveSupport::Notifications::Event] The job performance event
@@ -47,7 +43,7 @@ module Sentry
             attributes[:delay_ms] = ((Time.current - job.scheduled_at) * 1000).round(2)
           end
 
-          if Sentry.configuration.send_default_pii && job.arguments.present?
+          if Sentry.configuration.data_collection.queues && job.arguments.present?
             filtered_args = filter_sensitive_arguments(job.arguments)
             attributes[:arguments] = filtered_args unless filtered_args.empty?
           end
@@ -149,9 +145,11 @@ module Sentry
           arguments.map do |arg|
             case arg
             when Hash
-              filter_sensitive_params(arg)
+              # we're using url_query_params here since rails filter_parameters end up there
+              # and we don't have a dedicated queue params config yet
+              Sentry.configuration.data_collection.url_query_params.filter(arg, cookie: false)
             when String
-              arg.length > 100 ? "[FILTERED: #{arg.length} chars]" : arg
+              arg.length > 100 ? "[Filtered: #{arg.length} chars]" : arg
             else
               arg
             end

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

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "sentry/rails/log_subscriber"
-require "sentry/rails/log_subscribers/parameter_filter"
 
 module Sentry
   module Rails
@@ -16,13 +15,10 @@ module Sentry
       # @example Usage
       #   # Automatically attached when structured logging is enabled for :active_record
       #   Sentry.init do |config|
-      #     config.enable_logs = true
       #     config.rails.structured_logging = true
       #     config.rails.structured_logging.subscribers = { active_record: Sentry::Rails::LogSubscribers::ActiveRecordSubscriber }
       #   end
       class ActiveRecordSubscriber < Sentry::Rails::LogSubscriber
-        include ParameterFilter
-
         EXCLUDED_NAMES = ["SCHEMA", "TRANSACTION"].freeze
         EMPTY_ARRAY = [].freeze
 
@@ -49,7 +45,7 @@ module Sentry
 
           binds = event.payload[:binds]
 
-          if Sentry.configuration.send_default_pii && (binds && !binds.empty?)
+          if Sentry.configuration.data_collection.database_query_data && (binds && !binds.empty?)
             type_casted_binds = type_casted_binds(event)
 
             type_casted_binds.each_with_index do |value, index|

data/lib/sentry/rails/railtie.rb

@@ -142,7 +142,7 @@ module Sentry
     end
 
     def activate_structured_logging
-      if Sentry.configuration.rails.structured_logging.enabled? && Sentry.configuration.enable_logs
+      if Sentry.configuration.rails.structured_logging.enabled?
         Sentry::Rails::StructuredLogging.attach(Sentry.configuration.rails.structured_logging)
       end
     end

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

@@ -34,7 +34,10 @@ module Sentry
             ) do |span|
               payload.each do |key, value|
                 next if key == START_TIMESTAMP_NAME
-                next if key == :key && !Sentry.configuration.send_default_pii
+                # Active Storage keys are automatically generated storage data,
+                # rather than URL/query data. Use the database query-data switch
+                # for the legacy PII-compatible on/off behavior.
+                next if key == :key && !Sentry.configuration.data_collection.database_query_data
 
                 span.set_data(key, value)
               end

data/lib/sentry/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Sentry
   module Rails
-    VERSION = "6.7.0"
+    VERSION = "7.0.0"
   end
 end

data/sentry-rails.gemspec

@@ -31,5 +31,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "railties", ">= 5.2.0"
-  spec.add_dependency "sentry-ruby", "~> 6.7.0"
+  spec.add_dependency "sentry-ruby", "~> 7.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 6.7.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Sentry Team
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.7.0
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.7.0
+        version: 7.0.0
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -112,7 +112,6 @@ files:
 - lib/sentry/rails/log_subscribers/action_mailer_subscriber.rb
 - lib/sentry/rails/log_subscribers/active_job_subscriber.rb
 - lib/sentry/rails/log_subscribers/active_record_subscriber.rb
-- lib/sentry/rails/log_subscribers/parameter_filter.rb
 - lib/sentry/rails/overrides/streaming_reporter.rb
 - lib/sentry/rails/railtie.rb
 - lib/sentry/rails/rescued_exception_interceptor.rb
@@ -126,15 +125,15 @@ files:
 - lib/sentry/rails/tracing/active_support_subscriber.rb
 - lib/sentry/rails/version.rb
 - sentry-rails.gemspec
-homepage: https://github.com/getsentry/sentry-ruby/tree/6.7.0/sentry-rails
+homepage: https://github.com/getsentry/sentry-ruby/tree/7.0.0/sentry-rails
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/6.7.0/sentry-rails
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/6.7.0/sentry-rails
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/6.7.0/CHANGELOG.md
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/7.0.0/sentry-rails
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/7.0.0/sentry-rails
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/7.0.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/sentry-rails/6.7.0
+  documentation_uri: http://www.rubydoc.info/gems/sentry-rails/7.0.0
 rdoc_options: []
 require_paths:
 - lib

data/lib/sentry/rails/log_subscribers/parameter_filter.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module Sentry
-  module Rails
-    module LogSubscribers
-      # Shared utility module for filtering sensitive parameters in log subscribers.
-      #
-      # This module provides consistent parameter filtering across all Sentry Rails
-      # log subscribers, leveraging Rails' built-in parameter filtering when available.
-      # It automatically detects the correct Rails parameter filtering API based on
-      # the Rails version and includes the appropriate implementation module.
-      #
-      # @example Usage in a log subscriber
-      #   class MySubscriber < Sentry::Rails::LogSubscriber
-      #     include Sentry::Rails::LogSubscribers::ParameterFilter
-      #
-      #     def my_event(event)
-      #       if Sentry.configuration.send_default_pii && event.payload[:params]
-      #         filtered_params = filter_sensitive_params(event.payload[:params])
-      #         attributes[:params] = filtered_params unless filtered_params.empty?
-      #       end
-      #     end
-      #   end
-      module ParameterFilter
-        EMPTY_HASH = {}.freeze
-
-        if ::Rails.version.to_f >= 6.0
-          def self.backend
-            ActiveSupport::ParameterFilter
-          end
-        else
-          def self.backend
-            ActionDispatch::Http::ParameterFilter
-          end
-        end
-
-        # Filter sensitive parameters from a hash, respecting Rails configuration.
-        #
-        # @param params [Hash] The parameters to filter
-        # @return [Hash] Filtered parameters with sensitive data removed
-        def filter_sensitive_params(params)
-          return EMPTY_HASH unless params.is_a?(Hash)
-
-          filter_parameters = ::Rails.application.config.filter_parameters
-          parameter_filter = ParameterFilter.backend.new(filter_parameters)
-
-          parameter_filter.filter(params)
-        end
-      end
-    end
-  end
-end