sentry-ruby-core 5.19.0 → 5.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b47e81567b685cb3ad64e889f638f7dd9b97ee8c7cf3e0eee5907c053cf784dc
-  data.tar.gz: 9480a3870fce66342cffae3f818f220658d8f8368c46d481a27a9bbba9f3c8a1
+  metadata.gz: 58924eaaabcd9af00039a761dc76db3fdbfdad597ac5ec274cf5b09121706ffe
+  data.tar.gz: 931128e011f2b359bb00ff3a55e6924dc06cd083fb8944c278a2bac6186af767
 SHA512:
-  metadata.gz: 7afc772277ecf7be43cc029f4cf988585f469f08d1fcfab696bad471a1ddb8269c18f8c946a3af94a8bf4775f93ef9851c57940b05f8c09cb90de812e15f9f6d
-  data.tar.gz: 1f1236a73ed900dc9d38a5448c154dcf4a66ab55eb490528e214f1b3f393a99eccbaa1d303d9c8a3064060b0447c21d6d59f5fdbbcb843203c0e00a4c18adb89
+  metadata.gz: b1a1aa47dcc33056a50e76faaee84a299093441a7994b9f377135a1a172a40f4c581a31ed553873c8ac960eff88d61303c22b98c07772590f36bedd4711b28be
+  data.tar.gz: 86ebfa52b4ddadeb7307985c4312b9ada2c0180be8ff65e2cf3af3eae3b6416403269642fdb4f502baa2f56ebd4e3f63b681e9e47de8b483db460d6f232d43ee

data/lib/sentry/attachment.rb

@@ -8,13 +8,13 @@ module Sentry
 
     def initialize(bytes: nil, filename: nil, content_type: nil, path: nil)
       @bytes = bytes
-      @filename = infer_filename(filename, path)
+      @filename = filename || infer_filename(path)
       @path = path
       @content_type = content_type
     end
 
     def to_envelope_headers
-      { type: 'attachment', filename: filename, content_type: content_type, length: payload.bytesize }
+      { type: "attachment", filename: filename, content_type: content_type, length: payload.bytesize }
     end
 
     def payload
@@ -29,9 +29,7 @@ module Sentry
 
     private
 
-    def infer_filename(filename, path)
-      return filename if filename
-
+    def infer_filename(path)
       if path
         File.basename(path)
       else

data/lib/sentry/backtrace.rb

@@ -80,8 +80,6 @@ module Sentry
       end
     end
 
-    APP_DIRS_PATTERN = /(bin|exe|app|config|lib|test|spec)/.freeze
-
     # holder for an Array of Backtrace::Line instances
     attr_reader :lines
 
@@ -91,7 +89,7 @@ module Sentry
       ruby_lines = backtrace_cleanup_callback.call(ruby_lines) if backtrace_cleanup_callback
 
       in_app_pattern ||= begin
-        Regexp.new("^(#{project_root}/)?#{app_dirs_pattern || APP_DIRS_PATTERN}")
+        Regexp.new("^(#{project_root}/)?#{app_dirs_pattern}")
       end
 
       lines = ruby_lines.to_a.map do |unparsed_line|

data/lib/sentry/baggage.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'cgi'
+require "cgi"
 
 module Sentry
   # A {https://www.w3.org/TR/baggage W3C Baggage Header} implementation.
   class Baggage
-    SENTRY_PREFIX = 'sentry-'
+    SENTRY_PREFIX = "sentry-"
     SENTRY_PREFIX_REGEX = /^sentry-/.freeze
 
     # @return [Hash]
@@ -30,14 +30,14 @@ module Sentry
       items = {}
       mutable = true
 
-      header.split(',').each do |item|
+      header.split(",").each do |item|
         item = item.strip
-        key, val = item.split('=')
+        key, val = item.split("=")
 
         next unless key && val
         next unless key =~ SENTRY_PREFIX_REGEX
 
-        baggage_key = key.split('-')[1]
+        baggage_key = key.split("-")[1]
         next unless baggage_key
 
         items[CGI.unescape(baggage_key)] = CGI.unescape(val)
@@ -64,7 +64,7 @@ module Sentry
     # @return [String]
     def serialize
       items = @items.map { |k, v| "#{SENTRY_PREFIX}#{CGI.escape(k)}=#{CGI.escape(v)}" }
-      items.join(',')
+      items.join(",")
     end
   end
 end

data/lib/sentry/breadcrumb/sentry_logger.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-require 'logger'
+require "logger"
 
 module Sentry
   class Breadcrumb
     module SentryLogger
       LEVELS = {
-        ::Logger::DEBUG => 'debug',
-        ::Logger::INFO => 'info',
-        ::Logger::WARN => 'warn',
-        ::Logger::ERROR => 'error',
-        ::Logger::FATAL => 'fatal'
+        ::Logger::DEBUG => "debug",
+        ::Logger::INFO => "info",
+        ::Logger::WARN => "warn",
+        ::Logger::ERROR => "error",
+        ::Logger::FATAL => "fatal"
       }.freeze
 
       def add(*args, &block)

data/lib/sentry/check_in_event.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'securerandom'
-require 'sentry/cron/monitor_config'
+require "securerandom"
+require "sentry/cron/monitor_config"
 
 module Sentry
   class CheckInEvent < Event
-    TYPE = 'check_in'
+    TYPE = "check_in"
 
     # uuid to identify this check-in.
     # @return [String]
@@ -43,7 +43,7 @@ module Sentry
       self.status = status
       self.duration = duration
       self.monitor_config = monitor_config
-      self.check_in_id = check_in_id || SecureRandom.uuid.delete('-')
+      self.check_in_id = check_in_id || SecureRandom.uuid.delete("-")
     end
 
     # @return [Hash]

data/lib/sentry/client.rb

@@ -30,7 +30,7 @@ module Sentry
       else
         @transport =
           case configuration.dsn&.scheme
