datadog 2.29.0 → 2.31.0

data/lib/datadog/tracing/contrib/httprb/ext.rb

@@ -8,6 +8,7 @@ module Datadog
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
           ENV_ENABLED = 'DD_TRACE_HTTPRB_ENABLED'
+          ENV_DISTRIBUTED_TRACING = 'DD_TRACE_HTTPRB_DISTRIBUTED_TRACING'
           ENV_SERVICE_NAME = 'DD_TRACE_HTTPRB_SERVICE_NAME'
           ENV_PEER_SERVICE = 'DD_TRACE_HTTPRB_PEER_SERVICE'
           # @!visibility private

data/lib/datadog/tracing/contrib/httprb/instrumentation.rb

@@ -35,7 +35,7 @@ module Datadog
                     global_config: Datadog.configuration.tracing[:httprb],
                     trace: trace
                   )
-                    Contrib::HTTP.inject(trace, req)
+                    Contrib::HTTP.inject(trace, req.headers)
                   end
 
                   # Add additional request specific tags to the span.

data/lib/datadog/tracing/contrib/karafka/configuration/settings.rb

@@ -18,7 +18,11 @@ module Datadog
 
             option :service_name
 
-            option :distributed_tracing, default: false, type: :bool
+            option :distributed_tracing do |o|
+              o.type :bool
+              o.env Ext::ENV_DISTRIBUTED_TRACING
+              o.default false
+            end
           end
         end
       end

data/lib/datadog/tracing/contrib/karafka/ext.rb

@@ -6,6 +6,7 @@ module Datadog
       module Karafka
         module Ext
           ENV_ENABLED = 'DD_TRACE_KARAFKA_ENABLED'
+          ENV_DISTRIBUTED_TRACING = 'DD_TRACE_KARAFKA_DISTRIBUTED_TRACING'
 
           SPAN_MESSAGE_CONSUME = 'karafka.consume'
           SPAN_WORKER_PROCESS = 'worker.process'

data/lib/datadog/tracing/contrib/opensearch/patcher.rb

@@ -84,7 +84,7 @@ module Datadog
                 span.resource = "#{method} #{quantized_url}"
                 Contrib::SpanAttributeSchema.set_peer_service!(span, Ext::PEER_SERVICE_SOURCES)
               rescue => e
-                Datadog.logger.error(e.message)
+                Datadog.logger.error("#{e.class}: #{e}")
                 Datadog::Core::Telemetry::Logger.report(e)
                 # TODO: Refactor the code to streamline the execution without ensure
               ensure

data/lib/datadog/tracing/contrib/que/configuration/settings.rb

@@ -11,8 +11,11 @@ module Datadog
           # Default settings for the Que integration
           class Settings < Contrib::Configuration::Settings
             option :service_name
-            option :distributed_tracing, default: true, type: :bool
-
+            option :distributed_tracing do |o|
+              o.type :bool
+              o.env Ext::ENV_DISTRIBUTED_TRACING
+              o.default true
+            end
             option :enabled do |o|
               o.type :bool
               o.env Ext::ENV_ENABLED

data/lib/datadog/tracing/contrib/que/ext.rb

@@ -11,6 +11,7 @@ module Datadog
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_QUE_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_QUE_ANALYTICS_SAMPLE_RATE'
           ENV_ENABLED = 'DD_TRACE_QUE_ENABLED'
+          ENV_DISTRIBUTED_TRACING = 'DD_TRACE_QUE_DISTRIBUTED_TRACING'
           ENV_TAG_ARGS_ENABLED = 'DD_TRACE_QUE_TAG_ARGS_ENABLED'
           ENV_TAG_DATA_ENABLED = 'DD_TRACE_QUE_TAG_DATA_ENABLED'
           SERVICE_NAME = 'que'

data/lib/datadog/tracing/contrib/rack/configuration/settings.rb

@@ -37,7 +37,11 @@ module Datadog
             end
 
             option :application
-            option :distributed_tracing, default: true, type: :bool
+            option :distributed_tracing do |o|
+              o.type :bool
+              o.env Ext::ENV_DISTRIBUTED_TRACING
+              o.default true
+            end
             option :headers, default: DEFAULT_HEADERS, type: :hash
             option :middleware_names, default: false, type: :bool
             option :quantize, default: {}, type: :hash

