sentry-ruby 5.22.3 → 5.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6efd6e1590191762ede29567335f21b5e54ff63bb85c26e586ecc5e3ce8c5f2a
-  data.tar.gz: d7758ef8b065a2b772ccebec8eee4807683a002495ca55dab7e85f8c1b92768f
+  metadata.gz: '09ca0c97390e688d58572ffe3ae022523a1003a48ccea319857b302b3e1ebb95'
+  data.tar.gz: 28f154fb38f21c50090dc8ae3c2bc7b335f288a298e97d934a24db1b8e7ac372
 SHA512:
-  metadata.gz: 126c7238fb1dbd17f80986824bbd73eab5fba5a70b1f39a87cc59ff7fafb52474b3eb5b9b8043af03b3049acdf2ac1b322c572c652edee015aa7cabeb1d5c61a
-  data.tar.gz: 5f6777c874b1544eab2e47359d61d1eb6cd725b6f1788e2595815e8340d1291e7da7632373c77635ebe717e8c75537a9157a0a904a90bdc1b518fb9819adb0e8
+  metadata.gz: 5f170fe27327a1753f4a6f2d62b5a694f30c91f1f86c4e2caa837d70467298ea2af261475a2da1045e3513257f3a9be4bb66a0c2e0dba271e43a1478ecd42c0b
+  data.tar.gz: 32a7f13e8eee4f7c8958dfd1a083aecf7ee306fec695703c5dbeff810e4ae5ebd84a1435e7edaef8a61d94eaf64910442422d2142007d77c5be31080ad32f244

data/Gemfile

@@ -3,6 +3,8 @@
 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"]
@@ -27,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/lib/sentry/backtrace.rb

@@ -16,7 +16,7 @@ module Sentry
       /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

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

@@ -184,7 +184,7 @@ module Sentry
         event = configuration.before_send.call(event, hint)
 
         case event
-        when ErrorEvent
+        when ErrorEvent, CheckInEvent
           # do nothing
         when Hash
           log_debug(<<~MSG)

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/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/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.3"
+  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)
@@ -608,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,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 5.22.3
+  version: 5.23.0
 platform: ruby
 authors:
 - Sentry Team
 bindir: bin
 cert_chain: []
-date: 2025-01-29 00:00:00.000000000 Z
+date: 2025-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -150,15 +150,15 @@ files:
 - lib/sentry/version.rb
 - sentry-ruby-core.gemspec
 - sentry-ruby.gemspec
-homepage: https://github.com/getsentry/sentry-ruby/tree/5.22.3/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.3/sentry-ruby
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.22.3/sentry-ruby
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.22.3/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.3
+  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/5.23.0
 rdoc_options: []
 require_paths:
 - lib