-          when 'http', 'https'
+          when "http", "https"
             HTTPTransport.new(configuration)
           else
             DummyTransport.new(configuration)
@@ -49,7 +49,7 @@ module Sentry
       return unless configuration.sending_allowed?
 
       if event.is_a?(ErrorEvent) && !configuration.sample_allowed?
-        transport.record_lost_event(:sample_rate, 'error')
+        transport.record_lost_event(:sample_rate, "error")
         return
       end
 
@@ -64,11 +64,11 @@ module Sentry
       if event.nil?
         log_debug("Discarded event because one of the event processors returned nil")
         transport.record_lost_event(:event_processor, data_category)
-        transport.record_lost_event(:event_processor, 'span', num: spans_before + 1) if is_transaction
+        transport.record_lost_event(:event_processor, "span", num: spans_before + 1) if is_transaction
         return
       elsif is_transaction
         spans_delta = spans_before - event.spans.size
-        transport.record_lost_event(:event_processor, 'span', num: spans_delta) if spans_delta > 0
+        transport.record_lost_event(:event_processor, "span", num: spans_delta) if spans_delta > 0
       end
 
       if async_block = configuration.async
@@ -76,7 +76,7 @@ module Sentry
       elsif configuration.background_worker_threads != 0 && hint.fetch(:background, true)
         unless dispatch_background_event(event, hint)
           transport.record_lost_event(:queue_overflow, data_category)
-          transport.record_lost_event(:queue_overflow, 'span', num: spans_before + 1) if is_transaction
+          transport.record_lost_event(:queue_overflow, "span", num: spans_before + 1) if is_transaction
         end
       else
         send_event(event, hint)
@@ -195,13 +195,13 @@ module Sentry
 
         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)
+          transport.record_lost_event(:before_send, "transaction")
+          transport.record_lost_event(:before_send, "span", num: spans_before + 1)
           return
         else
           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
+          transport.record_lost_event(:before_send, "span", num: spans_delta) if spans_delta > 0
         end
       end
 
@@ -212,7 +212,7 @@ module Sentry
     rescue => e
       log_error("Event sending failed", e, debug: configuration.debug)
       transport.record_lost_event(:network_error, data_category)
-      transport.record_lost_event(:network_error, 'span', num: spans_before + 1) if event.is_a?(TransactionEvent)
+      transport.record_lost_event(:network_error, "span", num: spans_before + 1) if event.is_a?(TransactionEvent)
       raise
     end
 

data/lib/sentry/configuration.rb

@@ -4,6 +4,7 @@ require "concurrent/utility/processor_counter"
 
 require "sentry/utils/exception_cause_chain"
 require 'sentry/utils/custom_inspection'
+require 'sentry/utils/env_helper'
 require "sentry/dsn"
 require "sentry/release_detector"
 require "sentry/transport/configuration"
@@ -22,6 +23,8 @@ module Sentry
     # have an `engines` dir at the root of your project, you may want
     # to set this to something like /(app|config|engines|lib)/
     #
+    # The default is value is /(bin|exe|app|config|lib|test|spec)/
+    #
     # @return [Regexp, nil]
     attr_accessor :app_dirs_pattern
 
@@ -187,6 +190,11 @@ module Sentry
     # @return [String]
     attr_accessor :project_root
 
+    # Whether to strip the load path while constructing the backtrace frame filename.
+    # Defaults to true.
+    # @return [Boolean]
+    attr_accessor :strip_backtrace_load_path
+
     # Insert sentry-trace to outgoing requests' headers
     # @return [Boolean]
     attr_accessor :propagate_traces
@@ -302,18 +310,18 @@ module Sentry
     # But they are mostly considered as noise and should be ignored by default
     # Please see https://github.com/getsentry/sentry-ruby/pull/2026 for more information
     PUMA_IGNORE_DEFAULT = [
-      'Puma::MiniSSL::SSLError',
-      'Puma::HttpParserError',
-      'Puma::HttpParserError501'
+      "Puma::MiniSSL::SSLError",
+      "Puma::HttpParserError",
+      "Puma::HttpParserError501"
     ].freeze
 
     # Most of these errors generate 4XX responses. In general, Sentry clients
     # only automatically report 5xx responses.
     IGNORE_DEFAULT = [
-      'Mongoid::Errors::DocumentNotFound',
-      'Rack::QueryParser::InvalidParameterError',
-      'Rack::QueryParser::ParameterTypeError',
-      'Sinatra::NotFound'
+      "Mongoid::Errors::DocumentNotFound",
+      "Rack::QueryParser::InvalidParameterError",
+      "Rack::QueryParser::ParameterTypeError",
+      "Sinatra::NotFound"
     ].freeze
 
     RACK_ENV_WHITELIST_DEFAULT = %w[
@@ -335,6 +343,8 @@ module Sentry
 
     DEFAULT_PATCHES = %i[redis puma http].freeze
 
+    APP_DIRS_PATTERN = /(bin|exe|app|config|lib|test|spec)/.freeze
+
     class << self
       # Post initialization callbacks are called at the end of initialization process
       # allowing extending the configuration of sentry-ruby by multiple extensions
@@ -349,11 +359,12 @@ module Sentry
     end
 
     def initialize
-      self.app_dirs_pattern = nil
-      self.debug = false
+      self.app_dirs_pattern = APP_DIRS_PATTERN
+      self.debug = Sentry::Utils::EnvHelper.env_to_bool(ENV["SENTRY_DEBUG"])
       self.background_worker_threads = (processor_count / 2.0).ceil
       self.background_worker_max_queue = BackgroundWorker::DEFAULT_MAX_QUEUE
       self.backtrace_cleanup_callback = nil
+      self.strip_backtrace_load_path = true
       self.max_breadcrumbs = BreadcrumbBuffer::DEFAULT_SIZE
       self.breadcrumbs_logger = []
       self.context_lines = 3
@@ -377,7 +388,10 @@ module Sentry
       self.enable_backpressure_handling = false
       self.trusted_proxies = []
       self.dsn = ENV['SENTRY_DSN']
-      self.spotlight = false
+
+      spotlight_env = ENV['SENTRY_SPOTLIGHT']
+      spotlight_bool = Sentry::Utils::EnvHelper.env_to_bool(spotlight_env, strict: true)
+      self.spotlight = spotlight_bool.nil? ? (spotlight_env || false) : spotlight_bool
       self.server_name = server_name_from_env
       self.instrumenter = :sentry
       self.trace_propagation_targets = [PROPAGATION_TARGETS_MATCH_ALL]
@@ -555,7 +569,8 @@ module Sentry
         app_dirs_pattern: @app_dirs_pattern,
         linecache: @linecache,
         context_lines: @context_lines,
-        backtrace_cleanup_callback: @backtrace_cleanup_callback
+        backtrace_cleanup_callback: @backtrace_cleanup_callback,
+        strip_backtrace_load_path: @strip_backtrace_load_path
       )
     end
 
