ddtrace 0.52.0 → 1.8.0

data/lib/ddtrace/transport/ext.rb

@@ -0,0 +1,41 @@
+# typed: true
+
+module Datadog
+  module Transport
+    # @public_api
+    module Ext
+      # @public_api
+      module HTTP
+        ADAPTER = :net_http # DEV: Rename to simply `:http`, as Net::HTTP is an implementation detail.
+        DEFAULT_HOST = '127.0.0.1'.freeze
+        DEFAULT_PORT = 8126
+
+        HEADER_CONTAINER_ID = 'Datadog-Container-ID'.freeze
+        HEADER_DD_API_KEY = 'DD-API-KEY'.freeze
+        # Tells agent that `_dd.top_level` metrics have been set by the tracer.
+        # The agent will not calculate top-level spans but instead trust the tracer tagging.
+        #
+        # This prevents partially flushed traces being mistakenly marked as top-level.
+        #
+        # Setting this header to any non-empty value enables this feature.
+        HEADER_CLIENT_COMPUTED_TOP_LEVEL = 'Datadog-Client-Computed-Top-Level'.freeze
+        HEADER_META_LANG = 'Datadog-Meta-Lang'.freeze
+        HEADER_META_LANG_VERSION = 'Datadog-Meta-Lang-Version'.freeze
+        HEADER_META_LANG_INTERPRETER = 'Datadog-Meta-Lang-Interpreter'.freeze
+        HEADER_META_TRACER_VERSION = 'Datadog-Meta-Tracer-Version'.freeze
+      end
+
+      # @public_api
+      module Test
+        ADAPTER = :test
+      end
+
+      # @public_api
+      module UnixSocket
+        ADAPTER = :unix
+        DEFAULT_PATH = '/var/run/datadog/apm.socket'.freeze
+        DEFAULT_TIMEOUT_SECONDS = 1
+      end
+    end
+  end
+end

data/lib/ddtrace/transport/http/adapters/net.rb

@@ -1,6 +1,7 @@
 # typed: true
-require 'ddtrace/transport/response'
-require 'ddtrace/vendor/multipart-post/net/http/post/multipart'
+
+require_relative '../../response'
+require_relative '../../../../datadog/core/vendor/multipart-post/net/http/post/multipart'
 
 module Datadog
   module Transport
@@ -14,15 +15,26 @@ module Datadog
             :timeout,
             :ssl
 
+          # in seconds
           DEFAULT_TIMEOUT = 30
 
-          def initialize(hostname, port, options = {})
-            @hostname = hostname
-            @port = port
+          # @deprecated Positional parameters are deprecated. Use named parameters instead.
+          def initialize(hostname = nil, port = nil, **options)
+            @hostname = hostname || options.fetch(:hostname)
+            @port = port || options.fetch(:port)
             @timeout = options[:timeout] || DEFAULT_TIMEOUT
             @ssl = options.key?(:ssl) ? options[:ssl] == true : false
           end
 
+          def self.build(agent_settings)
+            new(
+              hostname: agent_settings.hostname,
+              port: agent_settings.port,
+              timeout: agent_settings.timeout_seconds,
+              ssl: agent_settings.ssl
+            )
+          end
+
           def open(&block)
             # DEV Initializing +Net::HTTP+ directly help us avoid expensive
             # options processing done in +Net::HTTP.start+:
@@ -50,7 +62,7 @@ module Datadog
               post = ::Net::HTTP::Post.new(env.path, env.headers)
               post.body = env.body
             else
