sentry-ruby 6.7.0 → 7.1.0

data/lib/sentry/threaded_periodic_worker.rb

@@ -4,41 +4,118 @@ module Sentry
   class ThreadedPeriodicWorker
     include LoggingHelper
 
+    # @!visibility private
+    attr_reader :thread, :thread_mutex, :idle_condition
+
     def initialize(sdk_logger, interval)
+      @process_id = Process.pid
       @thread = nil
       @exited = false
       @interval = interval
       @sdk_logger = sdk_logger
+
+      @thread_mutex = Mutex.new
+      @wake_condition = ConditionVariable.new
+      @idle_condition = ConditionVariable.new
+
+      @woken = false
+      @running = false
     end
 
     def ensure_thread
-      return false if @exited
-      return true if @thread&.alive?
+      reset_if_forked
 
-      @thread = Thread.new do
-        loop do
-          sleep(@interval)
-          run
-        end
-      end
+      @thread_mutex.synchronize do
+        return false if @exited
+        return true if @thread&.alive?
 
-      true
+        @thread = Thread.new { worker_loop }
+
+        true
+      end
     rescue ThreadError
+      @thread_mutex.synchronize { @exited = true }
       log_debug("[#{self.class.name}] thread creation failed")
-      @exited = true
       false
     end
 
+    def wake
+      @thread_mutex.synchronize do
+        next false if @exited
+
+        @woken = true
+        @wake_condition.signal
+        true
+      end
+    end
+
+    def wait_until_idle(timeout = nil)
+      deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + timeout if timeout
+
+      @thread_mutex.synchronize do
+        while !@exited && (@running || @woken)
+          remaining = deadline - Process.clock_gettime(Process::CLOCK_MONOTONIC) if deadline
+          return false if remaining && remaining <= 0
+
+          @idle_condition.wait(@thread_mutex, remaining)
+        end
+
+        true
+      end
+    end
+
     def kill
-      @exited = true
+      thread = @thread_mutex.synchronize do
+        @exited = true
+        @woken = false
+        @idle_condition.broadcast
+        @thread
+      end
 
       # Only a started worker has a thread to kill (and to log about).
       # Guarding here keeps a never-started worker's teardown silent, so
       # killing one during test reset can't emit a stray debug line.
-      return unless @thread
+      return unless thread
 
       log_debug("[#{self.class.name}] thread killed")
-      @thread.kill
+      thread.kill
+    end
+
+    private
+
+    def reset_if_forked
+      return false if @process_id == Process.pid
+
+      @process_id = Process.pid
+      @thread = nil
+      @exited = false
+      @woken = false
+      @running = false
+      @thread_mutex = Mutex.new
+      @wake_condition = ConditionVariable.new
+      @idle_condition = ConditionVariable.new
+      true
+    end
+
+    def worker_loop
+      loop do
+        @thread_mutex.synchronize do
+          @wake_condition.wait(@thread_mutex, @interval) unless @woken
+          @woken = false
+          @running = true
+        end
+
+        begin
+          run
+        rescue Exception => e
+          log_error("[#{self.class.name}] run failed", e)
+        ensure
+          @thread_mutex.synchronize do
+            @running = false
+            @idle_condition.broadcast
+          end
+        end
+      end
     end
   end
 end

data/lib/sentry/transaction.rb

@@ -14,6 +14,7 @@ module Sentry
     SOURCES = %i[custom url route view component task]
 
     include LoggingHelper
+    include CallbackHelper
 
     # The name of the transaction.
     # @return [String]
@@ -142,7 +143,12 @@ module Sentry
 
       sample_rate =
         if configuration.traces_sampler.is_a?(Proc)
-          configuration.traces_sampler.call(sampling_context)
+          safe_dispatch_callback(
+            "traces_sampler",
+            configuration.traces_sampler,
+            [sampling_context],
+            fallback: configuration.traces_sample_rate
+          )
         elsif !sampling_context[:parent_sampled].nil?
           sampling_context[:parent_sampled]
         else