@@ -632,12 +647,12 @@ module Sentry
     end
 
     def environment_from_env
-      ENV['SENTRY_CURRENT_ENV'] || ENV['SENTRY_ENVIRONMENT'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+      ENV["SENTRY_CURRENT_ENV"] || ENV["SENTRY_ENVIRONMENT"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
     end
 
     def server_name_from_env
       if running_on_heroku?
-        ENV['DYNO']
+        ENV["DYNO"]
       else
         # Try to resolve the hostname to an FQDN, but fall back to whatever
         # the load name is.

data/lib/sentry/core_ext/object/deep_dup.rb

@@ -2,7 +2,7 @@
 
 return if Object.method_defined?(:deep_dup)
 
-require 'sentry/core_ext/object/duplicable'
+require "sentry/core_ext/object/duplicable"
 
 #########################################
 #  This file was copied from Rails 5.2  #

data/lib/sentry/cron/monitor_check_ins.rb

@@ -57,7 +57,7 @@ module Sentry
 
         def sentry_monitor_slug(name: self.name)
           @sentry_monitor_slug ||= begin
-            slug = name.gsub('::', '-').downcase
+            slug = name.gsub("::", "-").downcase
             slug[-MAX_SLUG_LENGTH..-1] || slug
           end
         end

data/lib/sentry/cron/monitor_config.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'sentry/cron/monitor_schedule'
+require "sentry/cron/monitor_schedule"
 
 module Sentry
   module Cron

data/lib/sentry/dsn.rb

@@ -4,7 +4,7 @@ require "uri"
 
 module Sentry
   class DSN
-    PORT_MAP = { 'http' => 80, 'https' => 443 }.freeze
+    PORT_MAP = { "http" => 80, "https" => 443 }.freeze
     REQUIRED_ATTRIBUTES = %w[host path public_key project_id].freeze
 
     attr_reader :scheme, :secret_key, :port, *REQUIRED_ATTRIBUTES
@@ -13,7 +13,7 @@ module Sentry
       @raw_value = dsn_string
 
       uri = URI.parse(dsn_string)
-      uri_path = uri.path.split('/')
+      uri_path = uri.path.split("/")
 
       if uri.user
         # DSN-style string
@@ -25,7 +25,7 @@ module Sentry
       @scheme = uri.scheme
       @host = uri.host
       @port = uri.port if uri.port
-      @path = uri_path.join('/')
+      @path = uri_path.join("/")
     end
 
     def valid?

data/lib/sentry/envelope.rb

@@ -15,19 +15,19 @@ module Sentry
       end
 
       def type
-        @headers[:type] || 'event'
+        @headers[:type] || "event"
       end
 
       # rate limits and client reports use the data_category rather than envelope item type
       def self.data_category(type)
         case type
-        when 'session', 'attachment', 'transaction', 'profile', 'span' then type
-        when 'sessions' then 'session'
-        when 'check_in' then 'monitor'
-        when 'statsd', 'metric_meta' then 'metric_bucket'
-        when 'event' then 'error'
-        when 'client_report' then 'internal'
-        else 'default'
+        when "session", "attachment", "transaction", "profile", "span" then type
+        when "sessions" then "session"
+        when "check_in" then "monitor"
+        when "statsd", "metric_meta" then "metric_bucket"
+        when "event" then "error"
+        when "client_report" then "internal"
+        else "default"
         end
       end
 

data/lib/sentry/event.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'socket'
-require 'securerandom'
-require 'sentry/interface'
-require 'sentry/backtrace'
-require 'sentry/utils/real_ip'
-require 'sentry/utils/request_id'
-require 'sentry/utils/custom_inspection'
+require "socket"
+require "securerandom"
+require "sentry/interface"
+require "sentry/backtrace"
+require "sentry/utils/real_ip"
+require "sentry/utils/request_id"
+require "sentry/utils/custom_inspection"
 
 module Sentry
   # This is an abstract class that defines the shared attributes of an event.

data/lib/sentry/graphql.rb

@@ -4,6 +4,6 @@ Sentry.register_patch(:graphql) do |config|
   if defined?(::GraphQL::Schema) && defined?(::GraphQL::Tracing::SentryTrace) && ::GraphQL::Schema.respond_to?(:trace_with)
     ::GraphQL::Schema.trace_with(::GraphQL::Tracing::SentryTrace, set_transaction_name: true)
   else
-    config.logger.warn(Sentry::LOGGER_PROGNAME) { 'You tried to enable the GraphQL integration but no GraphQL gem was detected. Make sure you have the `graphql` gem (>= 2.2.6) in your Gemfile.' }
+    config.logger.warn(Sentry::LOGGER_PROGNAME) { "You tried to enable the GraphQL integration but no GraphQL gem was detected. Make sure you have the `graphql` gem (>= 2.2.6) in your Gemfile." }
   end
 end

data/lib/sentry/hub.rb

@@ -73,7 +73,13 @@ module Sentry
     end
 
     def pop_scope
-      @stack.pop
+      if @stack.size > 1
+        @stack.pop
+      else
+        # We never want to enter a situation where we have no scope and no client
+        client = current_client
+        @stack = [Layer.new(client, Scope.new)]
+      end
     end
 
     def start_transaction(transaction: nil, custom_sampling_context: {}, instrumenter: :sentry, **options)
@@ -214,6 +220,7 @@ module Sentry
     end
 
     def add_breadcrumb(breadcrumb, hint: {})
+      return unless current_client
       return unless configuration.enabled_in_current_env?
 
       if before_breadcrumb = current_client.configuration.before_breadcrumb

data/lib/sentry/interfaces/mechanism.rb

@@ -12,7 +12,7 @@ module Sentry
     # @return [Boolean]
     attr_accessor :handled
 
-    def initialize(type: 'generic', handled: true)
+    def initialize(type: "generic", handled: true)
       @type = type
       @handled = handled
     end

data/lib/sentry/interfaces/request.rb

@@ -59,7 +59,7 @@ module Sentry
         self.query_string = request.query_string
       end
 
-      self.url = request.scheme && request.url.split('?').first
+      self.url = request.scheme && request.url.split("?").first
       self.method = request.request_method
 
       self.headers = filter_and_format_headers(env, send_default_pii)
@@ -85,14 +85,14 @@ module Sentry
       env.each_with_object({}) do |(key, value), memo|
         begin
           key = key.to_s # rack env can contain symbols
-          next memo['X-Request-Id'] ||= Utils::RequestId.read_from(env) if Utils::RequestId::REQUEST_ID_HEADERS.include?(key)
+          next memo["X-Request-Id"] ||= Utils::RequestId.read_from(env) if Utils::RequestId::REQUEST_ID_HEADERS.include?(key)
           next if is_server_protocol?(key, value, env["SERVER_PROTOCOL"])
           next if is_skippable_header?(key)
           next if key == "HTTP_AUTHORIZATION" && !send_default_pii
 
           # Rack stores headers as HTTP_WHAT_EVER, we need What-Ever
           key = key.sub(/^HTTP_/, "")
-          key = key.split('_').map(&:capitalize).join('-')
+          key = key.split("_").map(&:capitalize).join("-")
 
           memo[key] = Utils::EncodingHelper.encode_to_utf_8(value.to_s)
         rescue StandardError => e
@@ -108,7 +108,7 @@ module Sentry
     def is_skippable_header?(key)
       key.upcase != key || # lower-case envs aren't real http headers
         key == "HTTP_COOKIE" || # Cookies don't go here, they go somewhere else
-        !(key.start_with?('HTTP_') || CONTENT_HEADERS.include?(key))
+        !(key.start_with?("HTTP_") || CONTENT_HEADERS.include?(key))
     end
 
     # In versions < 3, Rack adds in an incorrect HTTP_VERSION key, which causes downstream
@@ -120,7 +120,7 @@ module Sentry
       rack_version = Gem::Version.new(::Rack.release)
       return false if rack_version >= Gem::Version.new("3.0")
 
-      key == 'HTTP_VERSION' && value == protocol_version
+      key == "HTTP_VERSION" && value == protocol_version
     end
 
     def filter_and_format_env(env, rack_env_whitelist)

data/lib/sentry/interfaces/single_exception.rb

@@ -26,7 +26,7 @@ module Sentry
 
       @value = Utils::EncodingHelper.encode_to_utf_8(exception_message.byteslice(0..Event::MAX_MESSAGE_SIZE_IN_BYTES))
 
-      @module = exception.class.to_s.split('::')[0...-1].join('::')
+      @module = exception.class.to_s.split("::")[0...-1].join("::")
       @thread_id = Thread.current.object_id
       @stacktrace = stacktrace
       @mechanism = mechanism

data/lib/sentry/interfaces/stacktrace.rb

@@ -27,8 +27,9 @@ module Sentry
       attr_accessor :abs_path, :context_line, :function, :in_app, :filename,
                   :lineno, :module, :pre_context, :post_context, :vars
 
-      def initialize(project_root, line)
+      def initialize(project_root, line, strip_backtrace_load_path = true)
         @project_root = project_root
+        @strip_backtrace_load_path = strip_backtrace_load_path
 
         @abs_path = line.file
         @function = line.method if line.method
@@ -44,6 +45,7 @@ module Sentry
 
       def compute_filename
         return if abs_path.nil?
+        return abs_path unless @strip_backtrace_load_path
 
         prefix =
           if under_project_root? && in_app

data/lib/sentry/interfaces/stacktrace_builder.rb

@@ -17,22 +17,35 @@ module Sentry
     # @return [Proc, nil]
     attr_reader :backtrace_cleanup_callback
 
+    # @return [Boolean]
+    attr_reader :strip_backtrace_load_path
+
     # @param project_root [String]
     # @param app_dirs_pattern [Regexp, nil]
     # @param linecache [LineCache]
     # @param context_lines [Integer, nil]
     # @param backtrace_cleanup_callback [Proc, nil]
+    # @param strip_backtrace_load_path [Boolean]
     # @see Configuration#project_root
     # @see Configuration#app_dirs_pattern
     # @see Configuration#linecache
     # @see Configuration#context_lines
     # @see Configuration#backtrace_cleanup_callback
-    def initialize(project_root:, app_dirs_pattern:, linecache:, context_lines:, backtrace_cleanup_callback: nil)
+    # @see Configuration#strip_backtrace_load_path
+    def initialize(
+      project_root:,
+      app_dirs_pattern:,
+      linecache:,
+      context_lines:,
+      backtrace_cleanup_callback: nil,
+      strip_backtrace_load_path: true
+    )
       @project_root = project_root
       @app_dirs_pattern = app_dirs_pattern
       @linecache = linecache
       @context_lines = context_lines
       @backtrace_cleanup_callback = backtrace_cleanup_callback
+      @strip_backtrace_load_path = strip_backtrace_load_path
     end
 
     # Generates a StacktraceInterface with the given backtrace.
@@ -73,7 +86,7 @@ module Sentry
     private
 
     def convert_parsed_line_into_frame(line)
-      frame = StacktraceInterface::Frame.new(project_root, line)
+      frame = StacktraceInterface::Frame.new(project_root, line, strip_backtrace_load_path)
       frame.set_context(linecache, context_lines) if context_lines
       frame
     end

data/lib/sentry/logger.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'logger'
+require "logger"
 
 module Sentry
   class Logger < ::Logger

data/lib/sentry/metrics/aggregator.rb

@@ -41,8 +41,8 @@ module Sentry
         @stacktrace_builder = configuration.stacktrace_builder
 
         @default_tags = {}
-        @default_tags['release'] = configuration.release if configuration.release
-        @default_tags['environment'] = configuration.environment if configuration.environment
+        @default_tags["release"] = configuration.release if configuration.release
+        @default_tags["environment"] = configuration.environment if configuration.environment
 
         @mutex = Mutex.new
 
@@ -59,7 +59,7 @@ module Sentry
       def add(type,
               key,
               value,
-              unit: 'none',
+              unit: "none",
               tags: {},
               timestamp: nil,
               stacklevel: nil)
@@ -98,7 +98,7 @@ module Sentry
         unless flushable_buckets.empty?
           payload = serialize_buckets(flushable_buckets)
           envelope.add_item(
-            { type: 'statsd', length: payload.bytesize },
+            { type: "statsd", length: payload.bytesize },
             payload
           )
         end
@@ -107,7 +107,7 @@ module Sentry
           code_locations.each do |timestamp, locations|
             payload = serialize_locations(timestamp, locations)
             envelope.add_item(
-              { type: 'metric_meta', content_type: 'application/json' },
+              { type: "metric_meta", content_type: "application/json" },
               payload
             )
           end
@@ -161,8 +161,8 @@ module Sentry
         buckets.map do |timestamp, timestamp_buckets|
           timestamp_buckets.map do |metric_key, metric|
             type, key, unit, tags = metric_key
-            values = metric.serialize.join(':')
-            sanitized_tags = tags.map { |k, v| "#{sanitize_tag_key(k)}:#{sanitize_tag_value(v)}" }.join(',')
+            values = metric.serialize.join(":")
+            sanitized_tags = tags.map { |k, v| "#{sanitize_tag_key(k)}:#{sanitize_tag_value(v)}" }.join(",")
 
             "#{sanitize_key(key)}@#{sanitize_unit(unit)}:#{values}|#{type}|\##{sanitized_tags}|T#{timestamp}"
           end
@@ -175,22 +175,22 @@ module Sentry
           mri = "#{type}:#{sanitize_key(key)}@#{sanitize_unit(unit)}"
 
           # note this needs to be an array but it really doesn't serve a purpose right now
-          [mri, [location.merge(type: 'location')]]
+          [mri, [location.merge(type: "location")]]
         end.to_h
 
         { timestamp: timestamp, mapping: mapping }
       end
 
       def sanitize_key(key)
-        key.gsub(KEY_SANITIZATION_REGEX, '_')
+        key.gsub(KEY_SANITIZATION_REGEX, "_")
       end
 
       def sanitize_unit(unit)
-        unit.gsub(UNIT_SANITIZATION_REGEX, '')
+        unit.gsub(UNIT_SANITIZATION_REGEX, "")
       end
 
       def sanitize_tag_key(key)
-        key.gsub(TAG_KEY_SANITIZATION_REGEX, '')
+        key.gsub(TAG_KEY_SANITIZATION_REGEX, "")
       end
 
       def sanitize_tag_value(value)
@@ -209,7 +209,7 @@ module Sentry
         updated_tags = @default_tags.merge(tags)
 
         transaction_name = get_transaction_name
-        updated_tags['transaction'] = transaction_name if transaction_name
+        updated_tags["transaction"] = transaction_name if transaction_name
 
         updated_tags
       end

data/lib/sentry/metrics/set_metric.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'set'
-require 'zlib'
+require "set"
+require "zlib"
 
 module Sentry
   module Metrics

data/lib/sentry/metrics.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'sentry/metrics/metric'
-require 'sentry/metrics/counter_metric'
-require 'sentry/metrics/distribution_metric'
-require 'sentry/metrics/gauge_metric'
-require 'sentry/metrics/set_metric'
-require 'sentry/metrics/timing'
-require 'sentry/metrics/aggregator'
+require "sentry/metrics/metric"
+require "sentry/metrics/counter_metric"
+require "sentry/metrics/distribution_metric"
+require "sentry/metrics/gauge_metric"
+require "sentry/metrics/set_metric"
+require "sentry/metrics/timing"
+require "sentry/metrics/aggregator"
 
 module Sentry
   module Metrics
@@ -14,32 +14,32 @@ module Sentry
     INFORMATION_UNITS = %w[bit byte kilobyte kibibyte megabyte mebibyte gigabyte gibibyte terabyte tebibyte petabyte pebibyte exabyte exbibyte]
     FRACTIONAL_UNITS = %w[ratio percent]
 
-    OP_NAME = 'metric.timing'
-    SPAN_ORIGIN = 'auto.metric.timing'
+    OP_NAME = "metric.timing"
+    SPAN_ORIGIN = "auto.metric.timing"
 
     class << self
-      def increment(key, value = 1.0, unit: 'none', tags: {}, timestamp: nil)
+      def increment(key, value = 1.0, unit: "none", tags: {}, timestamp: nil)
         Sentry.metrics_aggregator&.add(:c, key, value, unit: unit, tags: tags, timestamp: timestamp)
       end
 
-      def distribution(key, value, unit: 'none', tags: {}, timestamp: nil)
+      def distribution(key, value, unit: "none", tags: {}, timestamp: nil)
         Sentry.metrics_aggregator&.add(:d, key, value, unit: unit, tags: tags, timestamp: timestamp)
       end
 
-      def set(key, value, unit: 'none', tags: {}, timestamp: nil)
+      def set(key, value, unit: "none", tags: {}, timestamp: nil)
         Sentry.metrics_aggregator&.add(:s, key, value, unit: unit, tags: tags, timestamp: timestamp)
       end
 
-      def gauge(key, value, unit: 'none', tags: {}, timestamp: nil)
+      def gauge(key, value, unit: "none", tags: {}, timestamp: nil)
         Sentry.metrics_aggregator&.add(:g, key, value, unit: unit, tags: tags, timestamp: timestamp)
       end
 
-      def timing(key, unit: 'second', tags: {}, timestamp: nil, &block)
+      def timing(key, unit: "second", tags: {}, timestamp: nil, &block)
         return unless block_given?
         return yield unless DURATION_UNITS.include?(unit)
 
         result, value = Sentry.with_child_span(op: OP_NAME, description: key, origin: SPAN_ORIGIN) do |span|
-          tags.each { |k, v| span.set_tag(k, v.is_a?(Array) ? v.join(', ') : v.to_s) } if span
+          tags.each { |k, v| span.set_tag(k, v.is_a?(Array) ? v.join(", ") : v.to_s) } if span
 
           start = Timing.send(unit.to_sym)
           result = yield

data/lib/sentry/net/http.rb

@@ -66,7 +66,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("#{use_ssl? ? 'https' : 'http'}://#{hostname}#{req.path}")
+        uri = req.uri || URI.parse(URI::DEFAULT_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/profiler.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'securerandom'
+require "securerandom"
 
 module Sentry
   class Profiler
-    VERSION = '1'
-    PLATFORM = 'ruby'
+    VERSION = "1"
+    PLATFORM = "ruby"
     # 101 Hz in microseconds
     DEFAULT_INTERVAL = 1e6 / 101
     MICRO_TO_NANO_SECONDS = 1e3
@@ -14,14 +14,14 @@ module Sentry
     attr_reader :sampled, :started, :event_id
 
     def initialize(configuration)
-      @event_id = SecureRandom.uuid.delete('-')
+      @event_id = SecureRandom.uuid.delete("-")
       @started = false
       @sampled = nil
 
       @profiling_enabled = defined?(StackProf) && configuration.profiling_enabled?
       @profiles_sample_rate = configuration.profiles_sample_rate
       @project_root = configuration.project_root
-      @app_dirs_pattern = configuration.app_dirs_pattern || Backtrace::APP_DIRS_PATTERN
+      @app_dirs_pattern = configuration.app_dirs_pattern
       @in_app_pattern = Regexp.new("^(#{@project_root}/)?#{@app_dirs_pattern}")
     end
 
@@ -33,7 +33,7 @@ module Sentry
                                  raw: true,
                                  aggregate: false)
 
-      @started ? log('Started') : log('Not started since running elsewhere')
+      @started ? log("Started") : log("Not started since running elsewhere")
     end
 
     def stop
@@ -41,7 +41,7 @@ module Sentry
       return unless @started
 
       StackProf.stop
-      log('Stopped')
+      log("Stopped")
     end
 
     # Sets initial sampling decision of the profile.
@@ -54,14 +54,14 @@ module Sentry
 
       unless transaction_sampled
         @sampled = false
-        log('Discarding profile because transaction not sampled')
+        log("Discarding profile because transaction not sampled")
         return
       end
 
       case @profiles_sample_rate
       when 0.0
         @sampled = false
-        log('Discarding profile because sample_rate is 0')
+        log("Discarding profile because sample_rate is 0")
         return
       when 1.0
         @sampled = true
@@ -70,7 +70,7 @@ module Sentry
         @sampled = Random.rand < @profiles_sample_rate
       end
 
-      log('Discarding profile due to sampling decision') unless @sampled
+      log("Discarding profile due to sampling decision") unless @sampled
     end
 
     def to_hash
@@ -90,13 +90,12 @@ module Sentry
 
       frame_map = {}
 
-      frames = results[:frames].to_enum.with_index.map do |frame, idx|
-        frame_id, frame_data = frame
-
+      frames = results[:frames].map.with_index do |(frame_id, frame_data), idx|
         # need to map over stackprof frame ids to ours
         frame_map[frame_id] = idx
 
         file_path = frame_data[:file]
+        lineno = frame_data[:line]
         in_app = in_app?(file_path)
         filename = compute_filename(file_path, in_app)
         function, mod = split_module(frame_data[:name])
@@ -109,7 +108,7 @@ module Sentry
         }
 
         frame_hash[:module] = mod if mod
-        frame_hash[:lineno] = frame_data[:line] if frame_data[:line] && frame_data[:line] >= 0
+        frame_hash[:lineno] = lineno if lineno && lineno >= 0
 
         frame_hash
       end
@@ -130,7 +129,7 @@ module Sentry
         num_seen << results[:raw][idx + len]
         idx += len + 1
 
-        log('Unknown frame in stack') if stack.size != len
+        log("Unknown frame in stack") if stack.size != len
       end
 
       idx = 0
@@ -155,16 +154,16 @@ module Sentry
             # Till then, on multi-threaded servers like puma, we will get frames from other active threads when the one
             # we're profiling is idle/sleeping/waiting for IO etc.
             # https://bugs.ruby-lang.org/issues/10602
-            thread_id: '0',
+            thread_id: "0",
             elapsed_since_start_ns: elapsed_since_start_ns.to_s
           }
         end
       end
 