data/lib/datadog/tracing/contrib/rack/ext.rb

@@ -8,6 +8,7 @@ module Datadog
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
           ENV_ENABLED = 'DD_TRACE_RACK_ENABLED'
+          ENV_DISTRIBUTED_TRACING = 'DD_TRACE_RACK_DISTRIBUTED_TRACING'
           # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_RACK_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_RACK_ANALYTICS_SAMPLE_RATE'

data/lib/datadog/tracing/contrib/rails/configuration/settings.rb

@@ -51,8 +51,11 @@ module Datadog
               end
             end
 
-            option :distributed_tracing, default: true, type: :bool
-
+            option :distributed_tracing do |o|
+              o.type :bool
+              o.env Ext::ENV_DISTRIBUTED_TRACING
+              o.default true
+            end
             option :request_queuing do |o|
               o.type :bool
               o.default false

data/lib/datadog/tracing/contrib/rails/ext.rb

@@ -9,6 +9,7 @@ module Datadog
         module Ext
           APP = 'rails'
           ENV_ENABLED = 'DD_TRACE_RAILS_ENABLED'
+          ENV_DISTRIBUTED_TRACING = 'DD_TRACE_RAILS_DISTRIBUTED_TRACING'
           # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_RAILS_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_RAILS_ANALYTICS_SAMPLE_RATE'

data/lib/datadog/tracing/contrib/rails/log_injection.rb

@@ -18,7 +18,7 @@ module Datadog
             app_config.log_tags << proc { Tracing.log_correlation if Datadog.configuration.tracing.log_injection }
           rescue => e
             Datadog.logger.warn(
-              "Unable to add Datadog Trace context to ActiveSupport::TaggedLogging: #{e.class.name} #{e.message}"
+              "Unable to add Datadog Trace context to ActiveSupport::TaggedLogging: #{e.class}: #{e}"
             )
             false
           end

data/lib/datadog/tracing/contrib/rails/patcher.rb

@@ -6,7 +6,6 @@ require_relative 'framework'
 require_relative 'log_injection'
 require_relative 'middlewares'
 require_relative 'runner'
-require_relative '../../../core/contrib/rails/utils'
 require_relative '../semantic_logger/patcher'
 
 module Datadog

data/lib/datadog/tracing/contrib/rails/runner.rb

@@ -86,7 +86,7 @@ module Datadog
                 # Reads one more byte than the limit to allow us to check if the source exceeds the limit.
                 source = File.read(file, MAX_TAG_VALUE_SIZE + 1)
               rescue => e
-                Datadog.logger.debug("Failed to read file '#{file}' for Rails runner: #{e.message}")
+                Datadog.logger.debug { "Failed to read file '#{file}' for Rails runner: #{e.class}: #{e}" }
               end
 
               Tracing.trace(

data/lib/datadog/tracing/contrib/rake/instrumentation.rb

@@ -66,7 +66,7 @@ module Datadog
               span.set_tag(Ext::TAG_TASK_ARG_NAMES, arg_names)
               span.set_tag(Ext::TAG_INVOKE_ARGS, quantize_args(args)) unless args.nil?
             rescue => e
-              Datadog.logger.debug("Error while tracing Rake invoke: #{e.class.name} #{e.message}")
+              Datadog.logger.debug { "Error while tracing Rake invoke: #{e.class}: #{e}" }
             end
 
             def annotate_execute!(span, args)
@@ -75,7 +75,7 @@ module Datadog
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_EXECUTE)
               span.set_tag(Ext::TAG_EXECUTE_ARGS, quantize_args(args.to_hash)) unless args.nil?
             rescue => e
-              Datadog.logger.debug("Error while tracing Rake execute: #{e.class.name} #{e.message}")
+              Datadog.logger.debug { "Error while tracing Rake execute: #{e.class}: #{e}" }
             end
 
             def quantize_args(args)

data/lib/datadog/tracing/contrib/redis/tags.rb

@@ -47,7 +47,7 @@ module Datadog
 
               Contrib::SpanAttributeSchema.set_peer_service!(span, Ext::PEER_SERVICE_SOURCES)
             rescue => e
