sentry-ruby 5.13.0 → 5.19.0

data/lib/sentry/propagation_context.rb

@@ -50,14 +50,15 @@ module Sentry
           if sentry_trace_data
             @trace_id, @parent_span_id, @parent_sampled = sentry_trace_data
 
-            @baggage = if baggage_header && !baggage_header.empty?
-                        Baggage.from_incoming_header(baggage_header)
-                      else
-                        # If there's an incoming sentry-trace but no incoming baggage header,
-                        # for instance in traces coming from older SDKs,
-                        # baggage will be empty and frozen and won't be populated as head SDK.
-                        Baggage.new({})
-                      end
+            @baggage =
+              if baggage_header && !baggage_header.empty?
+                Baggage.from_incoming_header(baggage_header)
+              else
+                # If there's an incoming sentry-trace but no incoming baggage header,
+                # for instance in traces coming from older SDKs,
+                # baggage will be empty and frozen and won't be populated as head SDK.
+                Baggage.new({})
+              end
 
             @baggage.freeze!
             @incoming_trace = true

data/lib/sentry/puma.rb

@@ -7,7 +7,7 @@ module Sentry
     module Server
       PUMA_4_AND_PRIOR = Gem::Version.new(::Puma::Const::PUMA_VERSION) < Gem::Version.new("5.0.0")
 
-      def lowlevel_error(e, env, status=500)
+      def lowlevel_error(e, env, status = 500)
         result =
           if PUMA_4_AND_PRIOR
             super(e, env)

data/lib/sentry/rack/capture_exceptions.rb

@@ -4,6 +4,8 @@ module Sentry
   module Rack
     class CaptureExceptions
       ERROR_EVENT_ID_KEY = "sentry.error_event_id"
+      MECHANISM_TYPE = "rack"
+      SPAN_ORIGIN = "auto.http.rack"
 
       def initialize(app)
         @app = app
@@ -56,13 +58,19 @@ module Sentry
       end
 
       def capture_exception(exception, env)
-        Sentry.capture_exception(exception).tap do |event|
+        Sentry.capture_exception(exception, hint: { mechanism: mechanism }).tap do |event|
           env[ERROR_EVENT_ID_KEY] = event.event_id if event
         end
       end
 
       def start_transaction(env, scope)
-        options = { name: scope.transaction_name, source: scope.transaction_source, op: transaction_op }
+        options = {
+          name: scope.transaction_name,
+          source: scope.transaction_source,
+          op: transaction_op,
+          origin: SPAN_ORIGIN
+        }
+
         transaction = Sentry.continue_trace(env, **options)
         Sentry.start_transaction(transaction: transaction, custom_sampling_context: { env: env }, **options)
       end
@@ -74,6 +82,10 @@ module Sentry
         transaction.set_http_status(status_code)
         transaction.finish
       end
+
+      def mechanism
+        Sentry::Mechanism.new(type: MECHANISM_TYPE, handled: false)
+      end
     end
   end
 end

data/lib/sentry/rake.rb

@@ -8,7 +8,9 @@ module Sentry
     module Application
       # @api private
       def display_error_message(ex)
-        Sentry.capture_exception(ex) do |scope|
+        mechanism = Sentry::Mechanism.new(type: 'rake', handled: false)
+
+        Sentry.capture_exception(ex, hint: { mechanism: mechanism }) do |scope|
           task_name = top_level_tasks.join(' ')
           scope.set_transaction_name(task_name, source: :task)
           scope.set_tag("rake_task", task_name)
@@ -17,15 +19,6 @@ module Sentry
         super
       end
     end
-
-    module Task
-      # @api private
-      def execute(args=nil)
-        return super unless Sentry.initialized? && Sentry.get_current_hub
-
-        super
-      end
-    end
   end
 end
 
@@ -34,8 +27,4 @@ module Rake
   class Application
     prepend(Sentry::Rake::Application)
   end
-
-  class Task
-    prepend(Sentry::Rake::Task)
-  end
 end

data/lib/sentry/redis.rb

@@ -4,6 +4,7 @@ module Sentry
   # @api private
   class Redis
     OP_NAME = "db.redis"
+    SPAN_ORIGIN = "auto.db.redis"
     LOGGER_NAME = :redis_logger
 
     def initialize(commands, host, port, db)