-              post = ::Datadog::Vendor::Net::HTTP::Post::Multipart.new(
+              post = ::Datadog::Core::Vendor::Net::HTTP::Post::Multipart.new(
                 env.path,
                 env.form,
                 env.headers

data/lib/ddtrace/transport/http/adapters/registry.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Transport
     module HTTP

data/lib/ddtrace/transport/http/adapters/test.rb

@@ -1,5 +1,6 @@
 # typed: true
-require 'ddtrace/transport/response'
+
+require_relative '../../response'
 
 module Datadog
   module Transport
@@ -11,8 +12,10 @@ module Datadog
             :buffer,
             :status
 
-          def initialize(buffer = nil)
-            @buffer = buffer
+          # @param buffer [Array] an optional array that will capture all spans sent to this adapter, defaults to +nil+
+          # @deprecated Positional parameters are deprecated. Use named parameters instead.
+          def initialize(buffer = nil, **options)
+            @buffer = buffer || options[:buffer]
             @mutex = Mutex.new
             @status = 200
           end

data/lib/ddtrace/transport/http/adapters/unix_socket.rb

@@ -1,6 +1,8 @@
 # typed: false
+
 require 'net/http'
-require 'ddtrace/transport/http/adapters/net'
+require_relative '../../ext'
+require_relative 'net'
 
 module Datadog
   module Transport
@@ -8,21 +10,29 @@ module Datadog
       module Adapters
         # Adapter for Unix sockets
         class UnixSocket < Adapters::Net
-          DEFAULT_TIMEOUT = 1
-
           attr_reader \
-            :filepath,
+            :filepath, # DEV(1.0): Rename to `uds_path`
             :timeout
 
-          def initialize(filepath, options = {})
-            @filepath = filepath
-            @timeout = options.fetch(:timeout, DEFAULT_TIMEOUT)
+          alias_method :uds_path, :filepath
+
+          # @deprecated Positional parameters are deprecated. Use named parameters instead.
+          def initialize(uds_path = nil, **options)
+            @filepath = uds_path || options.fetch(:uds_path)
+            @timeout = options[:timeout] || Transport::Ext::UnixSocket::DEFAULT_TIMEOUT_SECONDS
+          end
+
+          def self.build(agent_settings)
+            new(
+              uds_path: agent_settings.uds_path,
+              timeout: agent_settings.timeout_seconds,
+            )
           end
 
           def open(&block)
             # Open connection
             connection = HTTP.new(
-              filepath,
+              uds_path,
               read_timeout: timeout,
               continue_timeout: timeout
             )
@@ -31,7 +41,7 @@ module Datadog
           end
 
           def url
-            "http+unix://#{filepath}?timeout=#{timeout}"
+            "http+unix://#{uds_path}?timeout=#{timeout}"
           end
 
           # Re-implements Net:HTTP with underlying Unix socket
@@ -39,19 +49,21 @@ module Datadog
             DEFAULT_TIMEOUT = 1
 
             attr_reader \
-              :filepath,
+              :filepath, # DEV(1.0): Rename to `uds_path`
               :unix_socket
 
-            def initialize(filepath, options = {})
+            alias_method :uds_path, :filepath
+
+            def initialize(uds_path, options = {})
               super('localhost', 80)
-              @filepath = filepath
+              @filepath = uds_path
               @read_timeout = options.fetch(:read_timeout, DEFAULT_TIMEOUT)
               @continue_timeout = options.fetch(:continue_timeout, DEFAULT_TIMEOUT)
               @debug_output = options[:debug_output] if options.key?(:debug_output)
             end
 
             def connect
-              @unix_socket = UNIXSocket.open(filepath)
+              @unix_socket = UNIXSocket.open(uds_path)
               @socket = ::Net::BufferedIO.new(@unix_socket).tap do |socket|
                 socket.read_timeout = @read_timeout
                 socket.continue_timeout = @continue_timeout

data/lib/ddtrace/transport/http/api/endpoint.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'json'
 
 module Datadog

data/lib/ddtrace/transport/http/api/fallbacks.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 module Datadog
   module Transport
     module HTTP

data/lib/ddtrace/transport/http/api/instance.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Transport
     module HTTP

data/lib/ddtrace/transport/http/api/map.rb

@@ -1,5 +1,6 @@
 # typed: true
-require 'ddtrace/transport/http/api/fallbacks'
+
+require_relative 'fallbacks'
 
 module Datadog
   module Transport

data/lib/ddtrace/transport/http/api/spec.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Transport
     module HTTP

data/lib/ddtrace/transport/http/api.rb

@@ -1,10 +1,11 @@
 # typed: false
-require 'ddtrace/encoding'
 
-require 'ddtrace/transport/http/api/map'
-require 'ddtrace/transport/http/api/spec'
+require_relative '../../../datadog/core/encoding'
 
-require 'ddtrace/transport/http/traces'
+require_relative 'api/map'
+require_relative 'api/spec'
+
+require_relative 'traces'
 
 module Datadog
   module Transport
@@ -14,7 +15,6 @@ module Datadog
         # Default API versions
         V4 = 'v0.4'.freeze
         V3 = 'v0.3'.freeze
-        V2 = 'v0.2'.freeze
 
         module_function
 
@@ -23,23 +23,17 @@ module Datadog
             V4 => Spec.new do |s|
               s.traces = Traces::API::Endpoint.new(
                 '/v0.4/traces'.freeze,
-                Encoding::MsgpackEncoder,
+                Core::Encoding::MsgpackEncoder,
                 service_rates: true
               )
             end,
             V3 => Spec.new do |s|
               s.traces = Traces::API::Endpoint.new(
                 '/v0.3/traces'.freeze,
-                Encoding::MsgpackEncoder
+                Core::Encoding::MsgpackEncoder
               )
             end,
-            V2 => Spec.new do |s|
-              s.traces = Traces::API::Endpoint.new(
-                '/v0.2/traces'.freeze,
-                Encoding::JSONEncoder
-              )
-            end
-          ].with_fallbacks(V4 => V3, V3 => V2)
+          ].with_fallbacks(V4 => V3)
         end
       end
     end

