datadog 2.28.0 → 2.41.0

data/lib/datadog/tracing/metadata/metastruct.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/metadata/metastruct_tagging.rb

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

data/lib/datadog/tracing/metadata/tagging.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../../core/environment/ext'
+require_relative "../../core/environment/ext"
 
-require_relative 'ext'
+require_relative "ext"
 
 module Datadog
   module Tracing
@@ -21,7 +21,7 @@ module Datadog
           Ext::Distributed::TAG_ORIGIN => true,
           Core::Environment::Ext::TAG_VERSION => true,
           Ext::HTTP::TAG_STATUS_CODE => true,
-          Ext::NET::TAG_HOSTNAME => true
+          Ext::NET::TAG_HOSTNAME => true,
         }.freeze
 
         # Return the tag with the given key, nil if it doesn't exist.
@@ -52,7 +52,7 @@ module Datadog
             meta[Core::Utils.utf8_encode(key)] = Core::Utils.utf8_encode(value)
           end
         rescue => e
-          Datadog.logger.debug("Unable to set the tag #{key}, ignoring it. Caused by: #{e}")
+          Datadog.logger.debug("Unable to set the tag #{key}, ignoring it. Caused by: #{e.class}: #{e.message}")
         end
 
         # Sets tags from given hash, for each key in hash it sets the tag with that key
@@ -102,7 +102,7 @@ module Datadog
           # Encode strings in UTF-8 to facilitate downstream serialization
           metrics[Core::Utils.utf8_encode(key)] = value
         rescue => e
-          Datadog.logger.debug("Unable to set the metric #{key}, ignoring it. Caused by: #{e}")
+          Datadog.logger.debug("Unable to set the metric #{key}, ignoring it. Caused by: #{e.class}: #{e.message}")
         end
 
         # This method removes a metric for the given key. It acts like {#clear_tag}.

data/lib/datadog/tracing/metadata.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'metadata/analytics'
-require_relative 'metadata/tagging'
-require_relative 'metadata/metastruct_tagging'
-require_relative 'metadata/errors'
+require_relative "metadata/analytics"
+require_relative "metadata/tagging"
+require_relative "metadata/metastruct_tagging"
+require_relative "metadata/errors"
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/pipeline/span_filter.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'set'
-require_relative 'span_processor'
+require "set"
+require_relative "span_processor"
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/pipeline.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'pipeline/span_filter'
-require_relative 'pipeline/span_processor'
+require_relative "pipeline/span_filter"
+require_relative "pipeline/span_processor"
 
 module Datadog
   module Tracing
@@ -51,7 +51,7 @@ module Datadog
         end
       rescue => e
         Datadog.logger.debug(
-          "trace dropped entirely due to `Pipeline.before_flush` error: #{e}"
+          "trace dropped entirely due to `Pipeline.before_flush` error: #{e.class}: #{e.message}"
         )
 
         nil

data/lib/datadog/tracing/remote.rb

@@ -1,20 +1,23 @@
 # frozen_string_literal: true
 
-require_relative '../core/remote/dispatcher'
-require_relative 'configuration/dynamic'
+require_relative "../core/remote/dispatcher"
+require_relative "configuration/dynamic"
 
 module Datadog
   module Tracing
     # Remote configuration declaration
     module Remote
       class << self
-        PRODUCT = 'APM_TRACING'
+        PRODUCT = "APM_TRACING"
 
         CAPABILITIES = [
           1 << 12, # APM_TRACING_SAMPLE_RATE: Dynamic trace sampling rate configuration
           1 << 13, # APM_TRACING_LOGS_INJECTION: Dynamic trace logs injection configuration
           1 << 14, # APM_TRACING_HTTP_HEADER_TAGS: Dynamic trace HTTP header tags configuration
           1 << 29, # APM_TRACING_SAMPLE_RULES: Dynamic trace sampling rules configuration
+          # APM_TRACING_ENABLE_DYNAMIC_INSTRUMENTATION (bit 38) is declared in
+          # DI::Remote.capabilities, not here, so it is registered only when DI
+          # is not explicitly disabled and the runtime supports DI.
         ].freeze
 
         def products
@@ -25,8 +28,8 @@ module Datadog
           CAPABILITIES
         end
 
-        def process_config(config, content)
-          lib_config = config['lib_config']
+        def process_config(config, content, repository = nil)
+          lib_config = config["lib_config"]
 
           env_vars = Datadog::Tracing::Configuration::Dynamic::OPTIONS.map do |name, env_var, option|
             value = lib_config[name]
