sentry-ruby 5.15.2 → 5.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed83b6915b7b845897d60615cf014a4390057988f8902cce127d4a0cd4374828
-  data.tar.gz: 123678c45d2fe455db04c058c33a7f87c515c76d90dba6dfe7e44e558c8ecb6e
+  metadata.gz: 4a5743489d7783f058f5efc6085e044b6f90e8b13ddf0327d93b09a1a26689c5
+  data.tar.gz: '086b5740b42d73b3c87c4f2fb796e1b8692a338b8dd9cc1b5e4cc9783ab8ec5d'
 SHA512:
-  metadata.gz: 784bce1a9edaefd7e3740af4f445c0fa01bd3240f53a963559a389a121ca1205ef0f179e1964b00da9232bde473464d6abcacb05fcb912a5f5a46533cb5dbb6e
-  data.tar.gz: 11b205d8ba4f3649ee42b66af1510a62673fa791d5ff28aa687c68ad94b17ed3e54c9c57536a07d3cf6d4a5ee5504e5bf9871ec00bb0dba457b661850b0f09b7
+  metadata.gz: c8b03ba3fce273ee269a02bc6b6a1d3a875473bd53572ba565022dd3e9bb57f87d7083d6b04e6bc987796ed7a2dc83e6ed4885abc18e0582680975b353eaa879
+  data.tar.gz: 58be55ae2198fdf17697f22fc8fb4140bcdd4ef9a5b53a09c5a16e29bf42857242393d023536e1219483a803e8647908936a4e6fd84b86924ac0627b5ec62bf8

data/lib/sentry/background_worker.rb

@@ -65,6 +65,11 @@ module Sentry
       @shutdown_callback&.call
     end
 
+    def full?
+      @executor.is_a?(Concurrent::ThreadPoolExecutor) &&
+        @executor.remaining_capacity == 0
+    end
+
     private
 
     def _perform(&block)

data/lib/sentry/backpressure_monitor.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Sentry
+  class BackpressureMonitor
+    include LoggingHelper
+
+    DEFAULT_INTERVAL = 10
+    MAX_DOWNSAMPLE_FACTOR = 10
+
+    def initialize(configuration, client, interval: DEFAULT_INTERVAL)
+      @interval = interval
+      @client = client
+      @logger = configuration.logger
+
+      @thread = nil
+      @exited = false
+
+      @healthy = true
+      @downsample_factor = 0
+    end
+
+    def healthy?
+      ensure_thread
+      @healthy
+    end
+
+    def downsample_factor
+      ensure_thread
+      @downsample_factor
+    end
+
+    def run
+      check_health
+      set_downsample_factor
+    end
+
+    def check_health
+      @healthy = !(@client.transport.any_rate_limited? || Sentry.background_worker&.full?)
+    end
+
+    def set_downsample_factor
+      if @healthy
+        log_debug("[BackpressureMonitor] health check positive, reverting to normal sampling") if @downsample_factor.positive?
+        @downsample_factor = 0
+      else
+        @downsample_factor += 1 if @downsample_factor < MAX_DOWNSAMPLE_FACTOR
+        log_debug("[BackpressureMonitor] health check negative, downsampling with a factor of #{@downsample_factor}")
+      end
+    end
+
+    def kill
+      log_debug("[BackpressureMonitor] killing monitor")
+
+      @exited = true
+      @thread&.kill
+    end
+
+    private
+
+    def ensure_thread
+      return if @exited
+      return if @thread&.alive?
+
+      @thread = Thread.new do
+        loop do
+          sleep(@interval)
+          run
+        end
+      end
+    rescue ThreadError
+      log_debug("[BackpressureMonitor] Thread creation failed")
+      @exited = true
+    end
+  end
+end

data/lib/sentry/client.rb

@@ -57,7 +57,7 @@ module Sentry
       event = scope.apply_to_event(event, hint)
 
       if event.nil?
-        log_info("Discarded event because one of the event processors returned nil")
+        log_debug("Discarded event because one of the event processors returned nil")
         transport.record_lost_event(:event_processor, event_type)
         return
       end
@@ -156,7 +156,7 @@ module Sentry
         event = configuration.before_send.call(event, hint)
 
         if event.nil?
-          log_info("Discarded event because before_send returned nil")
+          log_debug("Discarded event because before_send returned nil")
           transport.record_lost_event(:before_send, 'event')
           return
         end
@@ -166,7 +166,7 @@ module Sentry
         event = configuration.before_send_transaction.call(event, hint)
 
         if event.nil?
