ddtrace 0.48.0 → 0.51.1

data/lib/ddtrace/transport/http.rb

@@ -1,8 +1,8 @@
 require 'ddtrace/version'
-require 'ddtrace/ext/runtime'
+require 'datadog/core/environment/ext'
 require 'ddtrace/ext/transport'
 
-require 'ddtrace/runtime/container'
+require 'datadog/core/environment/container'
 
 require 'ddtrace/transport/http/builder'
 require 'ddtrace/transport/http/api'
@@ -25,11 +25,23 @@ 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: Datadog::Configuration::AgentSettingsResolver::ENVIRONMENT_AGENT_SETTINGS, **options)
         new do |transport|
-          transport.adapter default_adapter, default_hostname, default_port, timeout: 1
+          transport.adapter(
+            default_adapter,
+            agent_settings.hostname,
+            agent_settings.port,
+            timeout: agent_settings.timeout_seconds,
+            ssl: agent_settings.ssl
+          )
           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
@@ -38,42 +50,28 @@ module Datadog
 
           # Apply any settings given by options
           unless options.empty?
-            # Change hostname/port
-            if [:hostname, :port, :timeout, :ssl].any? { |key| options.key?(key) }
-              hostname = options[:hostname] || default_hostname
-              port = options[:port] || default_port
-
-              adapter_options = { timeout: 1 }
-              adapter_options[:timeout] = options[:timeout] if options.key?(:timeout)
-              adapter_options[:ssl] = options[:ssl] if options.key?(:ssl)
-
-              transport.adapter default_adapter, hostname, port, adapter_options
-            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::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
         }.tap do |headers|
           # Add container ID, if present.
-          container_id = Datadog::Runtime::Container.container_id
+          container_id = Datadog::Core::Environment::Container.container_id
           headers[Datadog::Ext::Transport::HTTP::HEADER_CONTAINER_ID] = container_id unless container_id.nil?
         end
       end
@@ -82,26 +80,31 @@ module Datadog
         :net_http
       end
 
-      def default_hostname
-        return default_url.hostname if default_url
+      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.'
+        )
 
-        ENV.fetch(Datadog::Ext::Transport::HTTP::ENV_DEFAULT_HOST, Datadog::Ext::Transport::HTTP::DEFAULT_HOST)
+        Datadog::Configuration::AgentSettingsResolver::ENVIRONMENT_AGENT_SETTINGS.hostname
       end
 
-      def default_port
-        return default_url.port if default_url
+      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.'
+        )
 
-        ENV.fetch(Datadog::Ext::Transport::HTTP::ENV_DEFAULT_PORT, Datadog::Ext::Transport::HTTP::DEFAULT_PORT).to_i
+        Datadog::Configuration::AgentSettingsResolver::ENVIRONMENT_AGENT_SETTINGS.port
       end
 
-      def default_url
-        url_env = ENV.fetch(Datadog::Ext::Transport::HTTP::ENV_DEFAULT_URL, nil)
+      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.'
+        )
 
-        if url_env
-          uri_parsed = URI.parse(url_env)
-
-          uri_parsed if %w[http https].include?(uri_parsed.scheme)
-        end
+        nil
       end
 
       # Add adapters to registry

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

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

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

@@ -133,9 +133,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/io/traces.rb

@@ -90,7 +90,7 @@ module Datadog
         end
 
         # Add traces behavior to transport components
-        IO::Client.send(:include, Traces::Client)
+        IO::Client.include(Traces::Client)
       end
     end
   end

data/lib/ddtrace/utils/forking.rb

@@ -3,7 +3,7 @@ module Datadog
     # Helper methods for managing forking behavior
     module Forking
       def self.included(base)
-        base.send(:prepend, ClassExtensions) if base.is_a?(Class)
+        base.prepend(ClassExtensions) if base.is_a?(Class)
       end
 
       def self.extended(base)

data/lib/ddtrace/utils/object_set.rb

@@ -16,12 +16,10 @@ module Datadog
       # If they match an existing message, it will return the
       # matching object. If it doesn't match, it will yield to
       # the block with the next ID & args given.
-      def fetch(*args, &block)
+      def fetch(*args)
+        # TODO: Array hashing is **really** expensive, we probably want to get rid of it in the future
         key = @key_block ? @key_block.call(*args) : args.hash
-        # TODO: Ruby 2.0 doesn't like yielding here... switch when 2.0 is dropped.
-        # rubocop:disable Performance/RedundantBlockCall
-        @items[key] ||= block.call(@sequence.next, *args)
-        # rubocop:enable Performance/RedundantBlockCall
+        @items[key] ||= yield(@sequence.next, *args)
       end
 
       def length

data/lib/ddtrace/utils/time.rb