@@ -34,16 +37,51 @@ module Datadog
             # Guard for RBS/Steep
             raise "option is a #{option.class}, expected Option" unless option.is_a?(Configuration::Dynamic::Option)
 
-            option.call(value)
+            telemetry_value = option.call(value)
 
-            [env_var, value]
+            [env_var, telemetry_value]
+          end
+
+          if (di_enabled = lib_config["dynamic_instrumentation_enabled"]) != nil # rubocop:disable Style/NonNilCheck
+            # repository is forwarded so that an enable signal can reconcile DI
+            # against probes delivered in an earlier poll while DI was stopped
+            # (see Datadog::DI::Remote.handle_rc_enablement).
+            Datadog::DI::Remote.handle_rc_enablement(di_enabled, repository)
+
+            components = Datadog.send(:components, allow_initialization: false)
+            di_products = Datadog::DI::Remote.products +
+              Datadog::SymbolDatabase::Remote.deferred_products(Datadog.configuration)
+
+            if di_enabled
+              components&.symbol_database&.resume_pending_upload
+              # Advertise the DI products only if the component actually started.
+              # handle_rc_enablement above no-ops when DI cannot run — the
+              # component is nil on an unsupported runtime, or the enable signal
+              # is blocked by DD_DYNAMIC_INSTRUMENTATION_ENABLED=false. Advertising
+              # then would report DI as in use when it is not and invite probe
+              # configs the tracer must refuse; withdraw the products otherwise.
+              if components&.dynamic_instrumentation&.started?
+                components&.remote&.add_products(*di_products)
+              else
+                components&.remote&.remove_products(*di_products)
+              end
+            else
+              components&.symbol_database&.stop_for_di_disable
+              components&.remote&.remove_products(*di_products)
+            end
           end
 
           content.applied
 
-          Datadog.send(:components).telemetry.client_configuration_change!(env_vars)
+          # allow_initialization: false because process_config runs on the
+          # remote-config worker thread. If components haven't been built yet
+          # (e.g. during a teardown/reset window), the default `true` would
+          # synchronously build the entire component tree from this thread.
+          # The &. chain matches the pattern used by DI::Remote.handle_rc_enablement
+          # in the same dispatch path.
+          Datadog.send(:components, allow_initialization: false)&.telemetry&.client_configuration_change!(env_vars)
         rescue => e
-          content.errored("#{e.class.name} #{e.message}: #{Array(e.backtrace).join("\n")}")
+          content.errored("#{e.class}: #{e.message}: #{Array(e.backtrace).join("\n")}")
         end
 
         def receivers(_telemetry)
@@ -55,7 +93,7 @@ module Datadog
               case content.path.product
               when PRODUCT
                 config = parse_content(content)
-                process_config(config, content)
+                process_config(config, content, repository)
               end
             end
           end

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

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

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

@@ -37,20 +37,22 @@ module Datadog
         # this tag is currently formatted as `"-sampling_mechanism"`.
         module Decision
           # Used before the tracer receives any rates from agent and there are no rules configured.
-          DEFAULT = '-0'
+          DEFAULT = "-0"
           # The sampling rate received in the agent's http response.
-          AGENT_RATE = '-1'
+          AGENT_RATE = "-1"
           # Locally configured rule.
-          TRACE_SAMPLING_RULE = '-3'
+          TRACE_SAMPLING_RULE = "-3"
           # User directly sets sampling priority via {Tracing.reject!} or {Tracing.keep!},
           # or by a custom sampler implementation.
-          MANUAL = '-4'
+          MANUAL = "-4"
           # Formerly AppSec.
-          ASM = '-5'
+          ASM = "-5"
+          # AI Guard.
+          AI_GUARD = "-13"
           # Dynamically configured rule, explicitly created by the user.
-          REMOTE_USER_RULE = '-11'
+          REMOTE_USER_RULE = "-11"
           # Dynamically configured  rule, automatically generated by Datadog.
-          REMOTE_DYNAMIC_RULE = '-12'
+          REMOTE_DYNAMIC_RULE = "-12"
         end
       end
     end

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

@@ -7,7 +7,7 @@ module Datadog
       # @abstract
       class Matcher
         # Pattern that matches any string
