sentry-ruby-core 5.18.2 → 5.20.0

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

@@ -2,11 +2,14 @@
 
 require "net/http"
 require "resolv"
+require "sentry/utils/http_tracing"
 
 module Sentry
   # @api private
   module Net
     module HTTP
+      include Utils::HttpTracing
+
       OP_NAME = "http.client"
       SPAN_ORIGIN = "auto.http.net_http"
       BREADCRUMB_CATEGORY = "net.http"
@@ -21,8 +24,7 @@ module Sentry
       #       req['connection'] ||= 'close'
       #       return request(req, body, &block) # <- request will be called for the second time from the first call
       #     }
-      #   end
-      #   # .....
+      #   end # .....
       # end
       # ```
       #
@@ -34,44 +36,26 @@ module Sentry
         Sentry.with_child_span(op: OP_NAME, start_timestamp: Sentry.utc_now.to_f, origin: SPAN_ORIGIN) do |sentry_span|
           request_info = extract_request_info(req)
 
-          if propagate_trace?(request_info[:url], Sentry.configuration)
+          if propagate_trace?(request_info[:url])
             set_propagation_headers(req)
           end
 
-          super.tap do |res|
-            record_sentry_breadcrumb(request_info, res)
+          res = super
+          response_status = res.code.to_i
 
-            if sentry_span
-              sentry_span.set_description("#{request_info[:method]} #{request_info[:url]}")
-              sentry_span.set_data(Span::DataConventions::URL, request_info[:url])
-              sentry_span.set_data(Span::DataConventions::HTTP_METHOD, request_info[:method])
-              sentry_span.set_data(Span::DataConventions::HTTP_QUERY, request_info[:query]) if request_info[:query]
-              sentry_span.set_data(Span::DataConventions::HTTP_STATUS_CODE, res.code.to_i)
-            end
+          if record_sentry_breadcrumb?
+            record_sentry_breadcrumb(request_info, response_status)
           end
-        end
-      end
 
-      private
+          if sentry_span
+            set_span_info(sentry_span, request_info, response_status)
+          end
 
-      def set_propagation_headers(req)
-        Sentry.get_trace_propagation_headers&.each { |k, v| req[k] = v }
+          res
+        end
       end
 
-      def record_sentry_breadcrumb(request_info, res)
-        return unless Sentry.initialized? && Sentry.configuration.breadcrumbs_logger.include?(:http_logger)
-
-        crumb = Sentry::Breadcrumb.new(
-          level: :info,
-          category: BREADCRUMB_CATEGORY,
-          type: :info,
-          data: {
-            status: res.code.to_i,
-            **request_info
-          }
-        )
-        Sentry.add_breadcrumb(crumb)
-      end
+      private
 
       def from_sentry_sdk?
         dsn = Sentry.configuration.dsn
@@ -82,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 }
@@ -94,12 +78,6 @@ module Sentry
 
         result
       end
-
-      def propagate_trace?(url, configuration)
-        url &&
-          configuration.propagate_traces &&
-          configuration.trace_propagation_targets.any? { |target| url.match?(target) }
-      end
     end
   end
 end

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

@@ -2,6 +2,7 @@
 
 require "sentry/breadcrumb_buffer"
 require "sentry/propagation_context"
+require "sentry/attachment"
 require "etc"
 
 module Sentry
@@ -22,6 +23,7 @@ module Sentry
       :rack_env,
       :span,
       :session,
+      :attachments,
       :propagation_context
     ]
 
@@ -55,10 +57,12 @@ module Sentry
         event.level = level
         event.breadcrumbs = breadcrumbs
         event.rack_env = rack_env if rack_env
+        event.attachments = attachments
       end
 
       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
@@ -102,6 +106,7 @@ module Sentry
       copy.span = span.deep_dup
       copy.session = session.deep_dup
       copy.propagation_context = propagation_context.deep_dup
+      copy.attachments = attachments.dup
       copy
     end
 
@@ -119,6 +124,7 @@ module Sentry
       self.fingerprint = scope.fingerprint
       self.span = scope.span
       self.propagation_context = scope.propagation_context
+      self.attachments = scope.attachments
     end
 
     # Updates the scope's data from the given options.
@@ -128,6 +134,7 @@ module Sentry
     # @param user [Hash]
     # @param level [String, Symbol]
     # @param fingerprint [Array]
+    # @param attachments [Array<Attachment>]
     # @return [Array]
     def update_from_options(
       contexts: nil,
@@ -136,6 +143,7 @@ module Sentry
       user: nil,
       level: nil,
       fingerprint: nil,
+      attachments: nil,
       **options
     )
       self.contexts.merge!(contexts) if contexts
@@ -283,6 +291,12 @@ module Sentry
       @propagation_context = PropagationContext.new(self, env)
     end
 
+    # Add a new attachment to the scope.
+    def add_attachment(**opts)
+      attachments << (attachment = Attachment.new(**opts))
+      attachment
+    end
+
     protected
 
     # for duplicating scopes internally
@@ -303,6 +317,7 @@ module Sentry
       @rack_env = {}
       @span = nil
       @session = nil
+      @attachments = []
       generate_propagation_context
       set_new_breadcrumb_buffer
     end

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 = {
@@ -192,7 +198,8 @@ module Sentry
         description: @description,
         op: @op,
         status: @status,
-        origin: @origin
+        origin: @origin,
+        data: @data
       }
     end
 

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.