data/lib/ddtrace/transport/http/builder.rb

@@ -1,8 +1,10 @@
 # typed: true
-require 'ddtrace/transport/http/adapters/registry'
-require 'ddtrace/transport/http/api/map'
-require 'ddtrace/transport/http/api/instance'
-require 'ddtrace/transport/http/client'
+
+require_relative '../../../datadog/core/configuration/agent_settings_resolver'
+require_relative 'adapters/registry'
+require_relative 'api/map'
+require_relative 'api/instance'
+require_relative 'client'
 
 module Datadog
   module Transport
@@ -33,14 +35,20 @@ module Datadog
           yield(self) if block_given?
         end
 
-        def adapter(type, *args)
-          @default_adapter = if type.is_a?(Symbol)
-                               registry_klass = REGISTRY.get(type)
-                               raise UnknownAdapterError, type if registry_klass.nil?
+        def adapter(config, *args, **kwargs)
+          @default_adapter = case config
+                             when Core::Configuration::AgentSettingsResolver::AgentSettings
+                               registry_klass = REGISTRY.get(config.adapter)
+                               raise UnknownAdapterError, config.adapter if registry_klass.nil?
+
+                               registry_klass.build(config)
+                             when Symbol
+                               registry_klass = REGISTRY.get(config)
+                               raise UnknownAdapterError, config if registry_klass.nil?
 
-                               registry_klass.new(*args)
+                               registry_klass.new(*args, **kwargs)
                              else
-                               type
+                               config
                              end
         end
 

data/lib/ddtrace/transport/http/client.rb

@@ -1,6 +1,7 @@
 # typed: true
-require 'ddtrace/transport/http/statistics'
-require 'ddtrace/transport/http/env'
+
+require_relative 'statistics'
+require_relative 'env'
 
 module Datadog
   module Transport
@@ -28,7 +29,8 @@ module Datadog
           response
         rescue StandardError => e
           message =