-          log_info("Discarded event because before_send_transaction returned nil")
+          log_debug("Discarded event because before_send_transaction returned nil")
           transport.record_lost_event(:before_send, 'transaction')
           return
         end
@@ -177,11 +177,7 @@ module Sentry
 
       event
     rescue => e
-      loggable_event_type = event_type.capitalize
-      log_error("#{loggable_event_type} sending failed", e, debug: configuration.debug)
-
-      event_info = Event.get_log_message(event.to_hash)
-      log_info("Unreported #{loggable_event_type}: #{event_info}")
+      log_error("Event sending failed", e, debug: configuration.debug)
       transport.record_lost_event(:network_error, event_type)
       raise
     end

data/lib/sentry/configuration.rb

@@ -7,6 +7,7 @@ require 'sentry/utils/custom_inspection'
 require "sentry/dsn"
 require "sentry/release_detector"
 require "sentry/transport/configuration"
+require "sentry/cron/configuration"
 require "sentry/linecache"
 require "sentry/interfaces/stacktrace_builder"
 
@@ -226,10 +227,14 @@ module Sentry
     # @return [String]
     attr_accessor :server_name
 
-    # Return a Transport::Configuration object for transport-related configurations.
-    # @return [Transport]
+    # Transport related configuration.
+    # @return [Transport::Configuration]
     attr_reader :transport
 
+    # Cron related configuration.
+    # @return [Cron::Configuration]
+    attr_reader :cron
+
     # Take a float between 0.0 and 1.0 as the sample rate for tracing events (transactions).
     # @return [Float, nil]
     attr_reader :traces_sample_rate
@@ -258,6 +263,12 @@ module Sentry
     # @return [Boolean]
     attr_accessor :auto_session_tracking
 
+    # Whether to downsample transactions automatically because of backpressure.
+    # Starts a new monitor thread to check health of the SDK every 10 seconds.
+    # Default is false
+    # @return [Boolean]
+    attr_accessor :enable_backpressure_handling
+
     # Allowlist of outgoing request targets to which sentry-trace and baggage headers are attached.
     # Default is all (/.*/)
     # @return [Array<String, Regexp>]
@@ -358,6 +369,7 @@ module Sentry
       self.skip_rake_integration = false
       self.send_client_reports = true
       self.auto_session_tracking = true
+      self.enable_backpressure_handling = false
       self.trusted_proxies = []
       self.dsn = ENV['SENTRY_DSN']
       self.spotlight = false
@@ -373,6 +385,7 @@ module Sentry
       self.enable_tracing = nil
 
       @transport = Transport::Configuration.new
+      @cron = Cron::Configuration.new
       @gem_specs = Hash[Gem::Specification.map { |spec| [spec.name, spec.version.to_s] }] if Gem::Specification.respond_to?(:map)
 
       run_post_initialization_callbacks
@@ -461,7 +474,7 @@ module Sentry
 
     def profiles_sample_rate=(profiles_sample_rate)
       raise ArgumentError, "profiles_sample_rate must be a Numeric or nil" unless is_numeric_or_nil?(profiles_sample_rate)
-      log_info("Please make sure to include the 'stackprof' gem in your Gemfile to use Profiling with Sentry.") unless defined?(StackProf)
+      log_warn("Please make sure to include the 'stackprof' gem in your Gemfile to use Profiling with Sentry.") unless defined?(StackProf)
       @profiles_sample_rate = profiles_sample_rate
     end
 

data/lib/sentry/cron/configuration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Sentry
+  module Cron
+    class Configuration
+      # Defaults set here will apply to all {Cron::MonitorConfig} objects unless overwritten.
+
+      # How long (in minutes) after the expected checkin time will we wait
+      # until we consider the checkin to have been missed.
+      # @return [Integer, nil]
+      attr_accessor :default_checkin_margin
+
+      # How long (in minutes) is the checkin allowed to run for in in_progress
+      # before it is considered failed.
+      # @return [Integer, nil]
+      attr_accessor :default_max_runtime
+
+      # tz database style timezone string
+      # @return [String, nil]
+      attr_accessor :default_timezone
+    end
+  end
+end

data/lib/sentry/cron/monitor_check_ins.rb

@@ -13,32 +13,42 @@ module Sentry
                                                 monitor_config: monitor_config)
 
           start = Sentry.utc_now.to_i
-          # need to do this on ruby <= 2.6 sadly
-          ret = method(:perform).super_method.arity == 0 ? super() : super
-          duration = Sentry.utc_now.to_i - start
 
