ddtrace 0.35.2 → 1.1.0

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

@@ -1,4 +1,7 @@
+# typed: false
+
 require 'net/http'
+require 'ddtrace/transport/ext'
 require 'ddtrace/transport/http/adapters/net'
 
 module Datadog
@@ -7,28 +10,38 @@ 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
+          def open(&block)
             # Open connection
             connection = HTTP.new(
-              filepath,
+              uds_path,
               read_timeout: timeout,
               continue_timeout: timeout
             )
 
-            connection.start do |http|
-              yield(http)
-            end
+            connection.start(&block)
+          end
+
+          def url
+            "http+unix://#{uds_path}?timeout=#{timeout}"
           end
 
           # Re-implements Net:HTTP with underlying Unix socket
@@ -36,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,3 +1,5 @@
+# typed: true
+
 require 'json'
 
 module Datadog

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

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

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

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

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

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

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

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

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

@@ -1,4 +1,6 @@
-require 'ddtrace/encoding'
+# typed: false
+
+require 'datadog/core/encoding'
 
 require 'ddtrace/transport/http/api/map'
 require 'ddtrace/transport/http/api/spec'
@@ -13,7 +15,6 @@ module Datadog
         # Default API versions
         V4 = 'v0.4'.freeze
         V3 = 'v0.3'.freeze
-        V2 = 'v0.2'.freeze
 
         module_function
 
@@ -22,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,3 +1,6 @@
+# typed: true
+
+require 'datadog/core/configuration/agent_settings_resolver'
 require 'ddtrace/transport/http/adapters/registry'
 require 'ddtrace/transport/http/api/map'
 require 'ddtrace/transport/http/api/instance'
@@ -32,13 +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?
-                               registry_klass.new(*args)
+        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, **kwargs)
                              else
-                               type
+                               config
                              end
         end
 
@@ -67,6 +77,7 @@ module Datadog
 
         def default_api=(key)
           raise UnknownApiError, key unless @apis.key?(key)
+
           @default_api = key
         end
 
@@ -93,7 +104,7 @@ module Datadog
               api_options[:headers] = @default_headers.merge((api_options[:headers] || {}))
 
               # Add API::Instance with all settings
