sentry-ruby 5.22.1 → 5.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cf4ebc58389dd621be706b53b86c30e689f9f52c5d5cbda72ef01528c540e5a
-  data.tar.gz: f347cb6245d5d37f2d883870b26d846244d33ef6cbb67b838fe231d1c17e95f8
+  metadata.gz: '09ca0c97390e688d58572ffe3ae022523a1003a48ccea319857b302b3e1ebb95'
+  data.tar.gz: 28f154fb38f21c50090dc8ae3c2bc7b335f288a298e97d934a24db1b8e7ac372
 SHA512:
-  metadata.gz: 2dae846cd0a9d3c10d41d44a775bd39e6d175f559924bf101cd2a88816145ea2cf048962504615d5f05acca0b59451483a2b602a9fb87bba3b2be4364493fd27
-  data.tar.gz: b17875017e20c0126c8ddc5d360873430c92d69f0633134743198140c2258f828b3b444748c7a4cd8e0bb9137a9990f2dc394182ffcfe6a19d1e0f3795beebcd
+  metadata.gz: 5f170fe27327a1753f4a6f2d62b5a694f30c91f1f86c4e2caa837d70467298ea2af261475a2da1045e3513257f3a9be4bb66a0c2e0dba271e43a1478ecd42c0b
+  data.tar.gz: 32a7f13e8eee4f7c8958dfd1a083aecf7ee306fec695703c5dbeff810e4ae5ebd84a1435e7edaef8a61d94eaf64910442422d2142007d77c5be31080ad32f244

data/Gemfile

@@ -3,12 +3,16 @@
 source "https://rubygems.org"
 git_source(:github) { |name| "https://github.com/#{name}.git" }
 
+eval_gemfile "../Gemfile"
+
 gem "sentry-ruby", path: "./"
 
 rack_version = ENV["RACK_VERSION"]
 rack_version = "3.0.0" if rack_version.nil?
 gem "rack", "~> #{Gem::Version.new(rack_version)}" unless rack_version == "0"
 
+gem "ostruct" if RUBY_VERSION >= "3.4"
+
 redis_rb_version = ENV.fetch("REDIS_RB_VERSION", "5.0")
 gem "redis", "~> #{redis_rb_version}"
 
@@ -25,9 +29,8 @@ gem "benchmark_driver"
 gem "benchmark-ipsa"
 gem "benchmark-memory"
 
-gem "yard", github: "lsegal/yard"
+gem "yard"
 gem "webrick"
 gem "faraday"
 gem "excon"
-
-eval_gemfile File.expand_path("../Gemfile", __dir__)
+gem "webmock"

data/README.md

@@ -33,7 +33,7 @@ If you're using `sentry-raven`, we recommend you to migrate to this new SDK. You
 
 ## Requirements
 
-We test from Ruby 2.4 to Ruby 3.2 at the latest patchlevel/teeny version. We also support JRuby 9.0.
+We test from Ruby 2.4 to Ruby 3.4 at the latest patchlevel/teeny version. We also support JRuby 9.0.
 
 If you use self-hosted Sentry, please also make sure its version is above `20.6.0`.
 

data/lib/sentry/backtrace.rb

@@ -12,11 +12,11 @@ module Sentry
       RUBY_INPUT_FORMAT = /
         ^ \s* (?: [a-zA-Z]: | uri:classloader: )? ([^:]+ | <.*>):
         (\d+)
-        (?: :in\s('|`)([^']+)')?$
+        (?: :in\s('|`)(?:([\w:]+)\#)?([^']+)')?$
       /x
 
       # org.jruby.runtime.callsite.CachingCallSite.call(CachingCallSite.java:170)
-      JAVA_INPUT_FORMAT = /^(.+)\.([^\.]+)\(([^\:]+)\:(\d+)\)$/
+      JAVA_INPUT_FORMAT = /^([\w$.]+)\.([\w$]+)\(([\w$.]+):(\d+)\)$/
 
       # The file portion of the line (such as app/models/user.rb)
       attr_reader :file
@@ -37,10 +37,11 @@ module Sentry
       # @return [Line] The parsed backtrace line
       def self.parse(unparsed_line, in_app_pattern = nil)
         ruby_match = unparsed_line.match(RUBY_INPUT_FORMAT)