-          Sentry.capture_check_in(slug,
-                                  :ok,
-                                  check_in_id: check_in_id,
-                                  duration: duration,
-                                  monitor_config: monitor_config)
+          begin
+            # need to do this on ruby <= 2.6 sadly
+            ret = method(:perform).super_method.arity == 0 ? super() : super
+            duration = Sentry.utc_now.to_i - start
 
-          ret
-        rescue Exception
-          duration = Sentry.utc_now.to_i - start
+            Sentry.capture_check_in(slug,
+                                    :ok,
+                                    check_in_id: check_in_id,
+                                    duration: duration,
+                                    monitor_config: monitor_config)
 
-          Sentry.capture_check_in(slug,
-                                  :error,
-                                  check_in_id: check_in_id,
-                                  duration: duration,
-                                  monitor_config: monitor_config)
+            ret
+          rescue Exception
+            duration = Sentry.utc_now.to_i - start
 
-          raise
+            Sentry.capture_check_in(slug,
+                                    :error,
+                                    check_in_id: check_in_id,
+                                    duration: duration,
+                                    monitor_config: monitor_config)
+
+            raise
+          end
         end
       end
 
       module ClassMethods
         def sentry_monitor_check_ins(slug: nil, monitor_config: nil)
+          if monitor_config && Sentry.configuration
+            cron_config = Sentry.configuration.cron
+            monitor_config.checkin_margin ||= cron_config.default_checkin_margin
+            monitor_config.max_runtime ||= cron_config.default_max_runtime
+            monitor_config.timezone ||= cron_config.default_timezone
+          end
+
           @sentry_monitor_slug = slug
           @sentry_monitor_config = monitor_config
 
@@ -57,8 +67,6 @@ module Sentry
         end
       end
 
-      extend ClassMethods
-
       def self.included(base)
         base.extend(ClassMethods)
       end

data/lib/sentry/event.rb

@@ -76,34 +76,6 @@ module Sentry
       @message = (message || "").byteslice(0..MAX_MESSAGE_SIZE_IN_BYTES)
     end
 
-    class << self
-      # @!visibility private
-      def get_log_message(event_hash)
-        message = event_hash[:message] || event_hash['message']
-
-        return message unless message.nil? || message.empty?
-
-        message = get_message_from_exception(event_hash)
-
-        return message unless message.nil? || message.empty?
-
-        message = event_hash[:transaction] || event_hash["transaction"]
-
-        return message unless message.nil? || message.empty?
-
-        '<no message value>'
-      end
-
-      # @!visibility private
-      def get_message_from_exception(event_hash)
-        if exception = event_hash.dig(:exception, :values, 0)
-          "#{exception[:type]}: #{exception[:value]}"
-        elsif exception = event_hash.dig("exception", "values", 0)
-          "#{exception["type"]}: #{exception["value"]}"
-        end
-      end
-    end
-
     # @deprecated This method will be removed in v5.0.0. Please just use Sentry.configuration
     # @return [Configuration]
     def configuration

data/lib/sentry/hub.rb

@@ -156,7 +156,7 @@ module Sentry
       capture_event(event, **options, &block)
     end
 
-    def capture_check_in(slug, status, **options, &block)
+    def capture_check_in(slug, status, **options)
       check_argument_type!(slug, ::String)
       check_argument_includes!(status, Sentry::CheckInEvent::VALID_STATUSES)
 
@@ -176,7 +176,7 @@ module Sentry
 
       return unless event
 
-      capture_event(event, **options, &block)
+      capture_event(event, **options)
       event.check_in_id
     end
 

data/lib/sentry/rake.rb

@@ -17,15 +17,6 @@ module Sentry
         super
       end
     end
-
-    module Task
-      # @api private
-      def execute(args=nil)
-        return super unless Sentry.initialized? && Sentry.get_current_hub
-
-        super
-      end
-    end
   end
 end
 
@@ -34,8 +25,4 @@ module Rake
   class Application
     prepend(Sentry::Rake::Application)
   end
-
-  class Task
-    prepend(Sentry::Rake::Task)
-  end
 end

data/lib/sentry/scope.rb

@@ -44,12 +44,18 @@ module Sentry
     # @param hint [Hash] the hint data that'll be passed to event processors.
     # @return [Event]
     def apply_to_event(event, hint = nil)
