datadog 2.28.0 → 2.41.0

data/lib/datadog/tracing/span.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative '../core/utils/safe_dup'
-require_relative 'utils'
+require_relative "../core/utils/safe_dup"
+require_relative "utils"
 
-require_relative 'metadata/ext'
-require_relative 'metadata'
+require_relative "metadata/ext"
+require_relative "metadata"
 
 module Datadog
   module Tracing
@@ -143,7 +143,7 @@ module Datadog
       # TODO: Change this to reflect attributes when serialization
       # isn't handled by this method.
       def to_hash
-        @meta['events'] = @events.map(&:to_hash).to_json unless @events.empty?
+        @meta["events"] = @events.map(&:to_hash).to_json unless @events.empty?
 
         h = {
           error: @status,
@@ -157,7 +157,7 @@ module Datadog
           span_id: @id,
           trace_id: @trace_id,
           type: @type,
-          span_links: @links.map(&:to_hash)
+          span_links: @links.map(&:to_hash),
         }
 
         if stopped?
@@ -185,19 +185,19 @@ module Datadog
           q.text "Start: #{start_time}\n"
           q.text "End: #{end_time}\n"
           q.text "Duration: #{duration.to_f}\n"
-          q.group(2, 'Tags: [', "]\n") do
+          q.group(2, "Tags: [", "]\n") do
             q.breakable
             q.seplist @meta.each do |key, value|
               q.text "#{key} => #{value}"
             end
           end
-          q.group(2, 'Metrics: [', "]\n") do
+          q.group(2, "Metrics: [", "]\n") do
             q.breakable
             q.seplist @metrics.each do |key, value|
               q.text "#{key} => #{value}"
             end
           end
-          q.group(2, 'Metastruct: [', ']') do
+          q.group(2, "Metastruct: [", "]") do
             metastruct.pretty_print(q)
           end
         end

data/lib/datadog/tracing/span_event.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'time'
+require "time"
 
 module Datadog
   module Tracing
@@ -41,8 +41,8 @@ module Datadog
       # of being limiting span events to the size limit of a span tag.
       # All Datadog agents support this format.
       def to_hash
-        h = {'name' => @name, 'time_unix_nano' => @time_unix_nano}
-        h['attributes'] = @attributes unless @attributes.empty?
+        h = {"name" => @name, "time_unix_nano" => @time_unix_nano}
+        h["attributes"] = @attributes unless @attributes.empty?
         h
       end
 
@@ -51,7 +51,7 @@ module Datadog
       # This serialization format removes the serialization limitations of the `span.set_tag('events)` approach,
       # but is only supported by newer version of the Datadog agent.
       def to_native_format
-        h = {'name' => @name, 'time_unix_nano' => @time_unix_nano}
+        h = {"name" => @name, "time_unix_nano" => @time_unix_nano}
 
         attr = {}
         @attributes.each do |key, value|
@@ -62,7 +62,7 @@ module Datadog
           end
         end
 
-        h['attributes'] = attr unless @attributes.empty?
+        h["attributes"] = attr unless @attributes.empty?
 
         h
       end

data/lib/datadog/tracing/span_operation.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
-require 'time'
+require "time"
 
-require_relative '../core/environment/identity'
-require_relative '../core/utils'
-require_relative '../core/utils/time'
-require_relative '../core/utils/safe_dup'
+require_relative "../core/environment/identity"
+require_relative "../core/utils"
+require_relative "../core/utils/time"
+require_relative "../core/utils/safe_dup"
 
-require_relative 'event'
-require_relative 'metadata'
-require_relative 'metadata/ext'
-require_relative 'span'
-require_relative 'span_event'
-require_relative 'span_link'
-require_relative 'utils'
+require_relative "event"
+require_relative "metadata"
+require_relative "metadata/ext"
+require_relative "span"
+require_relative "span_event"
+require_relative "span_link"
+require_relative "utils"
 
 module Datadog
   module Tracing
@@ -146,7 +146,7 @@ module Datadog
       end
 
       def measure
-        raise ArgumentError, 'Must provide block to measure!' unless block_given?
+        raise ArgumentError, "Must provide block to measure!" unless block_given?
         # TODO: Should we just invoke the block and skip tracing instead?
         raise AlreadyStartedError if started?
 
@@ -158,7 +158,7 @@ module Datadog
           begin
             start
           rescue => e
-            logger.debug { "Failed to start span: #{e}" }
+            logger.debug { "Failed to start span: #{e.class}: #{e.message}" }
           ensure
             # We should yield to the provided block when possible, as this
             # block is application code that we don't want to hinder.
