datadog 2.38.0 → 2.47.0

data/lib/datadog/tracing/sampling/rule_sampler.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'ext'
-require_relative '../../core/rate_limiter'
-require_relative 'rule'
-require_relative '../../core/telemetry/logger'
+require_relative "ext"
+require_relative "../../core/rate_limiter"
+require_relative "rule"
+require_relative "../../core/telemetry/logger"
 
 module Datadog
   module Tracing
@@ -48,14 +48,14 @@ module Datadog
             nil
           else
             # TODO: Simplify .tags access, as `Tracer#tags` can't be arbitrarily changed anymore
-            RateByServiceSampler.new(1.0, env: -> { Tracing.send(:tracer).tags['env'] })
+            RateByServiceSampler.new(1.0, env: -> { Tracing.send(:tracer).tags["env"] })
           end
           @reconsider_sample_resource_enabled = @rules.any? { |rule| resource_rule?(rule) }
         end
 
         def self.parse(rules, rate_limit, default_sample_rate)
           parsed_rules = JSON.parse(rules).map do |rule|
-            sample_rate = rule['sample_rate']
+            sample_rate = rule["sample_rate"]
 
             begin
               sample_rate = Float(sample_rate)
@@ -64,12 +64,12 @@ module Datadog
             end
 
             kwargs = {
-              name: rule['name'],
-              service: rule['service'],
-              resource: rule['resource'],
-              tags: rule['tags'],
+              name: rule["name"],
+              service: rule["service"],
+              resource: rule["resource"],
+              tags: rule["tags"],
               sample_rate: sample_rate,
-              provenance: if (provenance = rule['provenance'])
+              provenance: if (provenance = rule["provenance"])
                             # `Rule::PROVENANCE_*` values are symbols, so convert strings to match
                             provenance.to_sym
                           else
@@ -135,7 +135,7 @@ module Datadog
           Datadog.logger.error(
             "Rule sampling failed. Cause: #{e.class}: #{e.message} Source: #{Array(e.backtrace).first}"
           )
-          Datadog::Core::Telemetry::Logger.report(e, description: 'Rule sampling failed')
+          Datadog::Core::Telemetry::Logger.report(e, description: "Rule sampling failed")
 
           yield(trace)
         end
@@ -192,6 +192,8 @@ module Datadog
 
         def reconsider_matching_rule!(trace, rule)
           trace.agent_sample_rate = nil
+          # Avoid mistaking a reconsidered probabilistic drop for a limiter drop.
+          trace.rate_limiter_rate = nil
           trace.clear_tag(Tracing::Metadata::Ext::Distributed::TAG_DECISION_MAKER)
           apply_rule!(trace, rule)
         end

data/lib/datadog/tracing/sampling/sampler.rb

@@ -15,7 +15,7 @@ module Datadog
         # @param [Datadog::Tracing::TraceOperation] trace
         # @return [Boolean] should this trace be kept?
         def sample!(trace)
-          raise NotImplementedError, 'Samplers must implement the #sample! method'
+          raise NotImplementedError, "Samplers must implement the #sample! method"
         end
 
         # The sampling rate, if this sampler has such concept.
@@ -24,7 +24,7 @@ module Datadog
         # @param [Datadog::Tracing::TraceOperation] trace
         # @return [Float,nil] sampling ratio between 0.0 and 1.0 (inclusive), or `nil` if not applicable
         def sample_rate(trace)
-          raise NotImplementedError, 'Samplers must implement the #sample_rate method'
+          raise NotImplementedError, "Samplers must implement the #sample_rate method"
         end
       end
     end

data/lib/datadog/tracing/sampling/span/ext.rb

@@ -13,11 +13,11 @@ module Datadog
           DEFAULT_MAX_PER_SECOND = -1
 
           # Sampling decision method used to come to the sampling decision for this span
-          TAG_MECHANISM = '_dd.span_sampling.mechanism'
+          TAG_MECHANISM = "_dd.span_sampling.mechanism"
           # Sampling rate applied to this span, if a rule applies
-          TAG_RULE_RATE = '_dd.span_sampling.rule_rate'
+          TAG_RULE_RATE = "_dd.span_sampling.rule_rate"
           # Rate limit configured for this span, if a rule applies
-          TAG_MAX_PER_SECOND = '_dd.span_sampling.max_per_second'
+          TAG_MAX_PER_SECOND = "_dd.span_sampling.max_per_second"
         end
       end
     end

data/lib/datadog/tracing/sampling/span/matcher.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../matcher'
+require_relative "../matcher"
 
 module Datadog
   module Tracing
@@ -11,7 +11,7 @@ module Datadog
           attr_reader :name, :service
 
           # Pattern that matches any string
-          MATCH_ALL_PATTERN = '*'
+          MATCH_ALL_PATTERN = "*"
 
           # Matches span name and service to their respective patterns provided.
           #

data/lib/datadog/tracing/sampling/span/rule.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'ext'
+require_relative "ext"
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/sampling/span/rule_parser.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'json'
+require "json"
 
-require_relative 'ext'
-require_relative 'matcher'
-require_relative 'rule'
+require_relative "ext"
+require_relative "matcher"
+require_relative "rule"
 
 module Datadog
   module Tracing
@@ -75,22 +75,22 @@ module Datadog
 
             def parse_rule(hash)
               matcher_options = {}
-              if (name_pattern = hash['name'])
+              if (name_pattern = hash["name"])
                 matcher_options[:name_pattern] = name_pattern
               end
 
-              if (service_pattern = hash['service'])
+              if (service_pattern = hash["service"])
                 matcher_options[:service_pattern] = service_pattern
               end
 
               matcher = Matcher.new(**matcher_options)
 
               rule_options = {}
-              if (sample_rate = hash['sample_rate'])
+              if (sample_rate = hash["sample_rate"])
                 rule_options[:sample_rate] = sample_rate
               end
 
-              if (max_per_second = hash['max_per_second'])
+              if (max_per_second = hash["max_per_second"])
                 rule_options[:rate_limit] = max_per_second
               end
 

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?
 
@@ -318,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.
@@ -346,7 +346,7 @@ module Datadog
           resource: @resource,
           service: @service,
           trace_id: @trace_id,
-          type: @type
+          type: @type,
         }
 
         if stopped?