-      event.tags = tags.merge(event.tags)
-      event.user = user.merge(event.user)
-      event.extra = extra.merge(event.extra)
-      event.contexts = contexts.merge(event.contexts)
-      event.transaction = transaction_name if transaction_name
-      event.transaction_info = { source: transaction_source } if transaction_source
+      unless event.is_a?(CheckInEvent)
+        event.tags = tags.merge(event.tags)
+        event.user = user.merge(event.user)
+        event.extra = extra.merge(event.extra)
+        event.contexts = contexts.merge(event.contexts)
+        event.transaction = transaction_name if transaction_name
+        event.transaction_info = { source: transaction_source } if transaction_source
+        event.fingerprint = fingerprint
+        event.level = level
+        event.breadcrumbs = breadcrumbs
+        event.rack_env = rack_env if rack_env
+      end
 
       if span
         event.contexts[:trace] ||= span.get_trace_context
@@ -58,11 +64,6 @@ module Sentry
         event.dynamic_sampling_context ||= propagation_context.get_dynamic_sampling_context
       end
 
-      event.fingerprint = fingerprint
-      event.level = level
-      event.breadcrumbs = breadcrumbs
-      event.rack_env = rack_env if rack_env
-
       all_event_processors = self.class.global_event_processors + @event_processors
 
       unless all_event_processors.empty?

data/lib/sentry/transaction.rb

@@ -218,7 +218,12 @@ module Sentry
       if sample_rate == true
         @sampled = true
       else
-        @sampled = Random.rand < sample_rate
+        if Sentry.backpressure_monitor
+          factor = Sentry.backpressure_monitor.downsample_factor
+          @effective_sample_rate /= 2**factor
+        end
+
+        @sampled = Random.rand < @effective_sample_rate
       end
 
       if @sampled
@@ -257,7 +262,9 @@ module Sentry
         event = hub.current_client.event_from_transaction(self)
         hub.capture_event(event)
       else
-        hub.current_client.transport.record_lost_event(:sample_rate, 'transaction')
+        is_backpressure = Sentry.backpressure_monitor&.downsample_factor&.positive?
+        reason = is_backpressure ? :backpressure : :sample_rate
+        hub.current_client.transport.record_lost_event(reason, 'transaction')
       end
     end
 

data/lib/sentry/transport/http_transport.rb

@@ -53,18 +53,14 @@ module Sentry
       end
 
       if response.code.match?(/\A2\d{2}/)
-        if has_rate_limited_header?(response)
-          handle_rate_limited_response(response)
-        end
+        handle_rate_limited_response(response) if has_rate_limited_header?(response)
+      elsif response.code == "429"
+        log_debug("the server responded with status 429")
+        handle_rate_limited_response(response)
       else
         error_info = "the server responded with status #{response.code}"
-
-        if response.code == "429"
-          handle_rate_limited_response(response)
-        else
-          error_info += "\nbody: #{response.body}"
-          error_info += " Error in headers is: #{response['x-sentry-error']}" if response['x-sentry-error']
-        end
+        error_info += "\nbody: #{response.body}"
+        error_info += " Error in headers is: #{response['x-sentry-error']}" if response['x-sentry-error']
 
         raise Sentry::ExternalError, error_info
       end

data/lib/sentry/transport.rb

@@ -19,7 +19,8 @@ module Sentry
       :sample_rate,
       :before_send,
       :event_processor,
-      :insufficient_data
+      :insufficient_data,
+      :backpressure
     ]
 
     include LoggingHelper
@@ -74,7 +75,7 @@ module Sentry
         result, oversized = item.serialize
 
         if oversized
-          log_info("Envelope item [#{item.type}] is still oversized after size reduction: {#{item.size_breakdown}}")
+          log_debug("Envelope item [#{item.type}] is still oversized after size reduction: {#{item.size_breakdown}}")
 
           next
         end
@@ -119,6 +120,10 @@ module Sentry
       !!delay && delay > Time.now
     end
 
+    def any_rate_limited?
+      @rate_limits.values.any? { |t| t && t > Time.now }
+    end
+
     def envelope_from_event(event)
       # Convert to hash
       event_payload = event.to_hash
@@ -163,11 +168,20 @@ module Sentry
       @discarded_events[[reason, item_type]] += 1
     end
 
+    def flush
+      client_report_headers, client_report_payload = fetch_pending_client_report(force: true)
+      return unless client_report_headers
+
+      envelope = Envelope.new
+      envelope.add_item(client_report_headers, client_report_payload)
+      send_envelope(envelope)
+    end
+
     private
 
-    def fetch_pending_client_report
+    def fetch_pending_client_report(force: false)
       return nil unless @send_client_reports