+
         if ruby_match
-          _, file, number, _, method = ruby_match.to_a
+          _, file, number, _, module_name, method = ruby_match.to_a
           file.sub!(/\.class$/, RB_EXTENSION)
-          module_name = nil
+          module_name = module_name
         else
           java_match = unparsed_line.match(JAVA_INPUT_FORMAT)
           _, module_name, method, file, number = java_match.to_a

data/lib/sentry/breadcrumb.rb

@@ -47,7 +47,7 @@ module Sentry
     # @param message [String]
     # @return [void]
     def message=(message)
-      @message = (message || "").byteslice(0..Event::MAX_MESSAGE_SIZE_IN_BYTES)
+      @message = message ? message.byteslice(0..Event::MAX_MESSAGE_SIZE_IN_BYTES) : ""
     end
 
     # @param level [String]

data/lib/sentry/client.rb

@@ -183,8 +183,19 @@ module Sentry
       if event_type != TransactionEvent::TYPE && configuration.before_send
         event = configuration.before_send.call(event, hint)
 
-        if event.nil?
-          log_debug("Discarded event because before_send returned nil")
+        case event
+        when ErrorEvent, CheckInEvent
+          # do nothing
+        when Hash
+          log_debug(<<~MSG)
+            Returning a Hash from before_send is deprecated and will be removed in the next major version.
+            Please return a Sentry::ErrorEvent object instead.
+          MSG
+        else
+          # Avoid serializing the event object in this case because we aren't sure what it is and what it contains
+          log_debug(<<~MSG)
+            Discarded event because before_send didn't return a Sentry::ErrorEvent object but an instance of #{event.class}
+          MSG
           transport.record_lost_event(:before_send, data_category)
           return
         end
@@ -193,15 +204,25 @@ module Sentry
       if event_type == TransactionEvent::TYPE && configuration.before_send_transaction
         event = configuration.before_send_transaction.call(event, hint)
 
-        if event.nil?
-          log_debug("Discarded event because before_send_transaction returned nil")
-          transport.record_lost_event(:before_send, "transaction")
-          transport.record_lost_event(:before_send, "span", num: spans_before + 1)
-          return
-        else
+        if event.is_a?(TransactionEvent) || event.is_a?(Hash)
           spans_after = event.is_a?(TransactionEvent) ? event.spans.size : 0
           spans_delta = spans_before - spans_after
           transport.record_lost_event(:before_send, "span", num: spans_delta) if spans_delta > 0
+
+          if event.is_a?(Hash)
+            log_debug(<<~MSG)
+              Returning a Hash from before_send_transaction is deprecated and will be removed in the next major version.
+              Please return a Sentry::TransactionEvent object instead.
+            MSG
+          end
+        else
+          # Avoid serializing the event object in this case because we aren't sure what it is and what it contains
+          log_debug(<<~MSG)
+            Discarded event because before_send_transaction didn't return a Sentry::TransactionEvent object but an instance of #{event.class}
+          MSG
+          transport.record_lost_event(:before_send, "transaction")
+          transport.record_lost_event(:before_send, "span", num: spans_before + 1)
+          return
         end
       end
 

data/lib/sentry/configuration.rb

@@ -264,6 +264,7 @@ module Sentry
 
     # Easier way to use performance tracing
     # If set to true, will set traces_sample_rate to 1.0
+    # @deprecated It will be removed in the next major release.
     # @return [Boolean, nil]
     attr_reader :enable_tracing
 
@@ -360,8 +361,47 @@ module Sentry
       def add_post_initialization_callback(&block)
         post_initialization_callbacks << block
       end
+
+      def validations
+        @validations ||= {}
+      end
+
+      def validate(attribute, optional: false, type: nil)
+        validations[attribute] = {
+          optional: optional,
+          type: type,
+          proc: build_validation_proc(optional, type)
+        }
+      end
+
+      private
+
+      def build_validation_proc(optional, type)
+        case type
+        when :numeric
+          ->(value) do
+            if optional && value.nil?
+              true
+            else
+              unless value.is_a?(Numeric)
+                message = "must be a Numeric"
+                message += " or nil" if optional
+
+                { error: message, value: value }
+              else
+                true
+              end
+            end
+          end
+        else
+          ->(value) { true }
+        end
+      end
     end
 