-              Datadog.logger.error(e.message)
+              Datadog.logger.error("#{e.class}: #{e}")
               Datadog::Core::Telemetry::Logger.report(e)
             end
 

data/lib/datadog/tracing/contrib/rest_client/configuration/settings.rb

@@ -30,8 +30,11 @@ module Datadog
               o.default 1.0
             end
 
-            option :distributed_tracing, default: true, type: :bool
-
+            option :distributed_tracing do |o|
+              o.type :bool
+              o.env Ext::ENV_DISTRIBUTED_TRACING
+              o.default true
+            end
             option :service_name do |o|
               o.default do
                 Contrib::SpanAttributeSchema.fetch_service_name(

data/lib/datadog/tracing/contrib/rest_client/ext.rb

@@ -8,6 +8,7 @@ module Datadog
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
           ENV_ENABLED = 'DD_TRACE_REST_CLIENT_ENABLED'
+          ENV_DISTRIBUTED_TRACING = 'DD_TRACE_REST_CLIENT_DISTRIBUTED_TRACING'
           ENV_SERVICE_NAME = 'DD_TRACE_REST_CLIENT_SERVICE_NAME'
           ENV_PEER_SERVICE = 'DD_TRACE_REST_CLIENT_PEER_SERVICE'
           # @!visibility private

data/lib/datadog/tracing/contrib/sidekiq/configuration/settings.rb

@@ -38,7 +38,11 @@ module Datadog
             end
 
             option :quantize, default: {}, type: :hash
-            option :distributed_tracing, default: false, type: :bool
+            option :distributed_tracing do |o|
+              o.type :bool
+              o.env Ext::ENV_DISTRIBUTED_TRACING
+              o.default false
+            end
           end
         end
       end

data/lib/datadog/tracing/contrib/sidekiq/ext.rb

@@ -12,6 +12,7 @@ module Datadog
           # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_SIDEKIQ_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_SIDEKIQ_ANALYTICS_SAMPLE_RATE'
+          ENV_DISTRIBUTED_TRACING = 'DD_TRACE_SIDEKIQ_DISTRIBUTED_TRACING'
           SERVICE_NAME = 'sidekiq'
           SIDEKIQ_8_SECONDS_PER_INTEGER = 0.001 # Sidekiq 8 uses integer epoch milliseconds, rather than epoch floats
           SPAN_PUSH = 'sidekiq.push'

data/lib/datadog/tracing/contrib/sinatra/configuration/settings.rb

@@ -33,7 +33,11 @@ module Datadog
               o.default 1.0
             end
 
-            option :distributed_tracing, default: true, type: :bool
+            option :distributed_tracing do |o|
+              o.type :bool
+              o.env Ext::ENV_DISTRIBUTED_TRACING
+              o.default true
+            end
             option :headers, default: DEFAULT_HEADERS, type: :hash
             option :resource_script_names, default: false, type: :bool
 

data/lib/datadog/tracing/contrib/sinatra/ext.rb

@@ -8,6 +8,7 @@ module Datadog
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
           ENV_ENABLED = 'DD_TRACE_SINATRA_ENABLED'
+          ENV_DISTRIBUTED_TRACING = 'DD_TRACE_SINATRA_DISTRIBUTED_TRACING'
           # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_SINATRA_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_SINATRA_ANALYTICS_SAMPLE_RATE'

data/lib/datadog/tracing/contrib/status_range_matcher.rb

@@ -27,6 +27,10 @@ module Datadog
             end
           end
         end
+
+        def to_s
+          @ranges.map { |range| range.is_a?(Range) ? "#{range.begin}-#{range.end}" : range.to_s }.join(',')
+        end
       end
     end
   end

data/lib/datadog/tracing/contrib/stripe/request.rb

@@ -55,7 +55,7 @@ module Datadog
             span.set_tag(Ext::TAG_REQUEST_PATH, event.path)
             span.set_tag(Ext::TAG_REQUEST_NUM_RETRIES, event.num_retries.to_s)
           rescue => e
-            Datadog.logger.debug(e.message)
+            Datadog.logger.debug { "#{e.class}: #{e}" }
           end
 
           def configuration

data/lib/datadog/tracing/contrib/waterdrop/configuration/settings.rb

@@ -18,7 +18,11 @@ module Datadog
 
             option :service_name
 
-            option :distributed_tracing, default: false, type: :bool
+            option :distributed_tracing do |o|
+              o.type :bool
+              o.env Ext::ENV_DISTRIBUTED_TRACING
+              o.default false
+            end
           end
         end
       end

data/lib/datadog/tracing/contrib/waterdrop/ext.rb

@@ -6,6 +6,7 @@ module Datadog
       module WaterDrop
         module Ext
           ENV_ENABLED = 'DD_TRACE_WATERDROP_ENABLED'
+          ENV_DISTRIBUTED_TRACING = 'DD_TRACE_WATERDROP_DISTRIBUTED_TRACING'
 
           SPAN_PRODUCER = 'karafka.produce'
 

data/lib/datadog/tracing/distributed/datadog.rb

@@ -140,8 +140,9 @@ module Datadog
         rescue => e
           set_tags_propagation_error(reason: 'encoding_error')
           ::Datadog.logger.warn(
-            "Failed to inject x-datadog-tags: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
+            "Failed to inject x-datadog-tags: #{e.class}: #{e} at #{Array(e.backtrace).first}"
           )
+          nil
         end
 
         # Import `x-datadog-tags` tags as trace distributed tags.
@@ -166,8 +167,9 @@ module Datadog
         rescue => e
           set_tags_propagation_error(reason: 'decoding_error')
           ::Datadog.logger.warn(
-            "Failed to extract x-datadog-tags: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
+            "Failed to extract x-datadog-tags: #{e.class}: #{e} at #{Array(e.backtrace).first}"
           )
+          nil
         end
 
         def set_tags_propagation_error(reason:)

data/lib/datadog/tracing/event.rb

@@ -62,7 +62,7 @@ module Datadog
           block.call(*args)
         rescue => e
           Datadog.logger.debug do
-            "Error while handling '#{name}' event with '#{block}': #{e.class.name} #{e.message} " \
+            "Error while handling '#{name}' event with '#{block}': #{e.class}: #{e} " \
             "at #{Array(e.backtrace).first}"
           end
         end

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

@@ -66,6 +66,10 @@ module Datadog
           TAG_DD_PARENT_ID = '_dd.parent_id'
           DD_PARENT_ID_DEFAULT = '0000000000000000'
 
+          # Knuth Sampling Rate: the sampling rate applied by agent-based or rule-based sampling.
+          # This is a propagated tag (prefixed with `_dd.p.`) that is included in `x-datadog-tags`.
+          TAG_KNUTH_SAMPLING_RATE = '_dd.p.ksr'
+
           # Trace tags with this prefix will propagate from a trace through distributed tracing.
           # Distributed headers tags with this prefix will be injected into the active trace.
           TAGS_PREFIX = '_dd.p.'

data/lib/datadog/tracing/remote.rb

@@ -43,7 +43,7 @@ module Datadog
 
           Datadog.send(:components).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}: #{Array(e.backtrace).join("\n")}")
         end
 
         def receivers(_telemetry)

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