@@ -13,7 +14,7 @@ module Sentry
     def instrument
       return yield unless Sentry.initialized?
 
-      Sentry.with_child_span(op: OP_NAME, start_timestamp: Sentry.utc_now.to_f) do |span|
+      Sentry.with_child_span(op: OP_NAME, start_timestamp: Sentry.utc_now.to_f, origin: SPAN_ORIGIN) do |span|
         yield.tap do
           record_breadcrumb
 

data/lib/sentry/release_detector.rb

@@ -28,7 +28,7 @@ module Sentry
       end
 
       def detect_release_from_git
-        Sentry.sys_command("git rev-parse --short HEAD") if File.directory?(".git")
+        Sentry.sys_command("git rev-parse HEAD") if File.directory?(".git")
       end
 
       def detect_release_from_env

data/lib/sentry/scope.rb

@@ -2,6 +2,7 @@
 
 require "sentry/breadcrumb_buffer"
 require "sentry/propagation_context"
+require "sentry/attachment"
 require "etc"
 
 module Sentry
@@ -9,8 +10,8 @@ module Sentry
     include ArgumentCheckingHelper
 
     ATTRIBUTES = [
-      :transaction_names,
-      :transaction_sources,
+      :transaction_name,
+      :transaction_source,
       :contexts,
       :extra,
       :tags,
@@ -22,6 +23,7 @@ module Sentry
       :rack_env,
       :span,
       :session,
+      :attachments,
       :propagation_context
     ]
 
@@ -44,12 +46,19 @@ module Sentry
     # @param hint [Hash] the hint data that'll be passed to event processors.
     # @return [Event]
     def apply_to_event(event, hint = nil)
-      event.tags = tags.merge(event.tags)
-      event.user = user.merge(event.user)
-      event.extra = extra.merge(event.extra)
-      event.contexts = contexts.merge(event.contexts)
-      event.transaction = transaction_name if transaction_name
-      event.transaction_info = { source: transaction_source } if transaction_source
+      unless event.is_a?(CheckInEvent)
+        event.tags = tags.merge(event.tags)
+        event.user = user.merge(event.user)
+        event.extra = extra.merge(event.extra)
+        event.contexts = contexts.merge(event.contexts)
+        event.transaction = transaction_name if transaction_name
+        event.transaction_info = { source: transaction_source } if transaction_source
+        event.fingerprint = fingerprint
+        event.level = level
+        event.breadcrumbs = breadcrumbs
+        event.rack_env = rack_env if rack_env
+        event.attachments = attachments
+      end
 
       if span
         event.contexts[:trace] ||= span.get_trace_context
@@ -58,11 +67,6 @@ module Sentry
         event.dynamic_sampling_context ||= propagation_context.get_dynamic_sampling_context
       end
 
-      event.fingerprint = fingerprint
-      event.level = level
-      event.breadcrumbs = breadcrumbs
-      event.rack_env = rack_env if rack_env
-
       all_event_processors = self.class.global_event_processors + @event_processors
 
       unless all_event_processors.empty?
@@ -95,12 +99,13 @@ module Sentry
       copy.extra = extra.deep_dup
       copy.tags = tags.deep_dup
       copy.user = user.deep_dup
-      copy.transaction_names = transaction_names.dup
-      copy.transaction_sources = transaction_sources.dup
+      copy.transaction_name = transaction_name.dup
+      copy.transaction_source = transaction_source.dup
       copy.fingerprint = fingerprint.deep_dup
       copy.span = span.deep_dup
       copy.session = session.deep_dup
       copy.propagation_context = propagation_context.deep_dup
+      copy.attachments = attachments.dup
       copy
     end
 
@@ -113,11 +118,12 @@ module Sentry
       self.extra = scope.extra
       self.tags = scope.tags
       self.user = scope.user
-      self.transaction_names = scope.transaction_names
-      self.transaction_sources = scope.transaction_sources
+      self.transaction_name = scope.transaction_name
+      self.transaction_source = scope.transaction_source
       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.
@@ -127,14 +133,17 @@ module Sentry
     # @param user [Hash]
     # @param level [String, Symbol]
     # @param fingerprint [Array]