-      log('Some samples thrown away') if samples.size != results[:samples]
+      log("Some samples thrown away") if samples.size != results[:samples]
 
       if samples.size <= MIN_SAMPLES_REQUIRED
-        log('Not enough samples, discarding profiler')
+        log("Not enough samples, discarding profiler")
         record_lost_event(:insufficient_data)
         return {}
       end
@@ -219,7 +218,7 @@ module Sentry
 
     def split_module(name)
       # last module plus class/instance method
-      i = name.rindex('::')
+      i = name.rindex("::")
       function = i ? name[(i + 2)..-1] : name
       mod = i ? name[0...i] : nil
 
@@ -227,7 +226,7 @@ module Sentry
     end
 
     def record_lost_event(reason)
-      Sentry.get_current_client&.transport&.record_lost_event(reason, 'profile')
+      Sentry.get_current_client&.transport&.record_lost_event(reason, "profile")
     end
   end
 end

data/lib/sentry/propagation_context.rb

@@ -108,7 +108,7 @@ module Sentry
     end
 
     # Returns the Dynamic Sampling Context from the baggage.
-    # @return [String, nil]
+    # @return [Hash, nil]
     def get_dynamic_sampling_context
       get_baggage&.dynamic_sampling_context
     end

data/lib/sentry/rack/capture_exceptions.rb