-            "Internal error during HTTP transport request. Cause: #{e.message} Location: #{Array(e.backtrace).first}"
+            "Internal error during #{self.class.name} request. Cause: #{e.class.name} #{e.message} " \
+            "Location: #{Array(e.backtrace).first}"
 
           # Log error
           if stats.consecutive_errors > 0

data/lib/ddtrace/transport/http/env.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Transport
     module HTTP

data/lib/ddtrace/transport/http/response.rb

@@ -1,6 +1,6 @@
 # typed: false
-require 'forwardable'
-require 'ddtrace/transport/response'
+
+require_relative '../response'
 
 module Datadog
   module Transport
@@ -10,13 +10,44 @@ module Datadog
       # Used by endpoints to wrap responses from adapters with
       # fields or behavior that's specific to that endpoint.
       module Response
-        extend ::Forwardable
-
         def initialize(http_response)
           @http_response = http_response
         end
 
-        def_delegators :@http_response, *Datadog::Transport::Response.instance_methods
+        # (see Datadog::Transport::Response#payload)
+        def payload
+          @http_response.payload
+        end
+
+        # (see Datadog::Transport::Response#internal_error?)
+        def internal_error?
+          @http_response.internal_error?
+        end
+
+        # (see Datadog::Transport::Response#unsupported?)
+        def unsupported?
+          @http_response.unsupported?
+        end
+
+        # (see Datadog::Transport::Response#ok?)
+        def ok?
+          @http_response.ok?
+        end
+
+        # (see Datadog::Transport::Response#not_found?)
+        def not_found?
+          @http_response.not_found?
+        end
+
+        # (see Datadog::Transport::Response#client_error?)
+        def client_error?
+          @http_response.client_error?
+        end
+
+        # (see Datadog::Transport::Response#server_error?)
+        def server_error?
+          @http_response.server_error?
+        end
 
         def code
           @http_response.respond_to?(:code) ? @http_response.code : nil

data/lib/ddtrace/transport/http/statistics.rb

@@ -1,5 +1,6 @@
 # typed: true
-require 'ddtrace/transport/statistics'
+
+require_relative '../statistics'
 
 module Datadog
   module Transport

data/lib/ddtrace/transport/http/traces.rb

@@ -1,9 +1,12 @@
 # typed: false
+
 require 'json'
 
-require 'ddtrace/transport/traces'
-require 'ddtrace/transport/http/response'
-require 'ddtrace/transport/http/api/endpoint'
+require_relative '../traces'
+require_relative 'client'
+require_relative 'response'
+require_relative 'api/endpoint'
+require_relative 'api/instance'
 
 module Datadog
   module Transport

data/lib/ddtrace/transport/http.rb

@@ -1,24 +1,35 @@
-# typed: true
-require 'ddtrace/version'
-require 'datadog/core/environment/ext'
-require 'ddtrace/ext/transport'
-
-require 'datadog/core/environment/container'
+# frozen_string_literal: true
 
-require 'ddtrace/transport/http/builder'
-require 'ddtrace/transport/http/api'
+# typed: true
 
-require 'ddtrace/transport/http/adapters/net'
-require 'ddtrace/transport/http/adapters/test'
-require 'ddtrace/transport/http/adapters/unix_socket'
 require 'uri'
 
+require_relative '../../datadog/core/environment/container'
+require_relative '../../datadog/core/environment/ext'
+require_relative 'ext'
+require_relative 'http/adapters/net'
+require_relative 'http/adapters/test'
+require_relative 'http/adapters/unix_socket'
+require_relative 'http/api'
+require_relative 'http/builder'
+require_relative '../version'
+
 module Datadog
   module Transport
     # Namespace for HTTP transport components
     module HTTP
       include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
 