@@ -2,8 +2,6 @@ module Datadog
   module Utils
     # Common database-related utility functions.
     module Time
-      PROCESS_TIME_SUPPORTED = Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.1.0')
-
       module_function
 
       # Current monotonic time.
@@ -12,7 +10,7 @@ module Datadog
       #
       # @return [Float] in seconds, since some unspecified starting point
       def get_time
-        PROCESS_TIME_SUPPORTED ? Process.clock_gettime(Process::CLOCK_MONOTONIC) : now.to_f
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
       end
 
       # Current wall time.

data/lib/ddtrace/version.rb

@@ -1,14 +1,24 @@
 module Datadog
   module VERSION
     MAJOR = 0
-    MINOR = 48
-    PATCH = 0
+    MINOR = 51
+    PATCH = 1
     PRE = nil
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
 
-    # Support for Ruby < 2.1 is currently deprecated in the tracer.
-    # Support will be dropped in the near future.
-    MINIMUM_RUBY_VERSION = '2.0.0'.freeze
+    MINIMUM_RUBY_VERSION = '2.1.0'.freeze
+
+    # Ruby 3.2 is not supported: Ruby 3.x support as implemented using *args
+    # needs ruby2_keywords to continue working, yet the scheduled removal of
+    # ruby2_keywords when Ruby 2.6 is EOL'd (i.e on Ruby 3.2 release) would
+    # leave the code with no option, other than to move to *args, **kwargs.
+    #
+    # See https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/
+    #
+    # This constraint can only be removed when the dependency on ruby2_keywords is
+    # dropped. An allowance is nonetheless made to test prerelease versions.
+    # The version constraint may be bumped if the removal is postponed.
+    MAXIMUM_RUBY_VERSION = '3.2'.freeze
   end
 end

data/lib/ddtrace/workers.rb

@@ -69,7 +69,7 @@ module Datadog
           return if @run
 
           @run = true
-          Datadog.logger.debug("Starting thread in the process: #{Process.pid}")
+          Datadog.logger.debug { "Starting thread for: #{self}" }
           @worker = Thread.new { perform }
           @worker.name = self.class.name unless Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3')
 

data/lib/ddtrace/workers/async.rb

@@ -12,7 +12,7 @@ module Datadog
         SHUTDOWN_TIMEOUT = 1
 
         def self.included(base)
-          base.send(:prepend, PrependedMethods)
+          base.prepend(PrependedMethods)
         end
 
         # Methods that must be prepended
@@ -39,6 +39,7 @@ module Datadog
           return false unless running?
 
           @run_async = false
+          Datadog.logger.debug { "Forcibly terminating worker thread for: #{self}" }
           worker.terminate
           true
         end
@@ -126,7 +127,7 @@ module Datadog
           @run_async = true
           @pid = Process.pid
           @error = nil
-          Datadog.logger.debug("Starting thread in the process: #{Process.pid} for: #{self}")
+          Datadog.logger.debug { "Starting thread for: #{self}" }
 
           @worker = ::Thread.new do
             begin

data/lib/ddtrace/workers/loop.rb

@@ -8,7 +8,7 @@ module Datadog
       BASE_INTERVAL = 1
 
       def self.included(base)
-        base.send(:prepend, PrependedMethods)
+        base.prepend(PrependedMethods)
       end
 
       # Methods that must be prepended
@@ -72,6 +72,14 @@ module Datadog
         self.loop_wait_time = [loop_wait_time * BACK_OFF_RATIO, BACK_OFF_MAX].min
       end
 
+      # Should perform_loop just straight into work, or start by waiting?
+      #
+      # The use case is if we want to report some information (like profiles) from time to time, we may not want to
+      # report empty/zero/some residual value immediately when the worker starts.
+      def loop_wait_before_first_iteration?
+        false
+      end
+
       protected
 
       attr_writer \
@@ -86,7 +94,11 @@ module Datadog
       private
 
       def perform_loop
-        @run_loop = true
+        mutex.synchronize do
+          @run_loop = true
+
+          shutdown.wait(mutex, loop_wait_time) if loop_wait_before_first_iteration?
+        end
 
         loop do
           if work_pending?

data/lib/ddtrace/workers/polling.rb

@@ -8,9 +8,9 @@ module Datadog
       SHUTDOWN_TIMEOUT = 1
 
       def self.included(base)
-        base.send(:include, Workers::IntervalLoop)
-        base.send(:include, Workers::Async::Thread)
-        base.send(:prepend, PrependedMethods)
+        base.include(Workers::IntervalLoop)
+        base.include(Workers::Async::Thread)
+        base.prepend(PrependedMethods)
       end
 
       # Methods that must be prepended
@@ -26,8 +26,14 @@ module Datadog
           stop_loop
           graceful = join(timeout)
 