@@ -50,7 +50,7 @@ module Sentry
       private
 
       def collect_exception(env)
-        env['rack.exception'] || env['sinatra.error']
+        env["rack.exception"] || env["sinatra.error"]
       end
 
       def transaction_op

data/lib/sentry/rack.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-require 'rack'
+require "rack"
 
-require 'sentry/rack/capture_exceptions'
+require "sentry/rack/capture_exceptions"

data/lib/sentry/rake.rb

@@ -8,10 +8,10 @@ module Sentry
     module Application
       # @api private
       def display_error_message(ex)
-        mechanism = Sentry::Mechanism.new(type: 'rake', handled: false)
+        mechanism = Sentry::Mechanism.new(type: "rake", handled: false)
 
         Sentry.capture_exception(ex, hint: { mechanism: mechanism }) do |scope|
-          task_name = top_level_tasks.join(' ')
+          task_name = top_level_tasks.join(" ")
           scope.set_transaction_name(task_name, source: :task)
           scope.set_tag("rake_task", task_name)
         end if Sentry.initialized? && !Sentry.configuration.skip_rake_integration

data/lib/sentry/release_detector.rb

@@ -13,12 +13,12 @@ module Sentry
 
       def detect_release_from_heroku(running_on_heroku)
         return unless running_on_heroku