+      # NOTE: Due to... legacy reasons... This class likes having a default `AgentSettings` instance to fall back to.
+      # Because we generate this instance with an empty instance of `Settings`, the resulting `AgentSettings` below
+      # represents only settings specified via environment variables + the usual defaults.
+      #
+      # DO NOT USE THIS IN NEW CODE, as it ignores any settings specified by users via `Datadog.configure`.
+      DO_NOT_USE_ENVIRONMENT_AGENT_SETTINGS = Datadog::Core::Configuration::AgentSettingsResolver.call(
+        Datadog::Core::Configuration::Settings.new,
+        logger: nil,
+      )
+
       module_function
 
       # Builds a new Transport::HTTP::Client
@@ -28,28 +39,18 @@ module Datadog
 
       # Builds a new Transport::HTTP::Client with default settings
       # Pass a block to override any settings.
-      def default(agent_settings: Datadog::Configuration::AgentSettingsResolver::ENVIRONMENT_AGENT_SETTINGS, **options)
+      def default(
+        agent_settings: DO_NOT_USE_ENVIRONMENT_AGENT_SETTINGS,
+        **options
+      )
         new do |transport|
-          transport.adapter(
-            default_adapter,
-            agent_settings.hostname,
-            agent_settings.port,
-            timeout: agent_settings.timeout_seconds,
-            ssl: agent_settings.ssl
-          )
+          transport.adapter(agent_settings)
           transport.headers default_headers
 
-          if agent_settings.deprecated_for_removal_transport_configuration_options
-            # The deprecated_for_removal_transport_configuration_options take precedence over any options the caller
-            # specifies
-            options = options.merge(**agent_settings.deprecated_for_removal_transport_configuration_options)
-          end
-
           apis = API.defaults
 
           transport.api API::V4, apis[API::V4], fallback: API::V3, default: true
-          transport.api API::V3, apis[API::V3], fallback: API::V2
-          transport.api API::V2, apis[API::V2]
+          transport.api API::V3, apis[API::V3]
 
           # Apply any settings given by options
           unless options.empty?
@@ -68,19 +69,20 @@ module Datadog
 
       def default_headers
         {
-          Datadog::Ext::Transport::HTTP::HEADER_META_LANG => Datadog::Core::Environment::Ext::LANG,
-          Datadog::Ext::Transport::HTTP::HEADER_META_LANG_VERSION => Datadog::Core::Environment::Ext::LANG_VERSION,
-          Datadog::Ext::Transport::HTTP::HEADER_META_LANG_INTERPRETER => Datadog::Core::Environment::Ext::LANG_INTERPRETER,
-          Datadog::Ext::Transport::HTTP::HEADER_META_TRACER_VERSION => Datadog::Core::Environment::Ext::TRACER_VERSION
+          Datadog::Transport::Ext::HTTP::HEADER_CLIENT_COMPUTED_TOP_LEVEL => '1',
+          Datadog::Transport::Ext::HTTP::HEADER_META_LANG => Datadog::Core::Environment::Ext::LANG,
+          Datadog::Transport::Ext::HTTP::HEADER_META_LANG_VERSION => Datadog::Core::Environment::Ext::LANG_VERSION,
+          Datadog::Transport::Ext::HTTP::HEADER_META_LANG_INTERPRETER => Datadog::Core::Environment::Ext::LANG_INTERPRETER,
+          Datadog::Transport::Ext::HTTP::HEADER_META_TRACER_VERSION => Datadog::Core::Environment::Ext::TRACER_VERSION
         }.tap do |headers|
           # Add container ID, if present.
           container_id = Datadog::Core::Environment::Container.container_id
-          headers[Datadog::Ext::Transport::HTTP::HEADER_CONTAINER_ID] = container_id unless container_id.nil?
+          headers[Datadog::Transport::Ext::HTTP::HEADER_CONTAINER_ID] = container_id unless container_id.nil?
         end
       end
 
       def default_adapter
-        :net_http
+        Transport::Ext::HTTP::ADAPTER
       end
 
       def default_hostname(logger: Datadog.logger)
@@ -89,7 +91,7 @@ module Datadog
           'be removed on a future ddtrace release.'
         )
 