+    validate :traces_sample_rate, optional: true, type: :numeric
+    validate :profiles_sample_rate, optional: true, type: :numeric
+
     def initialize
       self.app_dirs_pattern = APP_DIRS_PATTERN
       self.debug = Sentry::Utils::EnvHelper.env_to_bool(ENV["SENTRY_DEBUG"])
@@ -417,6 +457,24 @@ module Sentry
       run_post_initialization_callbacks
     end
 
+    def validate
+      if profiler_class == Sentry::Profiler && profiles_sample_rate && !Sentry.dependency_installed?(:StackProf)
+        log_warn("Please add the 'stackprof' gem to your Gemfile to use the StackProf profiler with Sentry.")
+      end
+
+      if profiler_class == Sentry::Vernier::Profiler && profiles_sample_rate && !Sentry.dependency_installed?(:Vernier)
+        log_warn("Please add the 'vernier' gem to your Gemfile to use the Vernier profiler with Sentry.")
+      end
+
+      self.class.validations.each do |attribute, validation|
+        value = public_send(attribute)
+
+        next if (result = validation[:proc].call(value)) === true
+
+        raise ArgumentError, result[:error]
+      end
+    end
+
     def dsn=(value)
       @dsn = init_dsn(value)
     end
@@ -485,22 +543,21 @@ module Sentry
     end
 
     def enable_tracing=(enable_tracing)
+      unless enable_tracing.nil?
+        log_warn <<~MSG
+          `enable_tracing` is now deprecated in favor of `traces_sample_rate = 1.0`.
+        MSG
+      end
+
       @enable_tracing = enable_tracing
       @traces_sample_rate ||= 1.0 if enable_tracing
     end
 
-    def is_numeric_or_nil?(value)
-      value.is_a?(Numeric) || value.nil?
-    end
-
     def traces_sample_rate=(traces_sample_rate)
-      raise ArgumentError, "traces_sample_rate must be a Numeric or nil" unless is_numeric_or_nil?(traces_sample_rate)
       @traces_sample_rate = traces_sample_rate
     end
 
     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_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
 
@@ -509,7 +566,6 @@ module Sentry
         begin
           require "vernier"
         rescue LoadError
-          raise ArgumentError, "Please add the 'vernier' gem to your Gemfile to use the Vernier profiler with Sentry."
         end
       end
 

data/lib/sentry/cron/monitor_check_ins.rb

@@ -14,12 +14,12 @@ module Sentry
                                                 :in_progress,
                                                 monitor_config: monitor_config)
 
-          start = Sentry.utc_now.to_i
+          start = Metrics::Timing.duration_start
 
           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