-        ENV['HEROKU_SLUG_COMMIT']
+        ENV["HEROKU_SLUG_COMMIT"]
       end
 
       def detect_release_from_capistrano(project_root)
-        revision_file = File.join(project_root, 'REVISION')
-        revision_log = File.join(project_root, '..', 'revisions.log')
+        revision_file = File.join(project_root, "REVISION")
+        revision_log = File.join(project_root, "..", "revisions.log")
 
         if File.exist?(revision_file)
           File.read(revision_file).strip
@@ -32,7 +32,7 @@ module Sentry
       end
 
       def detect_release_from_env
-        ENV['SENTRY_RELEASE']
+        ENV["SENTRY_RELEASE"]
       end
     end
   end

data/lib/sentry/scope.rb

@@ -62,6 +62,7 @@ module Sentry
 
       if span
         event.contexts[:trace] ||= span.get_trace_context
+        event.dynamic_sampling_context ||= span.get_dynamic_sampling_context
       else
         event.contexts[:trace] ||= propagation_context.get_trace_context
         event.dynamic_sampling_context ||= propagation_context.get_dynamic_sampling_context

data/lib/sentry/session_flusher.rb

@@ -44,7 +44,7 @@ module Sentry
     def pending_envelope
       envelope = Envelope.new
 