@@ -47,6 +47,8 @@ module Datadog
           MANUAL = '-4'
           # Formerly AppSec.
           ASM = '-5'
+          # AI Guard.
+          AI_GUARD = '-13'
           # Dynamically configured rule, explicitly created by the user.
           REMOTE_USER_RULE = '-11'
           # Dynamically configured  rule, automatically generated by Datadog.

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

@@ -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/rule.rb

@@ -34,7 +34,7 @@ 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} Source: #{Array(e.backtrace).first}"
           )
           Datadog::Core::Telemetry::Logger.report(e, description: 'Matcher failed')
           nil

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

@@ -50,6 +50,7 @@ module Datadog
             # TODO: Simplify .tags access, as `Tracer#tags` can't be arbitrarily changed anymore
             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)
@@ -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} 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,32 +130,10 @@ 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} Source: #{Array(e.backtrace).first}"
           )
           Datadog::Core::Telemetry::Logger.report(e, description: 'Rule sampling failed')
 
@@ -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/span/rule_parser.rb

@@ -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} at #{Array(e.backtrace).first}"
                 )
                 return nil
               end

data/lib/datadog/tracing/span_operation.rb

@@ -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,

data/lib/datadog/tracing/sync_writer.rb

@@ -9,7 +9,6 @@ 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: