ddtrace 1.14.0 → 1.15.0

data/lib/datadog/core/configuration/option_definition.rb

@@ -11,18 +11,12 @@ module Datadog
 
         attr_reader \
           :default,
-          # experimental_default_proc is used when we want to store a block as part of the option value.
-          # Since this new option is experimental and we might not need it in the near future, I gave it a name that is
-          # clear to the reader that they should not rely on it and that is subject to change.
-          # Currently is only use internally.
-          :experimental_default_proc,
+          :default_proc,
           :env,
           :deprecated_env,
           :env_parser,
-          :delegate_to,
-          :depends_on,
           :name,
-          :on_set,
+          :after_set,
           :resetter,
           :setter,
           :type,
@@ -30,14 +24,12 @@ module Datadog
 
         def initialize(name, meta = {}, &block)
           @default = meta[:default]
-          @experimental_default_proc = meta[:experimental_default_proc]
+          @default_proc = meta[:default_proc]
           @env = meta[:env]
           @deprecated_env = meta[:deprecated_env]
           @env_parser = meta[:env_parser]
-          @delegate_to = meta[:delegate_to]
-          @depends_on = meta[:depends_on] || []
           @name = name.to_sym
-          @on_set = meta[:on_set]
+          @after_set = meta[:after_set]
           @resetter = meta[:resetter]
           @setter = meta[:setter] || block || IDENTITY
           @type = meta[:type]
@@ -62,12 +54,10 @@ module Datadog
             @deprecated_env = nil
             @env_parser = nil
             @default = nil
-            @experimental_default_proc = nil
-            @delegate_to = nil
-            @depends_on = []
+            @default_proc = nil
             @helpers = {}
             @name = name.to_sym
-            @on_set = nil
+            @after_set = nil
             @resetter = nil
             @setter = OptionDefinition::IDENTITY
             @type = nil
@@ -81,10 +71,6 @@ module Datadog
             validate_options!
           end
 
-          def depends_on(*values)
-            @depends_on = values.flatten
-          end
-
           def env(value)
             @env = value
           end
@@ -101,12 +87,8 @@ module Datadog
             @default = block || value
           end
 
-          def experimental_default_proc(&block)
-            @experimental_default_proc = block
-          end
-
-          def delegate_to(&block)
-            @delegate_to = block
+          def default_proc(&block)
+            @default_proc = block
           end
 
           def helper(name, *_args, &block)
@@ -123,8 +105,8 @@ module Datadog
             end
           end
 
-          def on_set(&block)
-            @on_set = block
+          def after_set(&block)
+            @after_set = block
           end
 
           def resetter(&block)
@@ -143,24 +125,20 @@ module Datadog
           end
 
           # For applying options for OptionDefinition
-          # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
           def apply_options!(options = {})
             return if options.nil? || options.empty?
 
             default(options[:default]) if options.key?(:default)
-            experimental_default_proc(&options[:experimental_default_proc]) if options.key?(:experimental_default_proc)
+            default_proc(&options[:default_proc]) if options.key?(:default_proc)
             env(options[:env]) if options.key?(:env)
             deprecated_env(options[:deprecated_env]) if options.key?(:deprecated_env)
             env_parser(&options[:env_parser]) if options.key?(:env_parser)
-            delegate_to(&options[:delegate_to]) if options.key?(:delegate_to)
-            depends_on(*options[:depends_on]) if options.key?(:depends_on)
             lazy(options[:lazy]) if options.key?(:lazy)
-            on_set(&options[:on_set]) if options.key?(:on_set)
+            after_set(&options[:after_set]) if options.key?(:after_set)
             resetter(&options[:resetter]) if options.key?(:resetter)
             setter(&options[:setter]) if options.key?(:setter)
             type(options[:type], **(options[:type_options] || {})) if options.key?(:type)
           end
-          # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
           def to_definition
             OptionDefinition.new(@name, meta)