-      header = { type: 'sessions' }
+      header = { type: "sessions" }
       payload = { attrs: attrs, aggregates: @pending_aggregates.values }
 
       envelope.add_item(header, payload)

data/lib/sentry/span.rb

@@ -160,6 +160,12 @@ module Sentry
       transaction.get_baggage&.serialize
     end
 
+    # Returns the Dynamic Sampling Context from the transaction baggage.
+    # @return [Hash, nil]
+    def get_dynamic_sampling_context
+      transaction.get_baggage&.dynamic_sampling_context
+    end
+
     # @return [Hash]
     def to_hash
       hash = {

data/lib/sentry/test_helper.rb

@@ -1,6 +1,6 @@
 module Sentry
   module TestHelper
-    DUMMY_DSN = 'http://12345:67890@sentry.localdomain/sentry/42'
+    DUMMY_DSN = "http://12345:67890@sentry.localdomain/sentry/42"
 
     # Alters the existing SDK configuration with test-suitable options. Mainly:
     # - Sets a dummy DSN instead of `nil` or an actual DSN.

data/lib/sentry/transaction.rb

@@ -265,8 +265,8 @@ module Sentry
       else
         is_backpressure = Sentry.backpressure_monitor&.downsample_factor&.positive?
         reason = is_backpressure ? :backpressure : :sample_rate
-        hub.current_client.transport.record_lost_event(reason, 'transaction')
-        hub.current_client.transport.record_lost_event(reason, 'span')
+        hub.current_client.transport.record_lost_event(reason, "transaction")
+        hub.current_client.transport.record_lost_event(reason, "span")
       end
     end
 

data/lib/sentry/transaction_event.rb

@@ -75,7 +75,7 @@ module Sentry
           name: transaction.name,
           trace_id: transaction.trace_id,
           # TODO-neel-profiler stubbed for now, see thread_id note in profiler.rb
-          active_thead_id: '0'
+          active_thead_id: "0"
         }
       )
 