-              instances[key] = API::Instance.new(
+              instances[key] = api_instance_class.new(
                 spec,
                 adapter,
                 api_options
@@ -105,6 +116,10 @@ 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

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

@@ -1,3 +1,5 @@
+# typed: true
+
 require 'ddtrace/transport/http/statistics'
 require 'ddtrace/transport/http/env'
 
@@ -26,7 +28,9 @@ module Datadog
 
           response
         rescue StandardError => e
-          message = "Internal error during HTTP transport request. Cause: #{e.message} Location: #{e.backtrace.first}"
+          message =
+            "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,3 +1,5 @@
+# typed: true
+
 module Datadog
   module Transport
     module HTTP
@@ -42,6 +44,14 @@ module Datadog
         def headers=(value)
           self[:headers] = value
         end
+
+        def form
+          self[:form] ||= {}
+        end
+
+        def form=(value)
+          self[:form] = value
+        end
       end
     end
   end

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

@@ -1,4 +1,5 @@
-require 'forwardable'
+# typed: false
+
 require 'ddtrace/transport/response'
 
 module Datadog
@@ -9,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,3 +1,5 @@
+# typed: true
+
 require 'ddtrace/transport/statistics'
 
 module Datadog
@@ -6,8 +8,8 @@ module Datadog
       # Tracks statistics for HTTP transports
       module Statistics
         def self.included(base)
-          base.send(:include, Datadog::Transport::Statistics)
-          base.send(:include, InstanceMethods)
+          base.include(Datadog::Transport::Statistics)
+          base.include(InstanceMethods)
         end
 
         # Instance methods for HTTP statistics
@@ -18,11 +20,24 @@ module Datadog
               # Add status code tag to api.responses metric
               if metrics.key?(:api_responses)
                 (metrics[:api_responses].options[:tags] ||= []).tap do |tags|
-                  tags << "status_code:#{response.code}"
+                  tags << metrics_tag_value(response.code)
                 end
               end
             end
           end
+
+          private
+
+          # The most common status code on a healthy tracer
+          STATUS_CODE_200 = 'status_code:200'.freeze
+
+          def metrics_tag_value(status_code)
+            if status_code == 200
+              STATUS_CODE_200 # DEV Saves string concatenation/creation for common case
+            else
+              "status_code:#{status_code}"
+            end
+          end
         end
       end
     end

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

@@ -1,8 +1,12 @@
+# typed: false
+
 require 'json'
 
 require 'ddtrace/transport/traces'
+require 'ddtrace/transport/http/client'
 require 'ddtrace/transport/http/response'
 require 'ddtrace/transport/http/api/endpoint'
+require 'ddtrace/transport/http/api/instance'
 
 module Datadog
   module Transport
@@ -41,6 +45,7 @@ module Datadog
 
             def send_traces(env, &block)
               raise NoTraceEndpointDefinedError, self if traces.nil?
+
               traces.call(env, &block)
             end
 
@@ -121,9 +126,7 @@ module Datadog
                 # Parse service rates, if configured to do so.
                 if service_rates? && !http_response.payload.to_s.empty?
                   body = JSON.parse(http_response.payload)
-                  if body.is_a?(Hash) && body.key?(SERVICE_RATE_KEY)
-                    options[:service_rates] = body[SERVICE_RATE_KEY]
-                  end
+                  options[:service_rates] = body[SERVICE_RATE_KEY] if body.is_a?(Hash) && body.key?(SERVICE_RATE_KEY)
                 end
               end
 
@@ -134,9 +137,9 @@ module Datadog
         end
 
         # Add traces behavior to transport components
-        HTTP::Client.send(:include, Traces::Client)
-        HTTP::API::Spec.send(:include, Traces::API::Spec)
-        HTTP::API::Instance.send(:include, Traces::API::Instance)
+        HTTP::Client.include(Traces::Client)
+        HTTP::API::Spec.include(Traces::API::Spec)
+        HTTP::API::Instance.include(Traces::API::Instance)
       end
     end
   end

data/lib/ddtrace/transport/http.rb

@@ -1,20 +1,33 @@
-require 'ddtrace/version'
-require 'ddtrace/ext/runtime'
-require 'ddtrace/ext/transport'
+# typed: true
 
-require 'ddtrace/runtime/container'
-
-require 'ddtrace/transport/http/builder'
-require 'ddtrace/transport/http/api'
+require 'uri'
 
+require 'datadog/core/environment/container'
+require 'datadog/core/environment/ext'
+require 'ddtrace/transport/ext'
 require 'ddtrace/transport/http/adapters/net'
 require 'ddtrace/transport/http/adapters/test'
 require 'ddtrace/transport/http/adapters/unix_socket'
+require 'ddtrace/transport/http/api'
+require 'ddtrace/transport/http/builder'
+require 'ddtrace/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
@@ -24,68 +37,82 @@ module Datadog
 
       # Builds a new Transport::HTTP::Client with default settings
       # Pass a block to override any settings.
-      def default(options = {})
+      def default(
+        agent_settings: DO_NOT_USE_ENVIRONMENT_AGENT_SETTINGS,
+        **options
+      )
         new do |transport|
-          transport.adapter :net_http, default_hostname, default_port
+          transport.adapter(agent_settings)
           transport.headers default_headers
 
           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?
-            # Change hostname/port
-            if options.key?(:hostname) || options.key?(:port)
-              hostname = options.fetch(:hostname, default_hostname)
-              port = options.fetch(:port, default_port)
-              transport.adapter :net_http, hostname, port
-            end
-
-            # Change default API
             transport.default_api = options[:api_version] if options.key?(:api_version)
-
-            # Add headers
             transport.headers options[:headers] if options.key?(:headers)
+          end
 
-            # Execute on_build callback
-            options[:on_build].call(transport) if options[:on_build].is_a?(Proc)
+          if agent_settings.deprecated_for_removal_transport_configuration_proc
+            agent_settings.deprecated_for_removal_transport_configuration_proc.call(transport)
           end
 
-          # Call block to apply any customization, if provided.
+          # Call block to apply any customization, if provided
           yield(transport) if block_given?
         end
       end
 
       def default_headers
         {
-          Datadog::Ext::Transport::HTTP::HEADER_META_LANG => Datadog::Ext::Runtime::LANG,
-          Datadog::Ext::Transport::HTTP::HEADER_META_LANG_VERSION => Datadog::Ext::Runtime::LANG_VERSION,
-          Datadog::Ext::Transport::HTTP::HEADER_META_LANG_INTERPRETER => Datadog::Ext::Runtime::LANG_INTERPRETER,
-          Datadog::Ext::Transport::HTTP::HEADER_META_TRACER_VERSION => Datadog::Ext::Runtime::TRACER_VERSION
+          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::Runtime::Container.container_id
-          unless container_id.nil?
-            headers[Datadog::Ext::Transport::HTTP::HEADER_CONTAINER_ID] = container_id
-          end
+          container_id = Datadog::Core::Environment::Container.container_id
+          headers[Datadog::Transport::Ext::HTTP::HEADER_CONTAINER_ID] = container_id unless container_id.nil?
         end
       end
 
-      def default_hostname
-        ENV.fetch(Datadog::Ext::Transport::HTTP::ENV_DEFAULT_HOST, Datadog::Ext::Transport::HTTP::DEFAULT_HOST)
+      def default_adapter
+        Transport::Ext::HTTP::ADAPTER
+      end
+
+      def default_hostname(logger: Datadog.logger)
+        logger.warn(
+          'Deprecated for removal: Using #default_hostname for configuration is deprecated and will ' \
+          'be removed on a future ddtrace release.'
+        )
+
+        DO_NOT_USE_ENVIRONMENT_AGENT_SETTINGS.hostname
       end
 
-      def default_port
-        ENV.fetch(Datadog::Ext::Transport::HTTP::ENV_DEFAULT_PORT, Datadog::Ext::Transport::HTTP::DEFAULT_PORT).to_i
+      def default_port(logger: Datadog.logger)
+        logger.warn(
+          'Deprecated for removal: Using #default_hostname for configuration is deprecated and will ' \
+          'be removed on a future ddtrace release.'
+        )
+
+        DO_NOT_USE_ENVIRONMENT_AGENT_SETTINGS.port
+      end
+
+      def default_url(logger: Datadog.logger)
+        logger.warn(
+          'Deprecated for removal: Using #default_url for configuration is deprecated and will ' \
+          'be removed on a future ddtrace release.'
+        )
+
+        nil
       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,3 +1,5 @@
+# typed: true
+
 require 'ddtrace/transport/statistics'
 require 'ddtrace/transport/io/response'
 
@@ -12,19 +14,24 @@ module Datadog
           :encoder,
           :out
 
-        def initialize(out, encoder)
+        def initialize(out, encoder, options = {})
           @out = out
           @encoder = encoder
+
+          @request_block = options.fetch(:request, method(:send_default_request))
+          @encode_block = options.fetch(:encode, method(:encode_data))
+          @write_block = options.fetch(:write, method(:write_data))
+          @response_block = options.fetch(:response, method(:build_response))
         end
 
         def send_request(request)
           # Write data to IO
           # If block is given, allow it to handle writing
-          # Otherwise use default encoding.
+          # Otherwise do a standard encode/write/response.
           response = if block_given?
                        yield(out, request)
                      else
-                       send_default_request(out, request)
+                       @request_block.call(out, request)
                      end
 
           # Update statistics
@@ -33,7 +40,9 @@ module Datadog
           # Return response
           response
         rescue StandardError => e
-          message = "Internal error during IO transport request. Cause: #{e.message} Location: #{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
@@ -48,8 +57,6 @@ module Datadog
           InternalErrorResponse.new(e)
         end
 
-        protected
-
         def encode_data(encoder, request)
           request.parcel.encode_with(encoder)
         end
@@ -58,17 +65,21 @@ module Datadog
           out.puts(data)
         end
 
+        def build_response(_request, _data, result)
+          IO::Response.new(result)
+        end
+
         private
 
         def send_default_request(out, request)
           # Encode data
-          data = encode_data(encoder, request)
+          data = @encode_block.call(encoder, request)
 
           # Write to IO
-          result = write_data(out, data)
+          result = @write_block.call(out, data)
 
           # Generate a response
-          IO::Response.new(result)
+          @response_block.call(request, data, result)
         end
       end
     end

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

@@ -1,3 +1,5 @@
+# typed: true
+
 require 'ddtrace/transport/response'
 
 module Datadog
@@ -6,14 +8,12 @@ module Datadog
       # Response from HTTP transport for traces
       class Response
         include Transport::Response
-        include Transport::Traces::Response
 
         attr_reader \
           :result
 
-        def initialize(result, trace_count = 1)
+        def initialize(result)
           @result = result
-          @trace_count = trace_count
         end
 
         def ok?