@@ -169,13 +147,11 @@ module Datadog
           def meta
             {
               default: @default,
-              experimental_default_proc: @experimental_default_proc,
+              default_proc: @default_proc,
               env: @env,
               deprecated_env: @deprecated_env,
               env_parser: @env_parser,
-              delegate_to: @delegate_to,
-              depends_on: @depends_on,
-              on_set: @on_set,
+              after_set: @after_set,
               resetter: @resetter,
               setter: @setter,
               type: @type,
@@ -186,10 +162,10 @@ module Datadog
           private
 
           def validate_options!
-            if !@default.nil? && @experimental_default_proc
+            if !@default.nil? && @default_proc
               raise InvalidOptionError,
-                'Using `default` and `experimental_default_proc` is not allowed. Please use one or the other.' \
-                                'If you want to store a block as the default value use `experimental_default_proc`'\
+                'Using `default` and `default_proc` is not allowed. Please use one or the other.' \
+                                'If you want to store a block as the default value use `default_proc`'\
                                 ' otherwise use `default`'
             end
           end

data/lib/datadog/core/configuration/options.rb

@@ -1,6 +1,6 @@
-require_relative 'option_set'
+# frozen_string_literal: true
+
 require_relative 'option_definition'
-require_relative 'option_definition_set'
 
 module Datadog
   module Core
@@ -18,7 +18,7 @@ module Datadog
         module ClassMethods
           def options
             # Allows for class inheritance of option definitions
-            @options ||= superclass <= Options ? superclass.options.dup : OptionDefinitionSet.new
+            @options ||= superclass <= Options ? superclass.options.dup : {}
           end
 
           protected
@@ -64,7 +64,7 @@ module Datadog
         # @public_api
         module InstanceMethods
           def options
-            @options ||= OptionSet.new
+            @options ||= {}
           end
 
           def set_option(name, value, precedence: Configuration::Option::Precedence::PROGRAMMATIC)
@@ -101,7 +101,7 @@ module Datadog
           end
 
           def reset_options!
-            options.values.each(&:reset)
+            options.each_value(&:reset)
           end
 
           private

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

@@ -103,13 +103,12 @@ module Datadog
             o.env Datadog::Core::Configuration::Ext::Diagnostics::ENV_DEBUG_ENABLED
             o.default false
             o.type :bool
-            o.on_set do |enabled|
+            o.after_set do |enabled|
               # Enable rich debug print statements.
               # We do not need to unnecessarily load 'pp' unless in debugging mode.
               require 'pp' if enabled
             end
           end
-
           # Internal {Datadog::Statsd} metrics collection.
           #
           # @public_api
@@ -177,7 +176,7 @@ module Datadog
           #
           # @return Logger::Severity
           option :instance do |o|
-            o.on_set { |value| set_option(:level, value.level) unless value.nil? }
+            o.after_set { |value| set_option(:level, value.level) unless value.nil? }
           end
 
           # Log level for `Datadog.logger`.
@@ -208,21 +207,16 @@ module Datadog
 
           # @public_api
           settings :advanced do
-            # @deprecated This setting is ignored when CPU Profiling 2.0 is in use, and will be removed on dd-trace-rb 2.0.
+            # @deprecated No longer does anything, and will be removed on dd-trace-rb 2.0.
             #
-            # This should never be reduced, as it can cause the resulting profiles to become biased.
-            # The default should be enough for most services, allowing 16 threads to be sampled around 30 times
-            # per second for a 60 second period.
+            # This was used prior to the GA of the new CPU Profiling 2.0 profiler. The CPU Profiling 2.0 profiler does not
+            # use or need this setting and thus it doesn't do anything.
             option :max_events do |o|
-              o.default 32768
-              o.on_set do |value|
-                if value != 32768
-                  Datadog.logger.warn(
-                    'The profiling.advanced.max_events setting has been deprecated for removal. It no longer does ' \
-                    'anything unless you the `force_enable_legacy_profiler` option is in use. ' \
-                    'Please remove it from your Datadog.configure block.'
-                  )
-                end
+              o.after_set do
+                Datadog.logger.warn(
+                  'The profiling.advanced.max_events setting has been deprecated for removal and no ' \
+                  'longer does anything. Please remove it from your Datadog.configure block.'
+                )
               end
             end
 
@@ -261,7 +255,7 @@ module Datadog
             # This was added as a temporary support option in case of issues with the new `Profiling::HttpTransport` class
             # but we're now confident it's working nicely so we've removed the old code path.
             option :legacy_transport_enabled do |o|
-              o.on_set do
+              o.after_set do
                 Datadog.logger.warn(
                   'The profiling.advanced.legacy_transport_enabled setting has been deprecated for removal and no ' \
                   'longer does anything. Please remove it from your Datadog.configure block.'
@@ -274,7 +268,7 @@ module Datadog
             # This was used prior to the GA of the new CPU Profiling 2.0 profiler. Using CPU Profiling 2.0 is now the
             # default and this doesn't do anything.
             option :force_enable_new_profiler do |o|
-              o.on_set do
+              o.after_set do
                 Datadog.logger.warn(
                   'The profiling.advanced.force_enable_new_profiler setting has been deprecated for removal and no ' \
                   'longer does anything. Please remove it from your Datadog.configure block.'
@@ -282,26 +276,16 @@ module Datadog
               end
             end
 
-            # @deprecated Will be removed for dd-trace-rb 2.0.
-            #
-            # Forces enabling the *legacy* non-CPU Profiling 2.0 profiler.
-            # Do not use unless instructed to by support.
+            # @deprecated No longer does anything, and will be removed on dd-trace-rb 2.0.
             #
-            # @default `DD_PROFILING_FORCE_ENABLE_LEGACY` environment variable, otherwise `false`
+            # This was used prior to the GA of the new CPU Profiling 2.0 profiler. Using CPU Profiling 2.0 is now the
+            # default and this doesn't do anything.
             option :force_enable_legacy_profiler do |o|
-              o.env 'DD_PROFILING_FORCE_ENABLE_LEGACY'
-              o.default false
-              o.type :bool
-              o.on_set do |value|
-                if value
-                  Datadog.logger.warn(
-                    'The profiling.advanced.force_enable_legacy_profiler setting has been deprecated for removal. ' \
-                    'Do not use unless instructed to by support. ' \
-                    'If you needed to use it due to incompatibilities with the CPU Profiling 2.0 profiler, consider ' \
-                    'using the profiling.advanced.no_signals_workaround_enabled setting instead. ' \
-                    'See <https://dtdg.co/ruby-profiler-troubleshooting> for details.'
-                  )
-                end
+              o.after_set do
+                Datadog.logger.warn(
+                  'The profiling.advanced.force_enable_legacy_profiler setting has been deprecated for removal and no ' \
+                  'longer does anything. Please remove it from your Datadog.configure block.'
+                )
               end
             end
 
@@ -330,15 +314,33 @@ module Datadog
 
             # Can be used to enable/disable the Datadog::Profiling.allocation_count feature.
             #
-            # This feature is safe and enabled by default on Ruby 2.x, but
-            # on Ruby 3.x it can break in applications that make use of Ractors due to two Ruby VM bugs:
-            # https://bugs.ruby-lang.org/issues/19112 AND https://bugs.ruby-lang.org/issues/18464.
+            # This feature is safe and enabled by default on Ruby 2.x, but has a few caveats on Ruby 3.x.
+            #
+            # Caveat 1 (severe):
+            # On Ruby versions 3.0 (all), 3.1.0 to 3.1.3, and 3.2.0 to 3.2.2 this is disabled by default because it
+            # can trigger a VM bug that causes a segmentation fault during garbage collection of Ractors
+            # (https://bugs.ruby-lang.org/issues/18464). We don't recommend using this feature on such Rubies.
+            # This bug is fixed on Ruby versions 3.1.4, 3.2.3 and 3.3.0.
+            #
+            # Caveat 2 (annoyance):
+            # On all known versions of Ruby 3.x, due to https://bugs.ruby-lang.org/issues/19112, when a ractor gets
+            # garbage collected, Ruby will disable all active tracepoints, which this feature internally relies on.
+            # Thus this feature is only usable if you're not using Ractors.
             #
-            # If you use Ruby 3.x and your application does not use Ractors (or if your Ruby has been patched), the
-            # feature is fully safe to enable and this toggle can be used to do so.
+            # Caveat 3 (severe):
+            # Ruby 3.2.0 to 3.2.2 have a bug in the newobj tracepoint (https://bugs.ruby-lang.org/issues/19482,
+            # https://github.com/ruby/ruby/pull/7464) so that's an extra reason why it's not safe on those Rubies.
+            # This bug is fixed on Ruby versions 3.2.2 and 3.3.0.
             #
-            # @default `true` on Ruby 2.x, `false` on Ruby 3.x
-            option :allocation_counting_enabled, default: RUBY_VERSION.start_with?('2.')
+            # @default `true` on Ruby 2.x and 3.1.4+, 3.2.3+ and 3.3.0+; `false` for Ruby 3.0 and unpatched Rubies.
+            option :allocation_counting_enabled do |o|
+              o.default do
+                RUBY_VERSION.start_with?('2.') ||
+                  (RUBY_VERSION.start_with?('3.1.') && RUBY_VERSION >= '3.1.4') ||
+                  (RUBY_VERSION.start_with?('3.2.') && RUBY_VERSION >= '3.2.3') ||
+                  RUBY_VERSION >= '3.3.'
+              end
+            end
 
             # Can be used to disable checking which version of `libmysqlclient` is being used by the `mysql2` gem.
             #
@@ -527,10 +529,10 @@ module Datadog
         # @default `->{ Time.now }`
         # @return [Proc<Time>]
         option :time_now_provider do |o|
-          o.experimental_default_proc { ::Time.now }
+          o.default_proc { ::Time.now }
           o.type :proc
 
-          o.on_set do |time_provider|
+          o.after_set do |time_provider|
             Core::Utils::Time.now_provider = time_provider
           end
 

data/lib/datadog/core/environment/execution.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'set'
+
 module Datadog
   module Core
     module Environment
@@ -10,14 +12,29 @@ module Datadog
           # This can be used to make decisions about when to enable
           # background systems like worker threads or telemetry.
           def development?
-            !!(repl? || test? || rails_development?)
+            !!(webmock_enabled? || repl? || test? || rails_development?)
+          end
+
+          # WebMock stores the reference to `Net::HTTP` with constant `OriginalNetHTTP`, and when WebMock enables,
+          # the adapter swaps `Net::HTTP` reference to its mock object, @webMockNetHTTP.
+          #
+          # Hence, we can detect by
+          #   1. Checking if `Net::HTTP` is referring to mock object
+          #   => ::Net::HTTP.equal?(::WebMock::HttpLibAdapters::NetHttpAdapter.instance_variable_get(:@webMockNetHTTP))
+          #
+          #   2. Checking if `Net::HTTP` is referring to the original one
+          #   => ::Net::HTTP.equal?(::WebMock::HttpLibAdapters::NetHttpAdapter::OriginalNetHTTP)
+          def webmock_enabled?
+            defined?(::WebMock::HttpLibAdapters::NetHttpAdapter) &&
+              defined?(::Net::HTTP) &&
+              ::Net::HTTP.equal?(::WebMock::HttpLibAdapters::NetHttpAdapter.instance_variable_get(:@webMockNetHTTP))
           end
 
           private
 
           # Is this process running a test?
           def test?
-            rspec? || minitest?
+            rspec? || minitest? || cucumber?
           end
 
           # Is this process running inside on a Read–eval–print loop?
@@ -49,14 +66,35 @@ module Datadog
                 ::Minitest::Unit.class_variable_get(:@@installed_at_exit))
           end
 
-          # A Rails Spring Ruby process is a bit peculiar: the process is agnostic
-          # whether the application is running as a console or server.
-          # Luckily, the Spring gem *must not* be installed in a production environment so
-          # detecting its presence is enough to deduct if this is a development environment.
-          #
-          # @see https://github.com/rails/spring/blob/48b299348ace2188444489a0c216a6f3e9687281/README.md?plain=1#L204-L207
+          # Check if we are running from `bin/cucumber` or `cucumber/rake/task`.
+          def cucumber?
+            defined?(::Cucumber::Cli)
+          end
+
+          # If this is a Rails application, use different heuristics to detect
+          # whether this is a development environment or not.
           def rails_development?
-            defined?(::Spring)
+            # A Rails Spring Ruby process is a bit peculiar: the process is agnostic
+            # whether the application is running as a console or server.
+            # Luckily, the Spring gem *must not* be installed in a production environment so
+            # detecting its presence is enough to deduct if this is a development environment.
+            #
+            # @see https://github.com/rails/spring/blob/48b299348ace2188444489a0c216a6f3e9687281/README.md?plain=1#L204-L207
+            defined?(::Spring) || rails_env_development?
+          end
+
+          RAILS_ENV_DEVELOPMENT = Set['development', 'test'].freeze
+          private_constant :RAILS_ENV_DEVELOPMENT
+
+          # By default, every Rails application has three environments: `development`, `test`, and `production`.
+          # This has been the case since Rails 3.0.0:
+          # https://github.com/rails/rails/blob/3e48484ff16ea07ffe5db232bf43c14992e273c1/railties/doc/guides/getting_started_with_rails/getting_started_with_rails.txt#L144
+          #
+          # Instead of checking for "not production", we instead check for "development" and "test" because
+          # it's common to have a custom "staging" environment, and such environment normally want to run as close
+          # to production as possible.
+          def rails_env_development?
+            defined?(::Rails.env) && RAILS_ENV_DEVELOPMENT.include?(::Rails.env)
           end
         end
       end

data/lib/datadog/core/environment/variable_helpers.rb

@@ -29,75 +29,6 @@ module Datadog
           end
         end
 
-        # Reads an environment variable as an Integer.
-        #
-        # @param [String] var environment variable
-        # @param [Array<String>] var list of environment variables
-        # @param [Integer] default the default value if the keys in `var` are not present in the environment
-        # @param [Boolean] deprecation_warning when `var` is a list, record a deprecation log when
-        #   the first key in `var` is not used.
-        # @return [Integer] if the environment value is a valid Integer
-        # @return [default] if the environment value is not found
-        def env_to_int(var, default = nil, deprecation_warning: true)
-          var = decode_array(var, deprecation_warning)
-          var && ENV.key?(var) ? ENV[var].to_i : default
-        end
-
-        # Reads an environment variable as a Float.
-        #
-        # @param [String] var environment variable
-        # @param [Array<String>] var list of environment variables
-        # @param [Float] default the default value if the keys in `var` are not present in the environment
-        # @param [Boolean] deprecation_warning when `var` is a list, record a deprecation log when
-        #   the first key in `var` is not used.
-        # @return [Float] if the environment value is a valid Float
-        # @return [default] if the environment value is not found
-        def env_to_float(var, default = nil, deprecation_warning: true)
-          var = decode_array(var, deprecation_warning)
-          var && ENV.key?(var) ? ENV[var].to_f : default
-        end
-
-        # Parses comma- or space-separated lists.
-        #
-        # If a comma is present, then the list is considered comma-separated.
-        # Otherwise, it is considered space-separated.
-        #
-        # After the entries are separated, commas and whitespaces that are
-        # either trailing or leading are trimmed.
-        #
-        # Empty entries, after trimmed, are also removed from the result.
-        #
-        # @param [String] var environment variable
-        # @param [Array<String>] var list of environment variables
-        # @param [Array<Object>] default the default value if the keys in `var` are not present in the environment
-        # @param [Boolean] deprecation_warning when `var` is a list, record a deprecation log when
-        #   the first key in `var` is not used.
-        # @return [Array<Object>] if the environment value is a valid list
-        # @return [default] if the environment value is not found
-        def env_to_list(var, default = [], comma_separated_only:, deprecation_warning: true)
-          var = decode_array(var, deprecation_warning)
-          if var && ENV.key?(var)
-            value = ENV[var]
-
-            values = if value.include?(',') || comma_separated_only
-                       value.split(',')
-                     else
-                       value.split(' ') # rubocop:disable Style/RedundantArgument
-                     end
-
-            values.map! do |v|
-              v.gsub!(/\A[\s,]*|[\s,]*\Z/, '')
-
-              v.empty? ? nil : v
-            end
-
-            values.compact!
-            values
-          else
-            default
-          end
-        end
-
         private
 
         def decode_array(var, deprecation_warning)

data/lib/datadog/core/error.rb

@@ -15,6 +15,7 @@ module Datadog
           when Array then new(*value)
           when Exception then new(value.class, value.message, full_backtrace(value))
           when ContainsMessage then new(value.class, value.message)
+          when String then new(nil, value)
           else BlankError
           end
         end

data/lib/datadog/core/git/ext.rb

@@ -5,6 +5,8 @@ module Datadog
     module Git
       # Defines constants for Git tags
       module Ext
+        GIT_SHA_LENGTH = 40
+
         TAG_BRANCH = 'git.branch'
         TAG_REPOSITORY_URL = 'git.repository_url'
         TAG_TAG = 'git.tag'

data/lib/datadog/core/remote/client/capabilities.rb

@@ -7,7 +7,7 @@ module Datadog
   module Core
     module Remote
       class Client
-        # Capbailities
+        # Capabilities
         class Capabilities
           attr_reader :products, :capabilities, :receivers, :base64_capabilities
 

data/lib/datadog/core/remote/component.rb

@@ -3,7 +3,7 @@
 require_relative 'worker'
 require_relative 'client/capabilities'
 require_relative 'client'
-require_relative '../transport/http'
+require_relative 'transport/http'
 require_relative '../remote'
 require_relative 'negotiation'
 
@@ -22,7 +22,7 @@ module Datadog
           transport_options[:agent_settings] = agent_settings if agent_settings
 
           negotiation = Negotiation.new(settings, agent_settings)
-          transport_v7 = Datadog::Core::Transport::HTTP.v7(**transport_options.dup)
+          transport_v7 = Datadog::Core::Remote::Transport::HTTP.v7(**transport_options.dup)
 
           @barrier = Barrier.new(BARRIER_TIMEOUT)
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../transport/http'
+require_relative 'transport/http'
 
 module Datadog
   module Core
@@ -11,7 +11,7 @@ module Datadog
           transport_options = {}
           transport_options[:agent_settings] = agent_settings if agent_settings
 
-          @transport_root = Datadog::Core::Transport::HTTP.root(**transport_options.dup)
+          @transport_root = Datadog::Core::Remote::Transport::HTTP.root(**transport_options.dup)
           @logged = {}
         end
 

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative '../../../core/transport/request'
+require_relative '../../../core/transport/parcel'
+
+module Datadog
+  module Core
+    module Remote
+      module Transport
+        module Config
+          # Data transfer object for encoded traces
+          class EncodedParcel
+            include Datadog::Core::Transport::Parcel
+
+            def count
+              data.length
+            end
+          end
+
+          # Config request
+          class Request < Datadog::Core::Transport::Request
+          end
+
+          # Config response
+          module Response
+            attr_reader :roots, :targets, :target_files, :client_configs
+
+            def empty?
+              @empty
+            end
+          end
+
+          # Config transport
+          class Transport
+            attr_reader :client, :apis, :default_api, :current_api_id
+
+            def initialize(apis, default_api)
+              @apis = apis
+
+              @client = HTTP::Client.new(current_api)
+            end
+
+            ##### there is only one transport! it's negotiation!
+            def send_config(payload)
+              json = JSON.dump(payload)
+              parcel = EncodedParcel.new(json)
+              request = Request.new(parcel)
+
+              @client.send_config_payload(request)
+            end
+
+            def current_api
+              @apis[HTTP::API::V7]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    module Remote
+      module Transport
+        module HTTP
+          module API
+            # An API configured with adapter and routes
+            class Instance
+              attr_reader \
+                :adapter,
+                :headers,
+                :spec
+
+              def initialize(spec, adapter, options = {})
+                @spec = spec
+                @adapter = adapter
+                @headers = options.fetch(:headers, {})
+              end
+
+              def encoder
+                spec.encoder
+              end
+
+              def call(env)
+                # Add headers to request env, unless empty.
+                env.headers.merge!(headers) unless headers.empty?
+
+                # Send request env to the adapter.
+                adapter.call(env)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end