data/lib/sentry/transport/http_transport.rb

@@ -7,7 +7,7 @@ module Sentry
   class HTTPTransport < Transport
     GZIP_ENCODING = "gzip"
     GZIP_THRESHOLD = 1024 * 30
-    CONTENT_TYPE = 'application/x-sentry-envelope'
+    CONTENT_TYPE = "application/x-sentry-envelope"
 
     DEFAULT_DELAY = 60
     RETRY_AFTER_HEADER = "retry-after"
@@ -38,13 +38,13 @@ module Sentry
       end
 
       headers = {
-        'Content-Type' => CONTENT_TYPE,
-        'Content-Encoding' => encoding,
-        'User-Agent' => USER_AGENT
+        "Content-Type" => CONTENT_TYPE,
+        "Content-Encoding" => encoding,
+        "User-Agent" => USER_AGENT
       }
 
       auth_header = generate_auth_header
-      headers['X-Sentry-Auth'] = auth_header if auth_header
+      headers["X-Sentry-Auth"] = auth_header if auth_header
 
       response = conn.start do |http|
         request = ::Net::HTTP::Post.new(endpoint, headers)
@@ -60,7 +60,7 @@ module Sentry
       else
         error_info = "the server responded with status #{response.code}"
         error_info += "\nbody: #{response.body}"
-        error_info += " Error in headers is: #{response['x-sentry-error']}" if response['x-sentry-error']
+        error_info += " Error in headers is: #{response['x-sentry-error']}" if response["x-sentry-error"]
 
         raise Sentry::ExternalError, error_info
       end
@@ -78,13 +78,13 @@ module Sentry
 
       now = Sentry.utc_now.to_i
       fields = {
-        'sentry_version' => PROTOCOL_VERSION,
-        'sentry_client' => USER_AGENT,
-        'sentry_timestamp' => now,
-        'sentry_key' => @dsn.public_key
+        "sentry_version" => PROTOCOL_VERSION,
+        "sentry_client" => USER_AGENT,
+        "sentry_timestamp" => now,
+        "sentry_key" => @dsn.public_key
       }
-      fields['sentry_secret'] = @dsn.secret_key if @dsn.secret_key
-      'Sentry ' + fields.map { |key, value| "#{key}=#{value}" }.join(', ')
+      fields["sentry_secret"] = @dsn.secret_key if @dsn.secret_key
+      "Sentry " + fields.map { |key, value| "#{key}=#{value}" }.join(", ")
     end
 
     def conn

data/lib/sentry/transport.rb

@@ -5,7 +5,7 @@ require "sentry/envelope"
 
 module Sentry
   class Transport
-    PROTOCOL_VERSION = '7'
+    PROTOCOL_VERSION = "7"
     USER_AGENT = "sentry-ruby/#{Sentry::VERSION}"
     CLIENT_REPORT_INTERVAL = 30
 
@@ -134,13 +134,13 @@ module Sentry
       envelope = Envelope.new(envelope_headers)
 
       envelope.add_item(
-        { type: item_type, content_type: 'application/json' },
+        { type: item_type, content_type: "application/json" },
         event_payload
       )
 
       if event.is_a?(TransactionEvent) && event.profile
         envelope.add_item(
-          { type: 'profile', content_type: 'application/json' },
+          { type: "profile", content_type: "application/json" },
           event.profile
         )
       end
@@ -185,7 +185,7 @@ module Sentry
         { reason: reason, category: category, quantity: val }
       end
 
-      item_header = { type: 'client_report' }
+      item_header = { type: "client_report" }
       item_payload = {
         timestamp: Sentry.utc_now.iso8601,
         discarded_events: discarded_events_hash

data/lib/sentry/utils/env_helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Sentry
+  module Utils
+    module EnvHelper
+      TRUTHY_ENV_VALUES = %w[t true yes y 1 on].freeze
+      FALSY_ENV_VALUES = %w[f false no n 0 off].freeze
+
+      def self.env_to_bool(value, strict: false)
+        value = value.to_s
+        normalized = value.downcase
+
+        return false if FALSY_ENV_VALUES.include?(normalized)
+
+        return true if TRUTHY_ENV_VALUES.include?(normalized)
+
+        strict ? nil : !(value.nil? || value.empty?)
+      end
+    end
+  end
+end

data/lib/sentry/utils/real_ip.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'ipaddr'
+require "ipaddr"
 
 # Based on ActionDispatch::RemoteIp. All security-related precautions from that
 # middleware have been removed, because the Event IP just needs to be accurate,

data/lib/sentry/version.rb

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

data/lib/sentry-ruby.rb

@@ -563,7 +563,7 @@ module Sentry
     #
     # @return [String]
     def get_trace_propagation_meta
-      return '' unless initialized?
+      return "" unless initialized?
       get_current_hub.get_trace_propagation_meta
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby-core
 version: !ruby/object:Gem::Version
-  version: 5.19.0
+  version: 5.20.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-13 00:00:00.000000000 Z
+date: 2024-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sentry-ruby
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.19.0
+        version: 5.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.19.0
+        version: 5.20.0
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +129,7 @@ files:
 - lib/sentry/utils/argument_checking_helper.rb
 - lib/sentry/utils/custom_inspection.rb
 - lib/sentry/utils/encoding_helper.rb
+- lib/sentry/utils/env_helper.rb
 - lib/sentry/utils/exception_cause_chain.rb
 - lib/sentry/utils/http_tracing.rb
 - lib/sentry/utils/logging_helper.rb
@@ -159,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.16
 signing_key: 
 specification_version: 4
 summary: A gem that provides a client interface for the Sentry error logger