-    # @return [void]
+    # @param attachments [Array<Attachment>]
+    # @return [Array]
     def update_from_options(
       contexts: nil,
       extra: nil,
       tags: nil,
       user: nil,
       level: nil,
-      fingerprint: nil
+      fingerprint: nil,
+      attachments: nil,
+      **options
     )
       self.contexts.merge!(contexts) if contexts
       self.extra.merge!(extra) if extra
@@ -142,6 +151,9 @@ module Sentry
       self.user = user if user
       self.level = level if level
       self.fingerprint = fingerprint if fingerprint
+
+      # Returns unsupported option keys so we can notify users.
+      options.keys
     end
 
     # Sets the scope's rack_env attribute.
@@ -226,8 +238,8 @@ module Sentry
     # @param transaction_name [String]
     # @return [void]
     def set_transaction_name(transaction_name, source: :custom)
-      @transaction_names << transaction_name
-      @transaction_sources << source
+      @transaction_name = transaction_name
+      @transaction_source = source
     end
 
     # Sets the currently active session on the scope.
@@ -237,18 +249,10 @@ module Sentry
       @session = session
     end
 
-    # Returns current transaction name.
-    # The "transaction" here does not refer to `Transaction` objects.
-    # @return [String, nil]
-    def transaction_name
-      @transaction_names.last
-    end
-
-    # Returns current transaction source.
-    # The "transaction" here does not refer to `Transaction` objects.
-    # @return [String, nil]
-    def transaction_source
-      @transaction_sources.last
+    # These are high cardinality and thus bad.
+    # @return [Boolean]
+    def transaction_source_low_quality?
+      transaction_source == :url
     end
 
     # Returns the associated Transaction object.
@@ -286,6 +290,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
@@ -294,18 +304,19 @@ module Sentry
     private
 
     def set_default_value
-      @contexts = { :os => self.class.os_context, :runtime => self.class.runtime_context }
+      @contexts = { os: self.class.os_context, runtime: self.class.runtime_context }
       @extra = {}
       @tags = {}
       @user = {}
       @level = :error
       @fingerprint = []
-      @transaction_names = []
-      @transaction_sources = []
+      @transaction_name = nil
+      @transaction_source = nil
       @event_processors = []
       @rack_env = {}
       @span = nil
       @session = nil
+      @attachments = []
       generate_propagation_context
       set_new_breadcrumb_buffer
     end
@@ -354,6 +365,5 @@ module Sentry
         global_event_processors << block
       end
     end
-
   end
 end

data/lib/sentry/session.rb

@@ -5,8 +5,8 @@ module Sentry
     attr_reader :started, :status, :aggregation_key
 
     # TODO-neel add :crashed after adding handled mechanism
-    STATUSES = %i(ok errored exited)
-    AGGREGATE_STATUSES = %i(errored exited)
+    STATUSES = %i[ok errored exited]
+    AGGREGATE_STATUSES = %i[errored exited]
 
     def initialize
       @started = Sentry.utc_now

data/lib/sentry/session_flusher.rb

@@ -1,58 +1,38 @@
 # frozen_string_literal: true
 
 module Sentry
-  class SessionFlusher
-    include LoggingHelper
-
+  class SessionFlusher < ThreadedPeriodicWorker
     FLUSH_INTERVAL = 60
 
     def initialize(configuration, client)
-      @thread = nil
-      @exited = false
+      super(configuration.logger, FLUSH_INTERVAL)
       @client = client
       @pending_aggregates = {}
       @release = configuration.release
       @environment = configuration.environment
-      @logger = configuration.logger
 
       log_debug("[Sessions] Sessions won't be captured without a valid release") unless @release
     end
 
     def flush
       return if @pending_aggregates.empty?
-      envelope = pending_envelope
-
-      Sentry.background_worker.perform do
-        @client.transport.send_envelope(envelope)
-      end
 
+      @client.capture_envelope(pending_envelope)
       @pending_aggregates = {}
     end
 
+    alias_method :run, :flush
+
     def add_session(session)
-      return if @exited
       return unless @release
 
-      begin
-        ensure_thread
-      rescue ThreadError
-        log_debug("Session flusher thread creation failed")
-        @exited = true
-        return
-      end
+      return unless ensure_thread
 
       return unless Session::AGGREGATE_STATUSES.include?(session.status)
       @pending_aggregates[session.aggregation_key] ||= init_aggregates(session.aggregation_key)
       @pending_aggregates[session.aggregation_key][session.status] += 1
     end
 
-    def kill
-      log_debug("Killing session flusher")
-
-      @exited = true
-      @thread&.kill
-    end
-
     private
 
     def init_aggregates(aggregation_key)
@@ -74,17 +54,5 @@ module Sentry
     def attrs
       { release: @release, environment: @environment }
     end
-
-    def ensure_thread
-      return if @thread&.alive?
-
-      @thread = Thread.new do
-        loop do
-          sleep(FLUSH_INTERVAL)
-          flush
-        end
-      end
-    end
-
   end
 end

data/lib/sentry/span.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require "securerandom"
+require "sentry/metrics/local_aggregator"
 
 module Sentry
   class Span
-
     # We will try to be consistent with OpenTelemetry on this front going forward.
     # https://develop.sentry.dev/sdk/performance/span-data-conventions/
     module DataConventions
@@ -39,6 +39,11 @@ module Sentry
       # Recommended: If different than server.port.
       # Example: 16456
       SERVER_SOCKET_PORT = "server.socket.port"
+
+      FILEPATH = "code.filepath"
+      LINENO = "code.lineno"
+      FUNCTION = "code.function"
+      NAMESPACE = "code.namespace"
     end
 
     STATUS_MAP = {
@@ -55,6 +60,8 @@ module Sentry
       504 => "deadline_exceeded"
     }
 
+    DEFAULT_SPAN_ORIGIN = "manual"
+
     # An uuid that can be used to identify a trace.
     # @return [String]
     attr_reader :trace_id
@@ -88,6 +95,9 @@ module Sentry
     # Span data
     # @return [Hash]
     attr_reader :data
+    # Span origin that tracks what kind of instrumentation created a span
+    # @return [String]
+    attr_reader :origin
 
     # The SpanRecorder the current span belongs to.
     # SpanRecorder holds all spans under the same Transaction object (including the Transaction itself).
@@ -109,7 +119,8 @@ module Sentry
       parent_span_id: nil,
       sampled: nil,
       start_timestamp: nil,
-      timestamp: nil
+      timestamp: nil,
+      origin: nil
     )
       @trace_id = trace_id || SecureRandom.uuid.delete("-")
       @span_id = span_id || SecureRandom.uuid.delete("-").slice(0, 16)
@@ -123,6 +134,7 @@ module Sentry
       @status = status
       @data = {}
       @tags = {}
+      @origin = origin || DEFAULT_SPAN_ORIGIN
     end
 
     # Finishes the span by adding a timestamp.
@@ -150,7 +162,7 @@ module Sentry
 
     # @return [Hash]
     def to_hash
-      {
+      hash = {
         trace_id: @trace_id,
         span_id: @span_id,
         parent_span_id: @parent_span_id,
@@ -160,8 +172,14 @@ module Sentry
         op: @op,
         status: @status,
         tags: @tags,
-        data: @data
+        data: @data,
+        origin: @origin
       }
+
+      summary = metrics_summary
+      hash[:_metrics_summary] = summary if summary
+
+      hash
     end
 
     # Returns the span's context that can be used to embed in an Event.
@@ -173,7 +191,9 @@ module Sentry
         parent_span_id: @parent_span_id,
         description: @description,
         op: @op,
-        status: @status
+        status: @status,
+        origin: @origin,
+        data: @data
       }
     end
 
@@ -269,5 +289,20 @@ module Sentry
     def set_tag(key, value)
       @tags[key] = value
     end
+
+    # Sets the origin of the span.
+    # @param origin [String]
+    def set_origin(origin)
+      @origin = origin
+    end
+
+    # Collects gauge metrics on the span for metric summaries.
+    def metrics_local_aggregator
+      @metrics_local_aggregator ||= Sentry::Metrics::LocalAggregator.new
+    end
+
+    def metrics_summary
+      @metrics_local_aggregator&.to_hash
+    end
   end
 end

data/lib/sentry/test_helper.rb

@@ -20,7 +20,7 @@ module Sentry
       # set transport to DummyTransport, so we can easily intercept the captured events
       dummy_config.transport.transport_class = Sentry::DummyTransport
       # make sure SDK allows sending under the current environment