@@ -374,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
@@ -496,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,10 +1,10 @@
 # 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
@@ -46,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

@@ -72,10 +72,7 @@ module Datadog
       #   @return [Integer]
       #   @see https://www.w3.org/TR/trace-context/#trace-flags
       # @!attribute [r] trace_state
-      #   The W3C "tracestate" extracted from a distributed context.
-      #   This field is a string representing vendor-specific distribution data.
-      #   The `dd=` entry is removed from `trace_state` as its value is dynamically calculated
-      #   on every propagation injection.
+      #   W3C "tracestate" members other than `dd=` and `ot=`, which are stored in parsed fields.
       #   @return [String]
       #   @see https://www.w3.org/TR/trace-context/#tracestate-header
       # @!attribute [r] trace_state_unknown_fields
@@ -83,6 +80,15 @@ module Datadog
       #   This allows later propagation to include those unknown fields, as they can represent future versions of the spec
       #   sending data through this service. This value ends in a trailing `;` to facilitate serialization.
       #   @return [String]
+      # @!attribute [r] trace_otel_random_value
+      #   OpenTelemetry consistent probability sampling random value.
+      #   @return [String]
+      # @!attribute [r] trace_otel_threshold
+      #   OpenTelemetry consistent probability sampling threshold.
+      #   @return [String]
+      # @!attribute [r] trace_otel_unknown_fields
+      #   Unrecognized `ot=` fields, retained with a trailing `;` for propagation.
+      #   @return [String]
       # @!attribute [r] baggage
       #   The W3C "baggage" extracted from a distributed context. This field is a hash of key/value pairs.
       #   @return [Hash<String,String>]
@@ -109,6 +115,9 @@ module Datadog
         :trace_flags,
         :trace_state,
         :trace_state_unknown_fields,
+        :trace_otel_random_value,
+        :trace_otel_threshold,
+        :trace_otel_unknown_fields,
         :span_remote,
         :baggage
 
@@ -133,6 +142,9 @@ module Datadog
         trace_flags: nil,
         trace_state: nil,
         trace_state_unknown_fields: nil,
+        trace_otel_random_value: nil,
+        trace_otel_threshold: nil,
+        trace_otel_unknown_fields: nil,
         span_remote: true,
         baggage: nil
       )
@@ -156,6 +168,9 @@ module Datadog
         @trace_flags = trace_flags
         @trace_state = trace_state && trace_state.dup.freeze
         @trace_state_unknown_fields = trace_state_unknown_fields && trace_state_unknown_fields.dup.freeze