+            duration = Metrics::Timing.duration_end(start)
 
             Sentry.capture_check_in(slug,
                                     :ok,
@@ -29,7 +29,7 @@ module Sentry
 
             ret
           rescue Exception
-            duration = Sentry.utc_now.to_i - start
+            duration = Metrics::Timing.duration_end(start)
 
             Sentry.capture_check_in(slug,
                                     :error,

data/lib/sentry/hub.rb

@@ -8,12 +8,42 @@ module Sentry
   class Hub
     include ArgumentCheckingHelper
 
+    MUTEX = Mutex.new
+
     attr_reader :last_event_id
 
+    attr_reader :current_profiler
+
     def initialize(client, scope)
       first_layer = Layer.new(client, scope)
       @stack = [first_layer]
       @last_event_id = nil
+      @current_profiler = {}
+    end
+
+    # This is an internal private method
+    # @api private
+    def start_profiler!(transaction)
+      MUTEX.synchronize do
+        transaction.start_profiler!
+        @current_profiler[transaction.__id__] = transaction.profiler
+      end
+    end
+
+    # This is an internal private method
+    # @api private
+    def stop_profiler!(transaction)
+      MUTEX.synchronize do
+        @current_profiler.delete(transaction.__id__)&.stop
+      end
+    end
+
+    # This is an internal private method
+    # @api private
+    def profiler_running?
+      MUTEX.synchronize do
+        !@current_profiler.empty?
+      end
     end
 
     def new_from_top
@@ -96,7 +126,7 @@ module Sentry
       sampling_context.merge!(custom_sampling_context)
       transaction.set_initial_sample_decision(sampling_context: sampling_context)
 
-      transaction.start_profiler!
+      start_profiler!(transaction)
 
       transaction
     end

data/lib/sentry/linecache.rb

@@ -29,9 +29,9 @@ module Sentry
 
     def getlines(path)
       @cache[path] ||= begin
-        IO.readlines(path)
-                       rescue
-                         nil
+        File.open(path, "r", &:readlines)
+      rescue
+        nil
       end
     end
 

data/lib/sentry/metrics/timing.rb

@@ -37,6 +37,14 @@ module Sentry
         def week
           Sentry.utc_now.to_i / (3600.0 * 24.0 * 7.0)
         end
+
+        def duration_start
+          Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        end
+
+        def duration_end(start)
+          Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
+        end
       end
     end
   end

data/lib/sentry/net/http.rb

@@ -13,6 +13,7 @@ module Sentry
       OP_NAME = "http.client"
       SPAN_ORIGIN = "auto.http.net_http"
       BREADCRUMB_CATEGORY = "net.http"
+      URI_PARSER = URI.const_defined?("RFC2396_PARSER") ? URI::RFC2396_PARSER : URI::DEFAULT_PARSER
 
       # To explain how the entire thing works, we need to know how the original Net::HTTP#request works
       # Here's part of its definition. As you can see, it usually calls itself inside a #start block
@@ -66,7 +67,7 @@ module Sentry
         # IPv6 url could look like '::1/path', and that won't parse without
         # wrapping it in square brackets.
         hostname = address =~ Resolv::IPv6::Regex ? "[#{address}]" : address
-        uri = req.uri || URI.parse(URI::DEFAULT_PARSER.escape("#{use_ssl? ? 'https' : 'http'}://#{hostname}#{req.path}"))
+        uri = req.uri || URI.parse(URI_PARSER.escape("#{use_ssl? ? 'https' : 'http'}://#{hostname}#{req.path}"))
         url = "#{uri.scheme}://#{uri.host}#{uri.path}" rescue uri.to_s
 
         result = { method: req.method, url: url }

data/lib/sentry/test_helper.rb

@@ -83,5 +83,18 @@ module Sentry
     def extract_sentry_exceptions(event)
       event&.exception&.values || []
     end
+
+    def reset_sentry_globals!
+      Sentry::MUTEX.synchronize do
+        # Don't check initialized? because sometimes we stub it in tests
+        if Sentry.instance_variable_defined?(:@main_hub)
+          Sentry::GLOBALS.each do |var|
+            Sentry.instance_variable_set(:"@#{var}", nil)
+          end
+
+          Thread.current.thread_variable_set(Sentry::THREAD_LOCAL, nil)
+        end
+      end
+    end
   end
 end

data/lib/sentry/transaction.rb

@@ -85,7 +85,11 @@ module Sentry
       @effective_sample_rate = nil
       @contexts = {}
       @measurements = {}
-      @profiler = @configuration.profiler_class.new(@configuration)
+
+      unless @hub.profiler_running?
+        @profiler = @configuration.profiler_class.new(@configuration)
+      end
+
       init_span_recorder
     end
 
@@ -257,7 +261,7 @@ module Sentry
         @name = UNLABELD_NAME
       end
 
-      @profiler.stop
+      @hub.stop_profiler!(self)
 
       if @sampled
         event = hub.current_client.event_from_transaction(self)
@@ -299,6 +303,8 @@ module Sentry
     # Start the profiler.
     # @return [void]
     def start_profiler!
+      return unless profiler
+
       profiler.set_initial_sample_decision(sampled)
       profiler.start
     end

data/lib/sentry/transaction_event.rb

@@ -59,8 +59,11 @@ module Sentry
 
     private
 
+    EMPTY_PROFILE = {}.freeze
+
     def populate_profile(transaction)
-      profile_hash = transaction.profiler.to_hash
+      profile_hash = transaction.profiler&.to_hash || EMPTY_PROFILE
+
       return if profile_hash.empty?
 
       profile_hash.merge!(

data/lib/sentry/transport/http_transport.rb

@@ -23,7 +23,6 @@ module Sentry
       Zlib::BufError, Errno::EHOSTUNREACH, Errno::ECONNREFUSED
     ].freeze
 
-
     def initialize(*args)
       super
       log_debug("Sentry HTTP Transport will connect to #{@dsn.server}") if @dsn

data/lib/sentry/utils/http_tracing.rb

@@ -17,7 +17,7 @@ module Sentry
 
       def record_sentry_breadcrumb(request_info, response_status)
         crumb = Sentry::Breadcrumb.new(
-          level: :info,
+          level: get_level(response_status),
           category: self.class::BREADCRUMB_CATEGORY,
           type: "info",
           data: { status: response_status, **request_info }
@@ -55,6 +55,20 @@ module Sentry
           "#{URI.encode_www_form_component(prefix)}=#{URI.encode_www_form_component(value)}"
         end
       end
+
+      private
+
+      def get_level(status)
+        return :info unless status && status.is_a?(Integer)
+
+if status >= 500
+  :error
+elsif status >= 400
+  :warning
+else
+  :info
+end
+      end
     end
   end
 end

data/lib/sentry/vernier/profiler.rb

@@ -74,6 +74,7 @@ module Sentry
         return unless @started
 
         @result = ::Vernier.stop_profile
+        @started = false
 
         log("Stopped")
       rescue RuntimeError => e
@@ -89,13 +90,13 @@ module Sentry
       end
 
       def to_hash
-        return EMPTY_RESULT unless @started
-
         unless @sampled
           record_lost_event(:sample_rate)
           return EMPTY_RESULT
         end
 
+        return EMPTY_RESULT unless result
+
         { **profile_meta, profile: output.to_h }
       end
 

data/lib/sentry/version.rb

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

data/lib/sentry-ruby.rb

@@ -52,6 +52,14 @@ module Sentry
 
   MUTEX = Mutex.new
 
+  GLOBALS = %i[
+    main_hub
+    session_flusher
+    backpressure_monitor
+    metrics_aggregator
+    exception_locals_tp
+  ].freeze
+
   class << self
     # @!visibility private
     def exception_locals_tp
@@ -232,6 +240,7 @@ module Sentry
       yield(config) if block_given?
       config.detect_release
       apply_patches(config)
+      config.validate
       client = Client.new(config)
       scope = Scope.new(max_breadcrumbs: config.max_breadcrumbs)
       hub = Hub.new(client, scope)
@@ -308,6 +317,9 @@ module Sentry
     # @return [Hub]
     def get_main_hub
       MUTEX.synchronize { @main_hub }
+    rescue ThreadError
+      # In some rare cases this may be called in a trap context so we need to handle it gracefully
+      @main_hub
     end
 
     # Takes an instance of Sentry::Breadcrumb and stores it to the current active scope.
@@ -605,6 +617,11 @@ module Sentry
     def utc_now
       Time.now.utc
     end
+
+    # @!visibility private
+    def dependency_installed?(name)
+      Object.const_defined?(name)
+    end
   end
 end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 5.22.1
+  version: 5.23.0
 platform: ruby
 authors:
 - Sentry Team
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-16 00:00:00.000000000 Z
+date: 2025-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -151,16 +150,15 @@ files:
 - lib/sentry/version.rb
 - sentry-ruby-core.gemspec
 - sentry-ruby.gemspec
-homepage: https://github.com/getsentry/sentry-ruby/tree/5.22.1/sentry-ruby
+homepage: https://github.com/getsentry/sentry-ruby/tree/5.23.0/sentry-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.22.1/sentry-ruby
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.22.1/sentry-ruby
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.22.1/CHANGELOG.md
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.23.0/sentry-ruby
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.23.0/sentry-ruby
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.23.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/5.22.1
-post_install_message: 
+  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/5.23.0
 rdoc_options: []
 require_paths:
 - lib
@@ -175,8 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A gem that provides a client interface for the Sentry error logger
 test_files: []