datadog 2.9.0 → 2.11.0

data/lib/datadog/core/remote/transport/http/api.rb

@@ -2,24 +2,9 @@
 
 require_relative '../../../encoding'
 require_relative '../../../transport/http/api/map'
-
-# TODO: Decouple standard transport/http/api/instance
-#
-# Separate classes are needed because transport/http/traces includes
-# Trace::API::Instance which closes over and uses a single spec, which is
-# negotiated as either /v3 or /v4 for the whole API at the spec level, but we
-# need an independent toplevel path at the endpoint level.
-#
-# Separate classes are needed because of `include Trace::API::Instance`.
-#
-# Below should be:
-# require_relative '../../../../datadog/core/transport/http/api/spec'
-require_relative 'api/spec'
-
-# TODO: only needed for Negotiation::API::Endpoint
+require_relative '../../../transport/http/api/instance'
+require_relative '../../../transport/http/api/spec'
 require_relative 'negotiation'
-
-# TODO: only needed for Config::API::Endpoint
 require_relative 'config'
 
 module Datadog
@@ -36,7 +21,7 @@ module Datadog
             module_function
 
             def defaults
-              Datadog::Core::Transport::HTTP::API::Map[
+              Core::Transport::HTTP::API::Map[
                 ROOT => Spec.new do |s|
                   s.info = Negotiation::API::Endpoint.new(
                     '/info',
@@ -50,6 +35,16 @@ module Datadog
                 end,
               ]
             end
+
+            class Instance < Core::Transport::HTTP::API::Instance
+              include Config::API::Instance
+              include Negotiation::API::Instance
+            end
+
+            class Spec < Core::Transport::HTTP::API::Spec
+              include Config::API::Spec
+              include Negotiation::API::Spec
+            end
           end
         end
       end

data/lib/datadog/core/remote/transport/http/config.rb

@@ -8,22 +8,6 @@ require_relative '../../../utils/base64'
 require_relative '../../../transport/http/response'
 require_relative '../../../transport/http/api/endpoint'
 
-# TODO: Decouple standard transport/http/api/instance
-#
-# Separate classes are needed because transport/http/trace includes
-# Trace::API::Instance which closes over and uses a single spec, which is
-# negotiated as either /v3 or /v4 for the whole API at the spec level, but we
-# need an independent toplevel path at the endpoint level.
-#
-# Separate classes are needed because of `include Trace::API::Instance`.
-#
-# Below should be:
-# require_relative '../../../core/transport/http/api/instance'
-require_relative 'api/instance'
-# Below should be:
-# require_relative '../../../core/transport/http/api/spec'
-require_relative 'api/spec'
-
 module Datadog
   module Core
     module Remote
@@ -270,8 +254,6 @@ module Datadog
             # Add remote configuration behavior to transport components
             ###### overrides send_payload! which calls send_<endpoint>! kills any other possible endpoint!
             HTTP::Client.include(Config::Client)
-            HTTP::API::Spec.include(Config::API::Spec)
-            HTTP::API::Instance.include(Config::API::Instance)
           end
         end
       end

data/lib/datadog/core/remote/transport/http/negotiation.rb

@@ -7,22 +7,6 @@ require_relative 'client'
 require_relative '../../../transport/http/response'
 require_relative '../../../transport/http/api/endpoint'
 
-# TODO: Decouple standard transport/http/api/instance
-#
-# Separate classes are needed because transport/http/trace includes
-# Trace::API::Instance which closes over and uses a single spec, which is
-# negotiated as either /v3 or /v4 for the whole API at the spec level, but we
-# need an independent toplevel path at the endpoint level.
-#
-# Separate classes are needed because of `include Trace::API::Instance`.
-#
-# Below should be:
-# require_relative '../../../../datadog/core/transport/http/api/instance'
-require_relative 'api/instance'
-# Below should be:
-# require_relative '../../../../datadog/core/transport/http/api/spec'
-require_relative 'api/spec'
-
 module Datadog
   module Core
     module Remote
@@ -43,6 +27,7 @@ module Datadog
                 @version = options[:version]
                 @endpoints = options[:endpoints]
                 @config = options[:config]
+                @span_events = options[:span_events]
               end
             end
 
@@ -136,8 +121,6 @@ module Datadog
 
             # Add negotiation behavior to transport components
             HTTP::Client.include(Negotiation::Client)
-            HTTP::API::Spec.include(Negotiation::API::Spec)
-            HTTP::API::Instance.include(Negotiation::API::Instance)
           end
         end
       end

data/lib/datadog/core/remote/transport/http.rb

@@ -5,6 +5,7 @@ require 'uri'
 require_relative '../../environment/container'
 require_relative '../../environment/ext'
 require_relative '../../transport/ext'
+require_relative '../../transport/http/builder'
 require_relative '../../transport/http/adapters/net'
 require_relative '../../transport/http/adapters/unix_socket'
 require_relative '../../transport/http/adapters/test'
@@ -19,14 +20,6 @@ require_relative '../../transport/http/adapters/test'
 # require_relative '../../transport/http/api'
 require_relative 'http/api'
 
-# TODO: Decouple transport/http/builder
-#
-# See http/builder
-#
-# Below should be:
-# require_relative '../../transport/http/builder'
-require_relative 'http/builder'
-
 # TODO: Decouple transport/http
 #
 # Because a new transport is required for every (API, Client, Transport)
@@ -53,7 +46,9 @@ module Datadog
 
           # Builds a new Transport::HTTP::Client
           def new(klass, &block)
-            Builder.new(&block).to_transport(klass)
+            Core::Transport::HTTP::Builder.new(
+              api_instance_class: API::Instance, &block
+            ).to_transport(klass)
           end
 
           # Builds a new Transport::HTTP::Client with default settings
@@ -133,15 +128,15 @@ module Datadog
           end
 
           # Add adapters to registry
-          Builder::REGISTRY.set(
+          Core::Transport::HTTP::Builder::REGISTRY.set(
             Datadog::Core::Transport::HTTP::Adapters::Net,
             Datadog::Core::Configuration::Ext::Agent::HTTP::ADAPTER
           )
-          Builder::REGISTRY.set(
+          Core::Transport::HTTP::Builder::REGISTRY.set(
             Datadog::Core::Transport::HTTP::Adapters::Test,
             Datadog::Core::Transport::Ext::Test::ADAPTER
           )
-          Builder::REGISTRY.set(
+          Core::Transport::HTTP::Builder::REGISTRY.set(
             Datadog::Core::Transport::HTTP::Adapters::UnixSocket,
             Datadog::Core::Configuration::Ext::Agent::UnixSocket::ADAPTER
           )

data/lib/datadog/core/remote/transport/negotiation.rb

@@ -32,7 +32,19 @@ module Datadog
 
           # Negotiation response
           module Response
-            attr_reader :version, :endpoints, :config
+            # @!attribute [r] version
+            #   The version of the agent.
+            #   @return [String]
+            # @!attribute [r] endpoints
+            #   The HTTP endpoints the agent supports.
+            #   @return [Array<String>]
+            # @!attribute [r] config
+            #   The agent configuration. These are configured by the user when starting the agent, as well as any defaults.
+            #   @return [Hash]
+            # @!attribute [r] span_events
+            #   Whether the agent supports the top-level span events field in flushed spans.
+            #   @return [Boolean,nil]
+            attr_reader :version, :endpoints, :config, :span_events
           end
 
           # Negotiation transport

data/lib/datadog/core/telemetry/event.rb

@@ -122,6 +122,11 @@ module Datadog
                 config.tracing.contrib.global_default_service_name.enabled,
                 seq_id
               ),
+              conf_value(
+                'DD_TRACE_PEER_SERVICE_DEFAULTS_ENABLED',
+                config.tracing.contrib.peer_service_defaults,
+                seq_id
+              ),
             ]
 
             peer_service_mapping_str = ''

data/lib/datadog/core/transport/http/adapters/unix_socket.rb

@@ -49,7 +49,7 @@ module Datadog
 
             # Re-implements Net:HTTP with underlying Unix socket
             class HTTP < ::Net::HTTP
-              DEFAULT_TIMEOUT = 1
+              DEFAULT_TIMEOUT = 30
 
               attr_reader \
                 :filepath, # DEV(1.0): Rename to `uds_path`

data/lib/datadog/{tracing → core}/transport/http/api/instance.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Datadog
-  module Tracing
+  module Core
     module Transport
       module HTTP
         module API

data/lib/datadog/{tracing → core}/transport/http/api/spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Datadog
-  module Tracing
+  module Core
     module Transport
       module HTTP
         module API

data/lib/datadog/{tracing → core}/transport/http/builder.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
-require_relative '../../../core/configuration/agent_settings_resolver'
-require_relative '../../../core/transport/http/adapters/registry'
-require_relative '../../../core/transport/http/api/map'
-require_relative 'api/instance'
-require_relative 'client'
+require_relative '../../configuration/agent_settings_resolver'
+require_relative 'adapters/registry'
+require_relative 'api/map'
 
 module Datadog
-  module Tracing
+  module Core
     module Transport
       module HTTP
         # Builds new instances of Transport::HTTP::Client
@@ -15,13 +13,14 @@ module Datadog
           REGISTRY = Datadog::Core::Transport::HTTP::Adapters::Registry.new
 
           attr_reader \
+            :api_instance_class,
             :apis,
             :api_options,
             :default_adapter,
             :default_api,
             :default_headers
 
-          def initialize
+          def initialize(api_instance_class:)
             # Global settings
             @default_adapter = nil
             @default_headers = {}
@@ -33,6 +32,8 @@ module Datadog
             # API settings
             @api_options = {}
 
+            @api_instance_class = api_instance_class
+
             yield(self) if block_given?
           end
 
@@ -82,11 +83,10 @@ module Datadog
             @default_api = key
           end
 
-          def to_transport
+          def to_transport(klass)
             raise NoDefaultApiError if @default_api.nil?
 
-            # DEV: Should not be specific to traces
-            Transport::Traces::Transport.new(to_api_instances, @default_api)
+            klass.new(to_api_instances, @default_api)
           end
 
           def to_api_instances
@@ -117,28 +117,48 @@ module Datadog
             end
           end
 
-          def api_instance_class
-            API::Instance
-          end
-
           # Raised when the API key does not match known APIs.
           class UnknownApiError < StandardError
+            attr_reader :key
+
             def initialize(key)
-              super("Unknown transport API '#{key}'!")
+              super()
+
+              @key = key
+            end
+
+            def message
+              "Unknown transport API '#{key}'!"
             end
           end
 
           # Raised when the identifier cannot be matched to an adapter.
           class UnknownAdapterError < StandardError
+            attr_reader :type
+
             def initialize(type)
-              super("Unknown transport adapter '#{type}'!")
+              super()
+
+              @type = type
+            end
+
+            def message
+              "Unknown transport adapter '#{type}'!"
             end
           end
 
           # Raised when an adapter cannot be resolved for an API instance.
           class NoAdapterForApiError < StandardError
+            attr_reader :key
+
             def initialize(key)
-              super("No adapter resolved for transport API '#{key}'!")
+              super()
+
+              @key = key
+            end
+
+            def message
+              "No adapter resolved for transport API '#{key}'!"
             end
           end
 

data/lib/datadog/core/transport/response.rb

@@ -55,6 +55,10 @@ module Datadog
           true
         end
 
+        def to_s
+          "#{super}, error_type:#{error.class} error:#{error}"
+        end
+
         def inspect
           "#{super}, error_type:#{error.class} error:#{error}"
         end

data/lib/datadog/di/code_tracker.rb

@@ -140,16 +140,23 @@ module Datadog
           exact = registry[suffix]
           return [suffix, exact] if exact
 
-          inexact = []
-          registry.each do |path, iseq|
-            if Utils.path_matches_suffix?(path, suffix)
-              inexact << [path, iseq]
+          suffix = suffix.dup
+          loop do
+            inexact = []
+            registry.each do |path, iseq|
+              if Utils.path_matches_suffix?(path, suffix)
+                inexact << [path, iseq]
+              end
             end
+            if inexact.length > 1
+              raise Error::MultiplePathsMatch, "Multiple paths matched requested suffix"
+            end
+            if inexact.any?
+              return inexact.first
+            end
+            return nil unless suffix.include?('/')
+            suffix.sub!(%r{.*/+}, '')
           end
-          if inexact.length > 1
-            raise Error::MultiplePathsMatch, "Multiple paths matched requested suffix"
-          end
-          inexact.first
         end
       end
 

data/lib/datadog/di/component.rb

@@ -74,8 +74,10 @@ module Datadog
       def initialize(settings, agent_settings, logger, code_tracker: nil, telemetry: nil)
         @settings = settings
         @agent_settings = agent_settings
+        logger = DI::Logger.new(settings, logger)
         @logger = logger
         @telemetry = telemetry
+        @code_tracker = code_tracker
         @redactor = Redactor.new(settings)
         @serializer = Serializer.new(settings, redactor, telemetry: telemetry)
         @instrumenter = Instrumenter.new(settings, serializer, logger, code_tracker: code_tracker, telemetry: telemetry)
@@ -90,6 +92,7 @@ module Datadog
       attr_reader :agent_settings
       attr_reader :logger
       attr_reader :telemetry
+      attr_reader :code_tracker
       attr_reader :instrumenter
       attr_reader :transport
       attr_reader :probe_notifier_worker

data/lib/datadog/di/configuration/settings.rb

@@ -188,6 +188,20 @@ module Datadog
                   o.type :bool
                   o.default false
                 end
+
+                # Enable logging of dynamic instrumentation activity.
+                # This is quite verbose.
+                option :trace_logging do |o|
+                  o.type :bool
+                  o.default false
+
+                  # Use the same environment variable as the rest of
+                  # dd-trace-rb logging for now. Could change to a
+                  # dedicated environment variable in the future but
+                  # will likely need a way to turn on remote config
+                  # debugging (since DI uses RC for configuration).
+                  o.env 'DD_TRACE_DEBUG'
+                end
               end
             end
           end

data/lib/datadog/di/contrib.rb

@@ -7,6 +7,7 @@ module Datadog
     module Contrib
       module_function def load_now_or_later
         if Datadog::Core::Contrib::Rails::Utils.railtie_supported?
+          Datadog.logger.debug('di: loading contrib/railtie')
           require_relative 'contrib/railtie'
         else
           load_now
@@ -18,6 +19,7 @@ module Datadog
       # dependencies are loaded (or potentially loaded).
       module_function def load_now
         if defined?(ActiveRecord::Base)
+          Datadog.logger.debug('di: loading contrib/active_record')
           require_relative 'contrib/active_record'
         end
       end

data/lib/datadog/di/logger.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Datadog
+  module DI
+    # Logger facade to add the +trace+ method.
+    #
+    # @api private
+    class Logger
+      extend Forwardable # steep:ignore
+
+      def initialize(settings, target)
+        @settings = settings
+        @target = target
+      end
+
+      attr_reader :settings
+      attr_reader :target
+
+      def_delegators :target, :debug # steep:ignore
+
+      def trace(&block)
+        if settings.dynamic_instrumentation.internal.trace_logging
+          debug(&block)
+        end
+      end
+    end
+  end
+end

data/lib/datadog/di/probe.rb

@@ -155,11 +155,8 @@ module Datadog
       # Returns whether the provided +path+ matches the user-designated
       # file (of a line probe).
       #
-      # If file is an absolute path (i.e., it starts with a slash), the file
-      # must be identical to path to match.
-      #
-      # If file is not an absolute path, the path matches if the file is its suffix,
-      # at a path component boundary.
+      # Delegates to Utils.path_can_match_spec? which performs fuzzy
+      # matching. See the comments in utils.rb for details.
       def file_matches?(path)
         if path.nil?
           raise ArgumentError, "Cannot match against a nil path"
@@ -167,7 +164,7 @@ module Datadog
         unless file
           raise ArgumentError, "Probe does not have a file to match against"
         end
-        Utils.path_matches_suffix?(path, file)
+        Utils.path_can_match_spec?(path, file)
       end
 
       # Instrumentation module for method probes.

data/lib/datadog/di/probe_manager.rb

@@ -111,9 +111,11 @@ module Datadog
             # Always remove from pending list here because it makes the
             # API smaller and shouldn't cause any actual problems.
             @pending_probes.delete(probe.id)
+            logger.trace { "di: installed #{probe.type} probe at #{probe.location} (#{probe.id})" }
             true
           rescue Error::DITargetNotDefined
             @pending_probes[probe.id] = probe
+            logger.trace { "di: could not install #{probe.type} probe at #{probe.location} (#{probe.id}) because its target is not defined, adding it to pending list" }
             false
           end
         rescue => exc
@@ -160,7 +162,7 @@ module Datadog
                 raise if settings.dynamic_instrumentation.internal.propagate_all_exceptions
                 # Silence all exceptions?
                 # TODO should we propagate here and rescue upstream?
-                logger.debug { "di: error removing probe #{probe.id}: #{exc.class}: #{exc}" }
+                logger.debug { "di: error removing #{probe.type} probe at #{probe.location} (#{probe.id}): #{exc.class}: #{exc}" }
                 telemetry&.report(exc, description: "Error removing probe")
               end
             end
@@ -190,7 +192,7 @@ module Datadog
                 rescue => exc
                   raise if settings.dynamic_instrumentation.internal.propagate_all_exceptions
 
-                  logger.debug { "di: error installing probe after class is defined: #{exc.class}: #{exc}" }
+                  logger.debug { "di: error installing #{probe.type} probe at #{probe.location} (#{probe.id}) after class is defined: #{exc.class}: #{exc}" }
                   telemetry&.report(exc, description: "Error installing probe after class is defined")
                 end
               end
@@ -228,6 +230,7 @@ module Datadog
       # backend (once per the probe's lifetime) and a snapshot corresponding
       # to the current invocation.
       def probe_executed_callback(probe:, **opts)
+        logger.trace { "di: executed #{probe.type} probe at #{probe.location} (#{probe.id})" }
         unless probe.emitting_notified?
           payload = probe_notification_builder.build_emitting(probe)
           probe_notifier_worker.add_status(payload)

data/lib/datadog/di/probe_notification_builder.rb

@@ -32,6 +32,12 @@ module Datadog
           status: 'EMITTING',)
       end
 
+      def build_errored(probe, exc)
+        build_status(probe,
+          message: "Instrumentation for probe #{probe.id} failed: #{exc}",
+          status: 'ERROR',)
+      end
+
       # Duration is in seconds.
       def build_executed(probe,
         trace_point: nil, rv: nil, duration: nil, caller_locations: nil,

data/lib/datadog/di/probe_notifier_worker.rb

@@ -10,7 +10,7 @@ module Datadog
     # The loop inside the worker rescues all exceptions to prevent termination
     # due to unhandled exceptions raised by any downstream code.
     # This includes communication and protocol errors when sending the
-    # payloads to the agent.
+    # events to the agent.
     #
     # The worker groups the data to send into batches. The goal is to perform
     # no more than one network operation per event type per second.
@@ -36,6 +36,7 @@ module Datadog
         @sleep_remaining = nil
         @wake_scheduled = false
         @thread = nil
+        @pid = nil
         @flush = 0
       end
 
@@ -44,7 +45,8 @@ module Datadog
       attr_reader :telemetry
 
       def start
-        return if @thread
+        return if @thread && @pid == Process.pid
+        logger.trace { "di: starting probe notifier: pid #{$$}" }
         @thread = Thread.new do
           loop do
             # TODO If stop is requested, we stop immediately without
@@ -86,6 +88,7 @@ module Datadog
             wake.wait(more ? min_send_interval : nil)
           end
         end
+        @pid = Process.pid
       end
 
       # Stops the background thread.
@@ -94,6 +97,7 @@ module Datadog
       # to killing the thread using Thread#kill.
       def stop(timeout = 1)
         @stop_requested = true
+        logger.trace { "di: stopping probe notifier: pid #{$$}" }
         wake.signal
         if thread
           unless thread.join(timeout)
@@ -184,8 +188,9 @@ module Datadog
           @lock.synchronize do
             queue = send("#{event_type}_queue")
             if queue.length > settings.dynamic_instrumentation.internal.snapshot_queue_capacity
-              logger.debug { "di: #{self.class.name}: dropping #{event_type} because queue is full" }
+              logger.debug { "di: #{self.class.name}: dropping #{event_type} event because queue is full" }
             else
+              logger.trace { "di: #{self.class.name}: queueing #{event_type} event" }
               queue << event
             end
           end
@@ -200,6 +205,10 @@ module Datadog
               wake.signal
             end
           end
+
+          # Worker could be not running if the process forked - check and
+          # start it again in this case.
+          start
         end
 
         # Determine how much longer the worker thread should sleep
@@ -232,8 +241,10 @@ module Datadog
             instance_variable_set("@#{event_type}_queue", [])
             @io_in_progress = batch.any? # steep:ignore
           end
+          logger.trace { "di: #{self.class.name}: checking #{event_type} queue - #{batch.length} entries" } # steep:ignore
           if batch.any? # steep:ignore
             begin
+              logger.trace { "di: sending #{batch.length} #{event_type} event(s) to agent" } # steep:ignore
               transport.public_send("send_#{event_type}", batch)
               time = Core::Utils::Time.get_time
               @lock.synchronize do
@@ -263,7 +274,7 @@ module Datadog
 
       def maybe_send
         rv = maybe_send_status
-        rv || maybe_send_snapshot
+        maybe_send_snapshot || rv
       end
     end
   end

data/lib/datadog/di/redactor.rb

@@ -119,7 +119,6 @@ module Datadog
         "dburl",
         "encryptionkey",
         "encryptionkeyid",
-        "env",
         "geolocation",
         "gpgkey",
         "ipaddress",