@@ -166,7 +166,7 @@ module Datadog
             #   end its execution (either due to a system error or graceful shutdown).
             # @type var e: Exception?
             # Steep: https://github.com/soutaro/steep/issues/919
-            return_value = yield(self) unless e && !e.is_a?(StandardError) # steep:ignore FallbackAny
+            return_value = yield(self) unless e && !e.is_a?(StandardError)
           end
         # rubocop:disable Lint/RescueException
         # Here we really want to catch *any* exception, not only StandardError,
@@ -270,6 +270,9 @@ module Datadog
         # Stop timing
         stop(end_time)
 
+        # Allow subscribers to enrich the span before it is finalized.
+        events.before_finish.publish(self)
+
         # Build span
         # Memoize for performance reasons
         @span = build_span
@@ -315,14 +318,14 @@ module Datadog
         exc = Core::Error.build_from(exception)
 
         event_attributes = {
-          'exception.type' => exc.type,
-          'exception.message' => exc.message,
-          'exception.stacktrace' => exc.backtrace,
+          "exception.type" => exc.type,
+          "exception.message" => exc.message,
+          "exception.stacktrace" => exc.backtrace,
         }
 
         # Steep: Caused by wrong declaration, should be the same parameters as `merge`
         # https://github.com/ruby/rbs/blob/3d0fb3a7fdde60af7120e875fe3bd7237b5b6a88/core/hash.rbs#L1468
-        @span_events << SpanEvent.new('exception', attributes: event_attributes.merge!(attributes)) # steep:ignore ArgumentTypeMismatch
+        @span_events << SpanEvent.new("exception", attributes: event_attributes.merge!(attributes)) # steep:ignore ArgumentTypeMismatch
       end
 
       # Return a string representation of the span.
@@ -343,7 +346,7 @@ module Datadog
           resource: @resource,
           service: @service,
           trace_id: @trace_id,
-          type: @type
+          type: @type,
         }
 
         if stopped?
@@ -371,19 +374,19 @@ module Datadog
           q.text "Start: #{start_time}\n"
           q.text "End: #{end_time}\n"
           q.text "Duration: #{duration.to_f if stopped?}\n"
-          q.group(2, 'Tags: [', "]\n") do
+          q.group(2, "Tags: [", "]\n") do
             q.breakable
             q.seplist meta.each do |key, value|
               q.text "#{key} => #{value}"
             end
           end
-          q.group(2, 'Metrics: [', "]\n") do
+          q.group(2, "Metrics: [", "]\n") do
             q.breakable
             q.seplist metrics.each do |key, value|
               q.text "#{key} => #{value}"
             end
           end
-          q.group(2, 'Metastruct: [', ']') do
+          q.group(2, "Metastruct: [", "]") do
             metastruct.pretty_print(q)
           end
         end
@@ -400,12 +403,14 @@ module Datadog
           :logger,
           :after_finish,
           :after_stop,
+          :before_finish,
           :before_start
 
         def initialize(logger: Datadog.logger)
           @logger = logger
           @after_finish = AfterFinish.new
           @after_stop = AfterStop.new
+          @before_finish = BeforeFinish.new
           @before_start = BeforeStart.new
         end
 
@@ -429,6 +434,14 @@ module Datadog
           end
         end
 
+        # Triggered just before the span is finalized into a Span object.
+        # Subscribers can still mutate tags on the SpanOperation at this point.
+        class BeforeFinish < Tracing::Event
+          def initialize
+            super(:before_finish)
+          end
+        end
+
         # Triggered just before the span is started.
         class BeforeStart < Tracing::Event
           def initialize
@@ -459,7 +472,7 @@ module Datadog
             rescue => e
               logger.debug do
                 "Custom on_error handler #{@handler} failed, using fallback behavior. \
-                  Cause: #{e.class}: #{e} Location: #{Array(e.backtrace).first}"
+                  Cause: #{e.class}: #{e.message} Location: #{Array(e.backtrace).first}"
               end
 
               original&.call(op, error)
@@ -471,7 +484,7 @@ module Datadog
               @handler.call(*args)
             rescue => e
               logger.debug do
-                "Error in on_error handler '#{@handler}': #{e.class}: #{e} at #{Array(e.backtrace).first}"
+                "Error in on_error handler '#{@handler}': #{e.class}: #{e.message} at #{Array(e.backtrace).first}"
               end
             end
 
@@ -483,7 +496,7 @@ module Datadog
       # Error when the span attempts to start again after being started
       class AlreadyStartedError < StandardError
         def message
-          'Cannot measure an already started span!'
+          "Cannot measure an already started span!"
         end
       end
 

data/lib/datadog/tracing/sync_writer.rb

@@ -1,15 +1,14 @@
 # frozen_string_literal: true
 
-require_relative 'pipeline'
-require_relative 'runtime/metrics'
-require_relative 'writer'
+require_relative "pipeline"
+require_relative "runtime/metrics"
+require_relative "writer"
 
-require_relative 'transport/http'
+require_relative "transport/http"
 
 module Datadog
   module Tracing
     # SyncWriter flushes both services and traces synchronously
-    # DEV: To be replaced by Datadog::Tracing::Workers::TraceWriter.
     #
     # Note: If you're wondering if this class is used at all, since there are no other references to it on the codebase,
     # the separate `datadog-lambda` uses it as of February 2021:
@@ -47,10 +46,15 @@ module Datadog
         logger.debug(e)
       end
 
-      # Does nothing.
-      # The {SyncWriter} does not need to be stopped as it holds no state.
+      # Stops the {SyncWriter}.
+      # The {SyncWriter} holds no worker thread, but it owns its transport, so
+      # on teardown we deterministically release transports that hold native
+      # resources (e.g. the native trace exporter's Rust runtime and
+      # process-global fork hooks) rather than relying on the GC finalizer.
+      # The default HTTP transport has no `#close` and is left untouched, and
+      # `#close` is idempotent so repeated `#stop` calls are safe.
       def stop
-        # No cleanup to do for the SyncWriter
+        @transport.close if @transport.respond_to?(:close)
         true
       end
 

data/lib/datadog/tracing/trace_digest.rb

@@ -22,6 +22,9 @@ module Datadog
       # @!attribute [r] span_type
       #   The type of the currently active span.
       #   @return [String]
+      # @!attribute [r] span_links
+      #   Span links associated with this trace context.
+      #   @return [Array<Datadog::Tracing::SpanLink>, nil]
       # @!attribute [r] trace_distributed_tags
       #   Datadog-specific tags that support richer distributed tracing association.
       #   @return [Hash<String,String>]
@@ -91,6 +94,7 @@ module Datadog
         :span_resource,
         :span_service,
         :span_type,
+        :span_links,
         :trace_distributed_tags,
         :trace_hostname,
         :trace_id,
@@ -114,6 +118,7 @@ module Datadog
         span_resource: nil,
         span_service: nil,
         span_type: nil,
+        span_links: nil,
         trace_distributed_tags: nil,
         trace_hostname: nil,
         trace_id: nil,
@@ -136,6 +141,7 @@ module Datadog
         @span_resource = span_resource && span_resource.dup.freeze
         @span_service = span_service && span_service.dup.freeze
         @span_type = span_type && span_type.dup.freeze
+        @span_links = span_links && span_links.dup.freeze
         @trace_distributed_tags = trace_distributed_tags && trace_distributed_tags.dup.freeze
         @trace_hostname = trace_hostname && trace_hostname.dup.freeze
         @trace_id = trace_id
@@ -167,6 +173,7 @@ module Datadog
           span_resource: span_resource,
           span_service: span_service,
           span_type: span_type,
+          span_links: span_links,
           trace_distributed_tags: trace_distributed_tags,
           trace_hostname: trace_hostname,
           trace_id: trace_id,

data/lib/datadog/tracing/trace_operation.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require_relative '../core/environment/identity'
-require_relative '../core/utils'
-require_relative 'event'
-require_relative 'metadata/tagging'
-require_relative 'sampling/ext'
-require_relative 'span_operation'
-require_relative 'trace_digest'
-require_relative 'correlation'
-require_relative 'trace_segment'
-require_relative 'utils'
+require_relative "../core/environment/identity"
+require_relative "../core/utils"
+require_relative "event"
+require_relative "metadata/tagging"
+require_relative "sampling/ext"
+require_relative "span_operation"
+require_relative "trace_digest"
+require_relative "correlation"
+require_relative "trace_segment"
+require_relative "utils"
 
 module Datadog
   module Tracing
@@ -27,6 +27,8 @@ module Datadog
       include Metadata::Tagging
 
       DEFAULT_MAX_LENGTH = 100_000
+      AUTO_SAMPLING_PRIORITIES = [Sampling::Ext::Priority::AUTO_KEEP, Sampling::Ext::Priority::AUTO_REJECT].freeze
+      RECONSIDERABLE_DECISIONS = [Sampling::Ext::Decision::DEFAULT, Sampling::Ext::Decision::AGENT_RATE].freeze
 
       attr_accessor \
         :agent_sample_rate,
@@ -51,12 +53,12 @@ module Datadog
 
       attr_writer \
         :name,
-        :resource,
         :sampled,
         :service
 
       # Creates a new TraceOperation.
       #
+      # @param span_links [Array<Datadog::Tracing::SpanLink>, nil] links to attach to the local root span.
       # @param auto_finish [Boolean] when true, automatically finishes the trace when the local root span finishes.
       #   When false, the trace remains unfinished until {#finish!} is called.
       #   This is useful when this {TraceOperation} represents the continuation of a remote {TraceDigest},
@@ -71,6 +73,7 @@ module Datadog
         name: nil,
         origin: nil,
         parent_span_id: nil,
+        span_links: nil,
         rate_limiter_rate: nil,
         resource: nil,
         rule_sample_rate: nil,
@@ -97,7 +100,7 @@ module Datadog
         @parent_span_id = parent_span_id
         @sampled = sampled.nil? || sampled
         @remote_parent = remote_parent
-
+        @span_links = span_links
         # Tags
         @agent_sample_rate = agent_sample_rate
         @hostname = hostname
@@ -127,6 +130,8 @@ module Datadog
         @finished = false
         @spans = []
         @auto_finish = !!auto_finish
+        @flushed = false
+        @propagated = false
       end
 
       def full?
@@ -170,6 +175,17 @@ module Datadog
         set_tag(Tracing::Metadata::Ext::Distributed::TAG_DECISION_MAKER, Tracing::Sampling::Ext::Decision::MANUAL)
       end
 
+      def resource=(value)
+        previous_resource = @resource
+        @resource = value
+
+        return if !!previous_resource || value.nil?
+
+        events.trace_resource_change.publish(self)
+      rescue => e
+        logger.debug { "Error updating trace resource: #{e.class}: #{e.message} Backtrace: #{e.backtrace.first(3)}" }
+      end
+
       def name
         @name || root_span&.name
       end
@@ -190,7 +206,7 @@ module Datadog
       def set_distributed_source(product_bit)
         source = get_tag(Metadata::Ext::Distributed::TAG_TRACE_SOURCE)&.to_i(16) || 0
         source |= product_bit
-        set_tag(Metadata::Ext::Distributed::TAG_TRACE_SOURCE, format('%02X', source))
+        set_tag(Metadata::Ext::Distributed::TAG_TRACE_SOURCE, format("%02X", source))
       end
 
       def tags
@@ -208,6 +224,12 @@ module Datadog
         !@resource.nil?
       end
 
+      def reconsider_resource_sample?
+        return false if @resource.nil?
+
+        reconsider_rule_sample?
+      end
+
       def service
         @service || root_span&.service
       end
@@ -274,15 +296,20 @@ module Datadog
         parent_id = parent ? parent.id : @parent_span_id || 0
 
         # Build events
-        events ||= SpanOperation::Events.new(logger: logger)
+        span_events = events || SpanOperation::Events.new(logger: logger)
 
         # Before start: activate the span, publish events.
-        events.before_start.subscribe do |span_op|
+        span_events.before_start.subscribe do |span_op|
           start_span(span_op)
         end
 
+        # Before finish: allow enrichment before the span is finalized, publish events.
+        span_events.before_finish.subscribe do |span_op|
+          before_finish_span(span_op)
+        end
+
         # After finish: deactivate the span, record, publish events.
-        events.after_finish.subscribe do |span, span_op|
+        span_events.after_finish.subscribe do |span, span_op|
           finish_span(span, span_op, parent)
         end
 
@@ -290,9 +317,10 @@ module Datadog
         SpanOperation.new(
           op_name,
           logger: logger,
-          events: events,
+          events: span_events,
           on_error: on_error,
           parent_id: parent_id,
+          links: (@root_span.nil? ? @span_links : nil),
           resource: resource || op_name,
           service: service,
           start_time: start_time,
@@ -302,7 +330,7 @@ module Datadog
           id: id
         )
       rescue => e
-        logger.debug { "Failed to build new span: #{e}" }
+        logger.debug { "Failed to build new span: #{e.class}: #{e.message}" }
 
         # Return dummy span
         SpanOperation.new(op_name, logger: logger)
@@ -319,6 +347,7 @@ module Datadog
         # Copy out completed spans
         spans = @spans.dup
         @spans = []
+        @flushed = true
 
         spans = yield(spans) if block_given?
 
@@ -359,6 +388,7 @@ module Datadog
         span_id = @active_span&.id
         span_id ||= @parent_span_id unless finished?
         # sample the trace_operation with the tracer
+        @propagated = true
         events.trace_propagated.publish(self)
 
         TraceDigest.new(
@@ -427,16 +457,28 @@ module Datadog
         include Tracing::Events
 
         attr_reader \
+          :span_before_finish,
           :span_before_start,
           :span_finished,
           :trace_finished,
-          :trace_propagated
+          :trace_propagated,
+          :trace_resource_change
 
         def initialize
+          @span_before_finish = SpanBeforeFinish.new
           @span_before_start = SpanBeforeStart.new
           @span_finished = SpanFinished.new
           @trace_finished = TraceFinished.new
           @trace_propagated = TracePropagated.new
+          @trace_resource_change = TraceResourceChange.new
+        end
+
+        # Triggered just before a span is finalized, mirroring SpanOperation::Events::BeforeFinish.
+        # Subscribers can still mutate tags on the SpanOperation at this point.
+        class SpanBeforeFinish < Tracing::Event
+          def initialize
+            super(:span_before_finish)
+          end
         end
 
         # Triggered before a span starts.
@@ -476,6 +518,14 @@ module Datadog
             subscribe(&block)
           end
         end
+
+        # Triggered when the resource name is set
+        # This is used to reconsider trace sampling on resource name change
+        class TraceResourceChange < Tracing::Event
+          def initialize
+            super(:trace_resource_change)
+          end
+        end
       end
 
       private
@@ -511,7 +561,14 @@ module Datadog
         # Publish :span_before_start event
         events.span_before_start.publish(span_op, self)
       rescue => e
-        logger.debug { "Error starting span on trace: #{e} Backtrace: #{e.backtrace.first(3)}" }
+        logger.debug { "Error starting span on trace: #{e.class}: #{e.message} Backtrace: #{e.backtrace.first(3)}" }
+      end
+
+      def before_finish_span(span_op)
+        # Publish :span_before_finish event
+        events.span_before_finish.publish(span_op, self)
+      rescue => e
+        logger.debug { "Error in before_finish_span on trace: #{e.class}: #{e.message} Backtrace: #{e.backtrace.first(3)}" }
       end
 
       # For traces with automatic context management (auto_finish),
@@ -540,7 +597,7 @@ module Datadog
         # Publish :trace_finished event
         events.trace_finished.publish(self) if finished?
       rescue => e
-        logger.debug { "Error finishing span on trace: #{e} Backtrace: #{e.backtrace.first(3)}" }
+        logger.debug { "Error finishing span on trace: #{e.class}: #{e.message} Backtrace: #{e.backtrace.first(3)}" }
       end
 
       # Track the root {SpanOperation} object from the current execution context.
@@ -582,12 +639,24 @@ module Datadog
         meta.select { |name, _| name.start_with?(Metadata::Ext::Distributed::TAGS_PREFIX) }
       end
 
+      def reconsider_rule_sample?
+        decision = get_tag(Metadata::Ext::Distributed::TAG_DECISION_MAKER)
+
+        return false if remote_parent || @propagated || @flushed
+        return false unless AUTO_SAMPLING_PRIORITIES.include?(@sampling_priority)
+        return false if decision && !RECONSIDERABLE_DECISIONS.include?(decision)
+
+        true
+      end
+
       def reset
         @root_span = nil
         @active_span = nil
         @active_span_count = 0
         @finished = false
         @spans = []
+        @flushed = false
+        @propagated = false
       end
     end
   end

data/lib/datadog/tracing/trace_segment.rb

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
-require_relative '../core/runtime/ext'
-require_relative '../core/utils/safe_dup'
+require_relative "../core/runtime/ext"
+require_relative "../core/utils/safe_dup"
 
-require_relative 'sampling/ext'
-require_relative 'metadata/ext'
-require_relative 'metadata/tagging'
-require_relative 'utils'
+require_relative "sampling/ext"
+require_relative "metadata/ext"
+require_relative "metadata/tagging"
+require_relative "utils"
 
 module Datadog
   module Tracing
     # Serializable construct representing a trace
     # @public_api
     class TraceSegment
-      TAG_NAME = 'name'
-      TAG_RESOURCE = 'resource'
-      TAG_SERVICE = 'service'
+      TAG_NAME = "name"
+      TAG_RESOURCE = "resource"
+      TAG_SERVICE = "service"
 
       attr_reader \
         :id,
@@ -140,7 +140,7 @@ module Datadog
       def high_order_tid
         high_order = Tracing::Utils::TraceId.to_high_order(@id)
 
-        format('%016x', high_order) if high_order != 0
+        format("%016x", high_order) if high_order != 0
       end
 
       protected