data/lib/sentry/utils/callback_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Sentry
+  # @private
+  module CallbackHelper
+    # @!visibility private
+    def safe_dispatch_callback(callback_name, callback, args, fallback: nil)
+      callback.call(*args)
+    rescue => e
+      log_callback_error(callback_name, e)
+      fallback
+    end
+
+    private
+
+    def log_callback_error(callback_name, exception)
+      return unless Sentry.initialized?
+
+      message = "Error in #{callback_name} callback: #{exception.message}"
+      message += "\n#{exception.backtrace.join("\n")}" if Sentry.configuration.debug && exception.backtrace
+
+      Sentry.sdk_logger.error(LOGGER_PROGNAME) { message }
+    rescue StandardError
+      # Callback error reporting must not propagate to the application.
+    end
+  end
+end

data/lib/sentry/utils/http_tracing.rb

@@ -1,11 +1,39 @@
 # frozen_string_literal: true
 
+require "uri"
+
 module Sentry
   module Utils
     module HttpTracing
+      def filter_query_params(query)
+        return nil unless query
+        return nil unless query.is_a?(String) || query.is_a?(Hash)
+
+        query_hash = if query.is_a?(String)
+          URI.decode_www_form(query).each_with_object({}) do |(key, value), params|
+            params[key] = params.key?(key) ? Array(params[key]) + [value] : value
+          end
+        else
+          query
+        end
+
+        filtered_query_hash = Sentry.configuration.data_collection.url_query_params.filter(query_hash)
+        return nil if filtered_query_hash.empty?
+
+        HttpTracing.format_query(filtered_query_hash)
+      rescue
+        nil
+      end
+
+      def self.format_query(query)
+        query.flat_map do |key, value|
+          Array(value).map { |item| "#{key}=#{item}" }
+        end.join("&")
+      end
+
       def set_span_info(sentry_span, request_info, response_status)
         sentry_span.set_description("#{request_info[:method]} #{request_info[:url]}")
-        sentry_span.set_data(Span::DataConventions::URL, request_info[:url])
+        sentry_span.set_data(Span::DataConventions::URL, url_with_query(request_info))
         sentry_span.set_data(Span::DataConventions::HTTP_METHOD, request_info[:method])
         sentry_span.set_data(Span::DataConventions::HTTP_QUERY, request_info[:query]) if request_info[:query]
         sentry_span.set_data(Span::DataConventions::HTTP_STATUS_CODE, response_status)
@@ -43,37 +71,25 @@ module Sentry
           Sentry.configuration.trace_propagation_targets.any? { |target| url.match?(target) }
       end
 
-      # Kindly borrowed from Rack::Utils
-      def build_nested_query(value, prefix = nil)
-        case value
-        when Array
-          value.map { |v|
-            build_nested_query(v, "#{prefix}[]")
-          }.join("&")
-        when Hash
-          value.map { |k, v|
-            build_nested_query(v, prefix ? "#{prefix}[#{k}]" : k)
-          }.delete_if(&:empty?).join("&")
-        when nil
-          URI.encode_www_form_component(prefix)
-        else
-          raise ArgumentError, "value must be a Hash" if prefix.nil?
-          "#{URI.encode_www_form_component(prefix)}=#{URI.encode_www_form_component(value)}"
-        end
-      end
 
       private
 
+      def url_with_query(request_info)
+        return request_info[:url] unless request_info[:query]
+
+        "#{request_info[:url]}?#{request_info[:query]}"
+      end
+
       def get_level(status)
         return :info unless status && status.is_a?(Integer)
 
-if status >= 500
-  :error
-elsif status >= 400
-  :warning
-else
-  :info
-end
+        if status >= 500
+          :error
+        elsif status >= 400
+          :warning
+        else
+          :info
+        end
       end
     end
   end

data/lib/sentry/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sentry
-  VERSION = "6.7.0"
+  VERSION = "7.1.0"
 end

data/lib/sentry-ruby.rb

@@ -10,6 +10,7 @@ require "sentry/core_ext/object/deep_dup"
 require "sentry/utils/argument_checking_helper"
 require "sentry/utils/encoding_helper"
 require "sentry/utils/logging_helper"
+require "sentry/utils/callback_helper"
 require "sentry/utils/sample_rand"
 require "sentry/configuration"
 require "sentry/structured_logger"
@@ -277,7 +278,7 @@ module Sentry
       @background_worker = Sentry::BackgroundWorker.new(config)
       @session_flusher = config.session_tracking? ? Sentry::SessionFlusher.new(config, client) : nil
       @backpressure_monitor = config.enable_backpressure_handling ? Sentry::BackpressureMonitor.new(config, client) : nil