-      dummy_config.enabled_environments << dummy_config.environment unless dummy_config.enabled_environments.include?(dummy_config.environment)
+      dummy_config.enabled_environments += [dummy_config.environment] unless dummy_config.enabled_environments.include?(dummy_config.environment)
       # disble async event sending
       dummy_config.background_worker_threads = 0
 
@@ -50,6 +50,7 @@ module Sentry
       if Sentry.get_current_hub.instance_variable_get(:@stack).size > 1
         Sentry.get_current_hub.pop_scope
       end
+      Sentry::Scope.global_event_processors.clear
     end
 
     # @return [Transport]

data/lib/sentry/threaded_periodic_worker.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Sentry
+  class ThreadedPeriodicWorker
+    include LoggingHelper
+
+    def initialize(logger, internal)
+      @thread = nil
+      @exited = false
+      @interval = internal
+      @logger = logger
+    end
+
+    def ensure_thread
+      return false if @exited
+      return true if @thread&.alive?
+
+      @thread = Thread.new do
+        loop do
+          sleep(@interval)
+          run
+        end
+      end
+
+      true
+    rescue ThreadError
+      log_debug("[#{self.class.name}] thread creation failed")
+      @exited = true
+      false
+    end
+
+    def kill
+      log_debug("[#{self.class.name}] thread killed")
+
+      @exited = true
+      @thread&.kill
+    end
+  end
+end

data/lib/sentry/transaction.rb

@@ -13,7 +13,7 @@ module Sentry
     MESSAGE_PREFIX = "[Tracing]"
 
     # https://develop.sentry.dev/sdk/event-payloads/transaction/#transaction-annotations
-    SOURCES = %i(custom url route view component task)
+    SOURCES = %i[custom url route view component task]
 
     include LoggingHelper
 
@@ -110,14 +110,15 @@ module Sentry
 
       trace_id, parent_span_id, parent_sampled = sentry_trace_data
 
-      baggage = if baggage && !baggage.empty?
-                  Baggage.from_incoming_header(baggage)
-                else
-                  # If there's an incoming sentry-trace but no incoming baggage header,
-                  # for instance in traces coming from older SDKs,
-                  # baggage will be empty and frozen and won't be populated as head SDK.
-                  Baggage.new({})
-                end
+      baggage =
+        if baggage && !baggage.empty?
+          Baggage.from_incoming_header(baggage)
+        else
+          # If there's an incoming sentry-trace but no incoming baggage header,
+          # for instance in traces coming from older SDKs,
+          # baggage will be empty and frozen and won't be populated as head SDK.
+          Baggage.new({})
+        end
 
       baggage.freeze!
 
@@ -218,7 +219,12 @@ module Sentry
       if sample_rate == true
         @sampled = true
       else
-        @sampled = Random.rand < sample_rate
+        if Sentry.backpressure_monitor
+          factor = Sentry.backpressure_monitor.downsample_factor
+          @effective_sample_rate /= 2**factor
+        end
+
+        @sampled = Random.rand < @effective_sample_rate
       end
 
       if @sampled
@@ -257,7 +263,10 @@ module Sentry
         event = hub.current_client.event_from_transaction(self)
         hub.capture_event(event)
       else
-        hub.current_client.transport.record_lost_event(:sample_rate, 'transaction')
+        is_backpressure = Sentry.backpressure_monitor&.downsample_factor&.positive?
+        reason = is_backpressure ? :backpressure : :sample_rate
+        hub.current_client.transport.record_lost_event(reason, 'transaction')
+        hub.current_client.transport.record_lost_event(reason, 'span')
       end
     end
 
@@ -294,6 +303,11 @@ module Sentry
       profiler.start
     end
 
+    # These are high cardinality and thus bad
+    def source_low_quality?
+      source == :url
+    end
+
     protected
 
     def init_span_recorder(limit = 1000)
@@ -329,11 +343,6 @@ module Sentry
       @baggage = Baggage.new(items, mutable: false)
     end
 
-    # These are high cardinality and thus bad
-    def source_low_quality?
-      source == :url
-    end
-
     class SpanRecorder
       attr_reader :max_length, :spans