+        @trace_otel_random_value = trace_otel_random_value && trace_otel_random_value.dup.freeze
+        @trace_otel_threshold = trace_otel_threshold && trace_otel_threshold.dup.freeze
+        @trace_otel_unknown_fields = trace_otel_unknown_fields && trace_otel_unknown_fields.dup.freeze
         @span_remote = span_remote
         @baggage = baggage && baggage.dup.freeze
         freeze
@@ -188,6 +203,9 @@ module Datadog
           trace_flags: trace_flags,
           trace_state: trace_state,
           trace_state_unknown_fields: trace_state_unknown_fields,
+          trace_otel_random_value: trace_otel_random_value,
+          trace_otel_threshold: trace_otel_threshold,
+          trace_otel_unknown_fields: trace_otel_unknown_fields,
           span_remote: span_remote,
           baggage: baggage, **field_value_pairs
         )

data/lib/datadog/tracing/trace_operation.rb

@@ -1,15 +1,16 @@
 # 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 "distributed/trace_state"
+require_relative "span_operation"
+require_relative "trace_digest"
+require_relative "correlation"
+require_relative "trace_segment"
+require_relative "utils"
 
 module Datadog
   module Tracing
@@ -48,8 +49,7 @@ module Datadog
         :id,
         :max_length,
         :parent_span_id,
-        :trace_state,
-        :trace_state_unknown_fields
+        :trace_state
 
       attr_writer \
         :name,
@@ -86,8 +86,8 @@ module Datadog
         tags: nil,
         metrics: nil,
         trace_state: nil,
-        trace_state_unknown_fields: nil,
         remote_parent: false,
+        distributed_sampling_priority: false,
         tracer: nil, # DEV-3.0: deprecated, remove in 3.0
         baggage: nil,
         auto_finish: true
@@ -100,6 +100,7 @@ module Datadog
         @parent_span_id = parent_span_id
         @sampled = sampled.nil? || sampled
         @remote_parent = remote_parent
+        @distributed_sampling_priority = distributed_sampling_priority
         @span_links = span_links
         # Tags
         @agent_sample_rate = agent_sample_rate
@@ -114,8 +115,7 @@ module Datadog
         @service = service
         @profiling_enabled = profiling_enabled
         @apm_tracing_enabled = apm_tracing_enabled
-        @trace_state = trace_state
-        @trace_state_unknown_fields = trace_state_unknown_fields
+        @trace_state = trace_state || Distributed::TraceState.new
         @baggage = baggage
 
         # Generic tags
@@ -206,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
@@ -391,6 +391,15 @@ module Datadog
         @propagated = true
         events.trace_propagated.publish(self)
 
+        open_telemetry = @trace_state.open_telemetry.outbound(
+          trace_id: @id,
+          sampling_priority: @sampling_priority,
+          decision_maker: get_tag(Tracing::Metadata::Ext::Distributed::TAG_DECISION_MAKER),
+          applied_rate: @rule_sample_rate || @agent_sample_rate,
+          rate_limiter_rate: @rate_limiter_rate,
+          distributed_sampling_priority: @distributed_sampling_priority,
+        )
+
         TraceDigest.new(
           span_id: span_id,
           span_name: @active_span && @active_span.name,
@@ -407,8 +416,11 @@ module Datadog
           trace_runtime_id: Core::Environment::Identity.id,
           trace_sampling_priority: @sampling_priority,
           trace_service: service,
-          trace_state: @trace_state,
-          trace_state_unknown_fields: @trace_state_unknown_fields,
+          trace_state: @trace_state.unknown_vendors,
+          trace_state_unknown_fields: @trace_state.datadog.unknown_fields,
+          trace_otel_random_value: open_telemetry.random_value,
+          trace_otel_threshold: open_telemetry.threshold,
+          trace_otel_unknown_fields: open_telemetry.unknown_fields,
           span_remote: @remote_parent && @active_span.nil?,
           baggage: (@baggage.nil? || @baggage.empty?) ? nil : @baggage
         ).freeze
@@ -444,11 +456,11 @@ module Datadog
           sampled: @sampled,
           sampling_priority: @sampling_priority,
           service: service&.dup,
-          trace_state: @trace_state&.dup,
-          trace_state_unknown_fields: @trace_state_unknown_fields&.dup,
+          trace_state: @trace_state,
           tags: meta.dup,
           metrics: metrics.dup,
-          remote_parent: @remote_parent
+          remote_parent: @remote_parent,
+          distributed_sampling_priority: @distributed_sampling_priority
         )
       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