-      exception_locals_tp.enable if config.include_local_variables
+      exception_locals_tp.enable if config.data_collection.collect_stack_frame_variables?
       at_exit { close }
     end
 
@@ -300,8 +301,10 @@ module Sentry
       if client = get_current_client
         client.configuration.run_after_close_callbacks
         client.flush
+        client.log_event_buffer.kill
+        client.metric_event_buffer.kill
 
-        if client.configuration.include_local_variables
+        if client.configuration.data_collection.collect_stack_frame_variables?
           exception_locals_tp.disable
         end
       end
@@ -527,7 +530,7 @@ module Sentry
     #   Sentry.capture_log("User logged in", level: :info, user_id: 123)
     #
     # @see https://develop.sentry.dev/sdk/telemetry/logs/ Sentry SDK Telemetry Logs Protocol
-    # @return [LogEvent, nil] The created log event or nil if logging is disabled
+    # @return [LogEvent, nil] The created log event or nil if Sentry is not initialized
     def capture_log(message, **options)
       return unless initialized?
       get_current_hub.capture_log_event(message, **options)
@@ -639,14 +642,6 @@ module Sentry
 
     # Returns the structured logger instance that implements Sentry's SDK telemetry logs protocol.
     #
-    # This logger is only available when logs are enabled in the configuration.
-    #
-    # @example Enable logs in configuration
-    #   Sentry.init do |config|
-    #     config.dsn = "YOUR_DSN"
-    #     config.enable_logs = true
-    #   end
-    #
     # @example Basic usage
     #   Sentry.logger.info("User logged in successfully", user_id: 123)
     #   Sentry.logger.error("Failed to process payment",
@@ -656,19 +651,13 @@ module Sentry
     #
     # @see https://develop.sentry.dev/sdk/telemetry/logs/ Sentry SDK Telemetry Logs Protocol
     #
-    # @return [StructuredLogger] The structured logger instance or nil if logs are disabled
+    # @return [StructuredLogger] The structured logger instance
     def logger
       @logger ||= configuration.structured_logging.logger_class.new(configuration)
     end
 
     # Returns the metrics API for capturing custom metrics.
     #
-    # @example Enable metrics
-    #   Sentry.init do |config|
-    #     config.dsn = "YOUR_DSN"
-    #     config.enable_metrics = true
-    #   end
-    #
     # @example Usage
     #   Sentry.metrics.count("button.click", 1, attributes: { button_id: "submit" })
     #   Sentry.metrics.distribution("response.time", 120.5, unit: "millisecond")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 6.7.0
+  version: 7.1.0
 platform: ruby
 authors:
 - Sentry Team
@@ -125,6 +125,8 @@ files:
 - lib/sentry/cron/monitor_check_ins.rb
 - lib/sentry/cron/monitor_config.rb
 - lib/sentry/cron/monitor_schedule.rb
+- lib/sentry/data_collection.rb
+- lib/sentry/data_collection/key_value_collection.rb
 - lib/sentry/debug_structured_logger.rb
 - lib/sentry/dsn.rb
 - lib/sentry/envelope.rb
@@ -183,6 +185,7 @@ files:
 - lib/sentry/transport/http_transport.rb
 - lib/sentry/transport/spotlight_transport.rb
 - lib/sentry/utils/argument_checking_helper.rb
+- lib/sentry/utils/callback_helper.rb
 - lib/sentry/utils/custom_inspection.rb
 - lib/sentry/utils/encoding_helper.rb
 - lib/sentry/utils/env_helper.rb
@@ -200,15 +203,15 @@ files:
 - lib/sentry/version.rb
 - sentry-ruby-core.gemspec
 - sentry-ruby.gemspec
-homepage: https://github.com/getsentry/sentry-ruby/tree/6.7.0/sentry-ruby
+homepage: https://github.com/getsentry/sentry-ruby/tree/7.1.0/sentry-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/6.7.0/sentry-ruby
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/6.7.0/sentry-ruby
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/6.7.0/CHANGELOG.md
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/7.1.0/sentry-ruby
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/7.1.0/sentry-ruby
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/7.1.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/6.7.0
+  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/7.1.0
 rdoc_options: []
 require_paths:
 - lib