-        MATCH_ALL_PATTERN = '*'
+        MATCH_ALL_PATTERN = "*"
 
         # Returns `true` if the trace should conforms to this rule, `false` otherwise
         #
@@ -35,8 +35,8 @@ module Datadog
 
           # Our valid special characters, `?` and `*`, were just escaped
           # by `Regexp.quote` above. We need to unescape them:
-          glob.gsub!('\?', '.') # Any single character
-          glob.gsub!('\*', '.*') # Any substring
+          glob.gsub!('\?', ".") # Any single character
+          glob.gsub!('\*', ".*") # Any substring
 
           # Patterns have to match the whole input string
           glob = "\\A#{glob}\\z"
@@ -108,7 +108,7 @@ module Datadog
             # Format metrics as strings, to allow for partial number matching (/4.*/ matching '400', '404', etc.).
             # Because metrics are floats, we use the '%g' format specifier to avoid trailing zeros, which
             # can affect exact string matching (e.g. '400' matching '400.0').
-            tag = format('%g', tag) if tag.is_a?(Numeric)
+            tag = format("%g", tag) if tag.is_a?(Numeric)
 
             matcher.match?(tag)
           end

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'ext'
-require_relative 'all_sampler'
-require_relative 'rate_sampler'
-require_relative 'rate_by_service_sampler'
+require_relative "ext"
+require_relative "all_sampler"
+require_relative "rate_sampler"
+require_relative "rate_by_service_sampler"
 
 module Datadog
   module Tracing
@@ -77,6 +77,19 @@ module Datadog
           end
         end
 
+        def reconsider_sample_resource!(trace)
+          return unless @priority_sampler.respond_to?(:reconsider_sample_resource!)
+
+          preserving_sampling(trace) do
+            @priority_sampler.reconsider_sample_resource!(trace)
+          end
+        end
+
+        def resource_sampling?
+          @priority_sampler.respond_to?(:resource_sampling?) &&
+            @priority_sampler.resource_sampling?
+        end
+
         # (see Datadog::Tracing::Sampling::RateByServiceSampler#update)
         def update(rate_by_service, decision: nil)
           @priority_sampler.update(rate_by_service, decision: decision)

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'sampler'
-require_relative 'rate_sampler'
+require_relative "sampler"
+require_relative "rate_sampler"
 
 module Datadog
   module Tracing
@@ -14,7 +14,7 @@ module Datadog
         def initialize(default_key, default_rate = 1.0, decision: nil, &block)
           super()
 
-          raise ArgumentError, 'No resolver given!' unless block
+          raise ArgumentError, "No resolver given!" unless block
 
           @default_key = default_key
           @resolver = block

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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative 'rate_by_key_sampler'
+require_relative "rate_by_key_sampler"
 
 module Datadog
   module Tracing
     module Sampling
       # {Datadog::Tracing::Sampling::RateByServiceSampler} samples different services at different rates
       class RateByServiceSampler < RateByKeySampler
-        DEFAULT_KEY = 'service:,env:'
+        DEFAULT_KEY = "service:,env:"
 
         def initialize(default_rate = 1.0, env: nil, decision: Datadog::Tracing::Sampling::Ext::Decision::DEFAULT)
           super(

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'sampler'
-require_relative '../../core/knuth_sampler'
+require_relative "sampler"
+require_relative "../../core/knuth_sampler"
 
 module Datadog
   module Tracing

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative 'matcher'
-require_relative 'rate_sampler'
-require_relative '../../core/telemetry/logger'
+require_relative "matcher"
+require_relative "rate_sampler"
+require_relative "../../core/telemetry/logger"
 
 module Datadog
   module Tracing
@@ -34,9 +34,9 @@ module Datadog
           @matcher.match?(trace)
         rescue => e
           Datadog.logger.error(
-            "Matcher failed. Cause: #{e.class.name} #{e.message} Source: #{Array(e.backtrace).first}"
+            "Matcher failed. Cause: #{e.class}: #{e.message} Source: #{Array(e.backtrace).first}"
           )
-          Datadog::Core::Telemetry::Logger.report(e, description: 'Matcher failed')
+          Datadog::Core::Telemetry::Logger.report(e, description: "Matcher failed")
           nil
         end
 

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,13 +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)
@@ -63,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
@@ -84,7 +85,7 @@ module Datadog
           new(parsed_rules, rate_limit: rate_limit, default_sample_rate: default_sample_rate)
         rescue => e
           Datadog.logger.warn do