-        Datadog::Configuration::AgentSettingsResolver::ENVIRONMENT_AGENT_SETTINGS.hostname
+        DO_NOT_USE_ENVIRONMENT_AGENT_SETTINGS.hostname
       end
 
       def default_port(logger: Datadog.logger)
@@ -98,7 +100,7 @@ module Datadog
           'be removed on a future ddtrace release.'
         )
 
-        Datadog::Configuration::AgentSettingsResolver::ENVIRONMENT_AGENT_SETTINGS.port
+        DO_NOT_USE_ENVIRONMENT_AGENT_SETTINGS.port
       end
 
       def default_url(logger: Datadog.logger)
@@ -111,9 +113,9 @@ module Datadog
       end
 
       # Add adapters to registry
-      Builder::REGISTRY.set(Adapters::Net, :net_http)
-      Builder::REGISTRY.set(Adapters::Test, :test)
-      Builder::REGISTRY.set(Adapters::UnixSocket, :unix)
+      Builder::REGISTRY.set(Adapters::Net, Transport::Ext::HTTP::ADAPTER)
+      Builder::REGISTRY.set(Adapters::Test, Transport::Ext::Test::ADAPTER)
+      Builder::REGISTRY.set(Adapters::UnixSocket, Transport::Ext::UnixSocket::ADAPTER)
     end
   end
 end

data/lib/ddtrace/transport/io/client.rb

@@ -1,6 +1,7 @@
 # typed: true
-require 'ddtrace/transport/statistics'
-require 'ddtrace/transport/io/response'
+
+require_relative '../statistics'
+require_relative 'response'
 
 module Datadog
   module Transport
@@ -39,7 +40,9 @@ module Datadog
           # Return response
           response
         rescue StandardError => e
-          message = "Internal error during IO transport request. Cause: #{e.message} Location: #{Array(e.backtrace).first}"
+          message =
+            "Internal error during IO transport request. Cause: #{e.class.name} #{e.message} " \
+            "Location: #{Array(e.backtrace).first}"
 
           # Log error
           if stats.consecutive_errors > 0

data/lib/ddtrace/transport/io/response.rb

@@ -1,5 +1,6 @@
 # typed: true
-require 'ddtrace/transport/response'
+
+require_relative '../response'
 
 module Datadog
   module Transport

data/lib/ddtrace/transport/io/traces.rb

@@ -1,8 +1,9 @@
 # typed: false
-require 'ddtrace/transport/traces'
 
-require 'ddtrace/transport/io/response'
-require 'ddtrace/transport/io/client'
+require_relative '../traces'
+
+require_relative 'response'
+require_relative 'client'
 
 module Datadog
   module Transport
@@ -67,7 +68,7 @@ module Datadog
 
           def encode_trace(trace)
             # Convert each trace to hash
-            trace.map(&:to_hash).tap do |spans|
+            trace.spans.map(&:to_hash).tap do |spans|
               # Convert IDs to hexadecimal
               spans.each do |span|
                 ENCODED_IDS.each do |id|

data/lib/ddtrace/transport/io.rb

@@ -1,7 +1,8 @@
 # typed: true
-require 'ddtrace/encoding'
-require 'ddtrace/transport/io/client'
-require 'ddtrace/transport/io/traces'
+
+require_relative '../../datadog/core/encoding'
+require_relative 'io/client'
+require_relative 'io/traces'
 
 module Datadog
   module Transport
@@ -19,7 +20,7 @@ module Datadog
       def default(options = {})
         new(
           options.fetch(:out, $stdout),
-          options.fetch(:encoder, Encoding::JSONEncoder)
+          options.fetch(:encoder, Core::Encoding::JSONEncoder)
         )
       end
     end

data/lib/ddtrace/transport/parcel.rb

@@ -1,7 +1,9 @@
 # typed: true
+
 module Datadog
   module Transport
     # Data transfer object for generic data
+    # @abstract
     module Parcel
       include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)