-      return nil if @last_client_report_sent > Time.now - CLIENT_REPORT_INTERVAL
+      return nil if !force && @last_client_report_sent > Time.now - CLIENT_REPORT_INTERVAL
       return nil if @discarded_events.empty?
 
       discarded_events_hash = @discarded_events.map do |key, val|
@@ -194,7 +208,7 @@ module Sentry
     def reject_rate_limited_items(envelope)
       envelope.items.reject! do |item|
         if is_rate_limited?(item.type)
-          log_info("[Transport] Envelope item [#{item.type}] not sent: rate limiting")
+          log_debug("[Transport] Envelope item [#{item.type}] not sent: rate limiting")
           record_lost_event(:ratelimit_backoff, item.type)
 
           true

data/lib/sentry/version.rb

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

data/lib/sentry-ruby.rb

@@ -21,6 +21,7 @@ require "sentry/transaction"
 require "sentry/hub"
 require "sentry/background_worker"
 require "sentry/session_flusher"
+require "sentry/backpressure_monitor"
 require "sentry/cron/monitor_check_ins"
 
 [
@@ -65,13 +66,17 @@ module Sentry
     end
 
     # @!attribute [rw] background_worker
-    #   @return [BackgroundWorker, nil]
+    #   @return [BackgroundWorker]
     attr_accessor :background_worker
 
     # @!attribute [r] session_flusher
     #   @return [SessionFlusher, nil]
     attr_reader :session_flusher
 
+    # @!attribute [r] backpressure_monitor
+    #   @return [BackpressureMonitor, nil]
+    attr_reader :backpressure_monitor
+
     ##### Patch Registration #####
 
     # @!visibility private
@@ -217,17 +222,9 @@ module Sentry
       Thread.current.thread_variable_set(THREAD_LOCAL, hub)
       @main_hub = hub
       @background_worker = Sentry::BackgroundWorker.new(config)
-
-      @session_flusher = if config.auto_session_tracking
-                           Sentry::SessionFlusher.new(config, client)
-                         else
-                           nil
-                         end
-
-      if config.include_local_variables
-        exception_locals_tp.enable
-      end
-
+      @session_flusher = config.auto_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
       at_exit { close }
     end
 
@@ -236,20 +233,27 @@ module Sentry
     #
     # @return [void]
     def close
-      if @background_worker
-        @background_worker.shutdown
-        @background_worker = nil
-      end
-
       if @session_flusher
+        @session_flusher.flush
         @session_flusher.kill
         @session_flusher = nil
       end
 
-      if configuration&.include_local_variables
-        exception_locals_tp.disable
+      if @backpressure_monitor
+        @backpressure_monitor.kill
+        @backpressure_monitor = nil
       end
 
+      if client = get_current_client
+        client.transport.flush
+
+        if client.configuration.include_local_variables
+          exception_locals_tp.disable
+        end
+      end
+
+      @background_worker.shutdown
+
       @main_hub = nil
       Thread.current.thread_variable_set(THREAD_LOCAL, nil)
     end
@@ -442,12 +446,10 @@ module Sentry
     # @option options [Integer] duration seconds elapsed since this monitor started
     # @option options [Cron::MonitorConfig] monitor_config configuration for this monitor
     #
-    # @yieldparam scope [Scope]
-    #
     # @return [String, nil] The {CheckInEvent#check_in_id} to use for later updates on the same slug
-    def capture_check_in(slug, status, **options, &block)
+    def capture_check_in(slug, status, **options)
       return unless initialized?
-      get_current_hub.capture_check_in(slug, status, **options, &block)
+      get_current_hub.capture_check_in(slug, status, **options)
     end
 
     # Takes or initializes a new Sentry::Transaction and makes a sampling decision for it.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 5.15.2
+  version: 5.16.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-18 00:00:00.000000000 Z
+date: 2024-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -51,6 +51,7 @@ files:
 - bin/setup
 - lib/sentry-ruby.rb
 - lib/sentry/background_worker.rb
+- lib/sentry/backpressure_monitor.rb
 - lib/sentry/backtrace.rb
 - lib/sentry/baggage.rb
 - lib/sentry/breadcrumb.rb
@@ -61,6 +62,7 @@ files:
 - lib/sentry/configuration.rb
 - lib/sentry/core_ext/object/deep_dup.rb
 - lib/sentry/core_ext/object/duplicable.rb
+- lib/sentry/cron/configuration.rb
 - lib/sentry/cron/monitor_check_ins.rb
 - lib/sentry/cron/monitor_config.rb
 - lib/sentry/cron/monitor_schedule.rb