-            "Could not parse trace sampling rules '#{rules}': #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
+            "Could not parse trace sampling rules '#{rules}': #{e.class}: #{e.message} at #{Array(e.backtrace).first}"
           end
 
           nil
@@ -103,6 +104,18 @@ module Datadog
           trace.sampled = sampled
         end
 
+        def reconsider_sample_resource!(trace)
+          rule = @rules.find { |r| resource_rule?(r) && r.match?(trace) }
+          return if rule.nil?
+
+          reconsider_matching_rule!(trace, rule)
+        end
+
+        # Do any rules match on the resource name?
+        def resource_sampling?
+          @reconsider_sample_resource_enabled
+        end
+
         # @!visibility private
         def update(*args, **kwargs)
           return false unless @default_sampler.respond_to?(:update)
@@ -117,34 +130,12 @@ module Datadog
 
           return yield(trace) if rule.nil?
 
-          sampled = rule.sample!(trace)
-          sample_rate = rule.sample_rate(trace)
-
-          set_priority(trace, sampled)
-          set_rule_metrics(trace, sample_rate)
-
-          return false unless sampled
-
-          rate_limiter.allow?.tap do |allowed|
-            set_priority(trace, allowed)
-            set_limiter_metrics(trace, rate_limiter.effective_rate)
-
-            provenance = case rule.provenance
-            when Rule::PROVENANCE_REMOTE_USER
-              Ext::Decision::REMOTE_USER_RULE
-            when Rule::PROVENANCE_REMOTE_DYNAMIC
-              Ext::Decision::REMOTE_DYNAMIC_RULE
-            else
-              Ext::Decision::TRACE_SAMPLING_RULE
-            end
-
-            trace.set_tag(Tracing::Metadata::Ext::Distributed::TAG_DECISION_MAKER, provenance)
-          end
+          apply_rule!(trace, rule)
         rescue => e
           Datadog.logger.error(
-            "Rule sampling failed. Cause: #{e.class.name} #{e.message} Source: #{Array(e.backtrace).first}"
+            "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
@@ -166,6 +157,44 @@ module Datadog
         def set_limiter_metrics(trace, limiter_rate)
           trace.rate_limiter_rate = limiter_rate
         end
+
+        def apply_rule!(trace, rule)
+          sampled = rule.sample!(trace)
+          sample_rate = rule.sample_rate(trace)
+
+          set_priority(trace, sampled)
+          set_rule_metrics(trace, sample_rate)
+
+          return false unless sampled
+
+          rate_limiter.allow?.tap do |allowed|
+            set_priority(trace, allowed)
+            set_limiter_metrics(trace, rate_limiter.effective_rate)
+            trace.set_tag(Tracing::Metadata::Ext::Distributed::TAG_DECISION_MAKER, provenance_for(rule))
+          end
+        end
+
+        def provenance_for(rule)
+          case rule.provenance
+          when Rule::PROVENANCE_REMOTE_USER
+            Ext::Decision::REMOTE_USER_RULE
+          when Rule::PROVENANCE_REMOTE_DYNAMIC
+            Ext::Decision::REMOTE_DYNAMIC_RULE
+          else
+            Ext::Decision::TRACE_SAMPLING_RULE
+          end
+        end
+
+        def resource_rule?(rule)
+          matcher = rule.matcher
+          matcher.respond_to?(:resource) && matcher.resource != Matcher::MATCH_ALL
+        end
+
+        def reconsider_matching_rule!(trace, rule)
+          trace.agent_sample_rate = nil
+          trace.clear_tag(Tracing::Metadata::Ext::Distributed::TAG_DECISION_MAKER)
+          apply_rule!(trace, rule)
+        end
       end
     end
   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
@@ -29,7 +29,7 @@ module Datadog
               rescue => e
                 Datadog.logger.warn(
                   "Error parsing Span Sampling Rules `#{rules.inspect}`: " \
-                  "#{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
+                  "#{e.class}: #{e.message} at #{Array(e.backtrace).first}"
                 )
                 return nil
               end
@@ -61,7 +61,7 @@ module Datadog
                 rescue => e
                   Datadog.logger.warn(
                     "Cannot parse Span Sampling Rule #{hash.inspect}: " \
-                    "#{e.class.name} #{e} at #{Array(e.backtrace).first}"
+                    "#{e.class}: #{e.message} at #{Array(e.backtrace).first}"
                   )
                   return nil
                 end
@@ -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