-          # If timeout and force stop...
-          !graceful && force_stop ? terminate : graceful
+          if !graceful && force_stop
+            Datadog.logger.debug do
+              "Timeout while waiting for worker to finish gracefully, forcing termination for: #{self}"
+            end
+            terminate
+          else
+            graceful
+          end
         else
           false
         end

data/lib/ddtrace/workers/queue.rb

@@ -4,7 +4,7 @@ module Datadog
     # to which items can be queued then dequeued.
     module Queue
       def self.included(base)
-        base.send(:prepend, PrependedMethods)
+        base.prepend(PrependedMethods)
       end
 
       # Methods that must be prepended

data/lib/ddtrace/workers/trace_writer.rb

@@ -16,13 +16,10 @@ module Datadog
       def initialize(options = {})
         transport_options = options.fetch(:transport_options, {})
 
-        transport_options = { on_build: transport_options } if transport_options.is_a?(Proc)
-
-        transport_options[:hostname] = options[:hostname] if options.key?(:hostname)
-        transport_options[:port] = options[:port] if options.key?(:port)
+        transport_options[:agent_settings] = options[:agent_settings] if options.key?(:agent_settings)
 
         @transport = options.fetch(:transport) do
-          Transport::HTTP.default(transport_options)
+          Transport::HTTP.default(**transport_options)
         end
       end
 
@@ -63,7 +60,7 @@ module Datadog
         traces.each do |trace|
           next if trace.first.nil?
 
-          hostname = Datadog::Runtime::Socket.hostname
+          hostname = Datadog::Core::Environment::Socket.hostname
           trace.first.set_tag(Ext::NET::TAG_HOSTNAME, hostname) unless hostname.nil? || hostname.empty?
         end
       end

data/lib/ddtrace/writer.rb

@@ -1,8 +1,9 @@
 require 'json'
 
 require 'ddtrace/ext/net'
-require 'ddtrace/runtime/socket'
+require 'datadog/core/environment/socket'
 
+require 'ddtrace/configuration/agent_settings_resolver'
 require 'ddtrace/transport/http'
 require 'ddtrace/transport/io'
 require 'ddtrace/encoding'
@@ -26,6 +27,8 @@ module Datadog
       @flush_interval = options.fetch(:flush_interval, Workers::AsyncTransport::DEFAULT_FLUSH_INTERVAL)
       transport_options = options.fetch(:transport_options, {})
 
+      transport_options[:agent_settings] = options[:agent_settings] if options.key?(:agent_settings)
+
       # priority sampling
       if options[:priority_sampler]
         @priority_sampler = options[:priority_sampler]
@@ -34,7 +37,7 @@ module Datadog
 
       # transport and buffers
       @transport = options.fetch(:transport) do
-        Transport::HTTP.default(transport_options)
+        Transport::HTTP.default(**transport_options)
       end
 
       # handles the thread creation after an eventual fork
@@ -178,7 +181,7 @@ module Datadog
       traces.each do |trace|
         next if trace.first.nil?
 
-        hostname = Datadog::Runtime::Socket.hostname
+        hostname = Datadog::Core::Environment::Socket.hostname
         trace.first.set_tag(Ext::NET::TAG_HOSTNAME, hostname) unless hostname.nil? || hostname.empty?
       end
     end

data/tasks/update_appraisal_gemfiles.rake

@@ -0,0 +1,36 @@
+TRACER_VERSIONS = %w[
+  2.1
+  2.2
+  2.3
+  2.4
+  2.5
+  2.6
+  2.7
+  3.0
+  jruby-9.2.0.0
+  jruby-9.2-latest
+].freeze
+
+desc 'Installs gems based on Appraisals and Gemfile changes, ' \
+     'accepts list of tracer versions as task argument, defaults to all versions.'
+task :install_appraisal_gemfiles do |_task, args|
+  tracer_version_arg = args.to_a
+  versions = tracer_version_arg.empty? ? TRACER_VERSIONS : tracer_version_arg
+
+  versions.each do |version|
+    sh "docker-compose run --rm tracer-#{version} /bin/bash -c " \
+      "'rm -f Gemfile.lock && bundle install && bundle exec appraisal install'"
+  end
+end
+
+desc 'Update ALL gems based on Appraisals and Gemfile changes, ' \
+     'accepts list of tracer versions as task argument, defaults to all versions.'
+task :update_appraisal_gemfiles do |_task, args|
+  tracer_version_arg = args.to_a
+  versions = tracer_version_arg.empty? ? TRACER_VERSIONS : tracer_version_arg
+
+  versions.each do |version|
+    sh "docker-compose run --rm tracer-#{version} /bin/bash -c " \
+      "'rm -f Gemfile.lock && bundle install && bundle exec appraisal update'"
+  end
+end