datadog 2.36.0 → 2.40.0

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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'event'
+require_relative "event"
 
-require_relative '../utils/only_once_successful'
-require_relative '../workers/polling'
-require_relative '../workers/queue'
+require_relative "../utils/only_once_successful"
+require_relative "../workers/polling"
+require_relative "../workers/queue"
 
 module Datadog
   module Core
@@ -239,7 +239,7 @@ module Datadog
         end
 
         def buffer_klass
-          if Core::Environment::Ext::RUBY_ENGINE == 'ruby'
+          if Core::Environment::Ext::RUBY_ENGINE == "ruby"
             Core::Buffer::CRuby
           else
             Core::Buffer::ThreadSafe
@@ -254,7 +254,7 @@ module Datadog
         def disable_on_not_found!(response)
           return unless response.not_found?
 
-          logger.debug('Agent does not support telemetry; disabling future telemetry events.')
+          logger.debug("Agent does not support telemetry; disabling future telemetry events.")
           disable!
         end
 

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

@@ -1,35 +1,35 @@
 # frozen_string_literal: true
 
-require_relative '../configuration/ext'
+require_relative "../configuration/ext"
 module Datadog
   module Core
     module Transport
       # @public_api
       module Ext
         module HTTP
-          HEADER_CONTAINER_ID = 'Datadog-Container-ID'
-          HEADER_CONTAINER_TAGS_HASH = 'Datadog-Container-Tags-Hash'
-          HEADER_ENTITY_ID = 'Datadog-Entity-ID'
-          HEADER_EXTERNAL_ENV = 'Datadog-External-Env'
-          HEADER_DD_API_KEY = 'DD-API-KEY'
+          HEADER_CONTAINER_ID = "Datadog-Container-ID"
+          HEADER_CONTAINER_TAGS_HASH = "Datadog-Container-Tags-Hash"
+          HEADER_ENTITY_ID = "Datadog-Entity-ID"
+          HEADER_EXTERNAL_ENV = "Datadog-External-Env"
+          HEADER_DD_API_KEY = "DD-API-KEY"
           # 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'
-          HEADER_CLIENT_COMPUTED_STATS = 'Datadog-Client-Computed-Stats'
-          HEADER_META_LANG = 'Datadog-Meta-Lang'
-          HEADER_META_LANG_VERSION = 'Datadog-Meta-Lang-Version'
-          HEADER_META_LANG_INTERPRETER = 'Datadog-Meta-Lang-Interpreter'
+          HEADER_CLIENT_COMPUTED_TOP_LEVEL = "Datadog-Client-Computed-Top-Level"
+          HEADER_CLIENT_COMPUTED_STATS = "Datadog-Client-Computed-Stats"
+          HEADER_META_LANG = "Datadog-Meta-Lang"
+          HEADER_META_LANG_VERSION = "Datadog-Meta-Lang-Version"
+          HEADER_META_LANG_INTERPRETER = "Datadog-Meta-Lang-Interpreter"
           # Use for distinguishing between CRuby, JRuby, and TruffleRuby.
-          HEADER_META_LANG_INTERPRETER_VENDOR = 'Datadog-Meta-Lang-Interpreter-Vendor'
-          HEADER_META_TRACER_VERSION = 'Datadog-Meta-Tracer-Version'
+          HEADER_META_LANG_INTERPRETER_VENDOR = "Datadog-Meta-Lang-Interpreter-Vendor"
+          HEADER_META_TRACER_VERSION = "Datadog-Meta-Tracer-Version"
 
           # Header that prevents the Net::HTTP integration from tracing internal trace requests.
           # Set it to any value to skip tracing.
-          HEADER_DD_INTERNAL_UNTRACED_REQUEST = 'DD-Internal-Untraced-Request'
+          HEADER_DD_INTERNAL_UNTRACED_REQUEST = "DD-Internal-Untraced-Request"
         end
 
         module Test

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../../../../core/transport/response'
-require_relative '../../../../core/vendor/multipart-post/net/http/post/multipart'
+require_relative "../../../../core/transport/response"
+require_relative "../../../../core/vendor/multipart-post/net/http/post/multipart"
 
 module Datadog
   module Core
@@ -90,9 +90,9 @@ module Datadog
               path = env.path
               case query = env.query
               when Hash
-                path = path + '?' + URI.encode_www_form(query)
+                path = path + "?" + URI.encode_www_form(query)
               when String
-                path = path + '?' + query
+                path = path + "?" + query
               when nil
                 # Nothing
               else

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../../../../core/transport/response'
+require_relative "../../../../core/transport/response"
 
 module Datadog
   module Core

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'net/http'
-require_relative '../../../transport/ext'
-require_relative 'net'
+require "net/http"
+require_relative "../../../transport/ext"
+require_relative "net"
 
 module Datadog
   module Core
@@ -58,7 +58,7 @@ module Datadog
               alias_method :uds_path, :filepath
 
               def initialize(uds_path, options = {})
-                super('localhost', 80)
+                super("localhost", 80)
                 @filepath = uds_path
                 @read_timeout = options.fetch(:read_timeout, DEFAULT_TIMEOUT)
                 @continue_timeout = options.fetch(:continue_timeout, DEFAULT_TIMEOUT)

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'json'
+require "json"
 
 module Datadog
   module Core

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'fallbacks'
+require_relative "fallbacks"
 
 module Datadog
   module Core

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../../configuration/agent_settings'
-require_relative 'adapters/registry'
-require_relative 'api/map'
+require_relative "../../configuration/agent_settings"
+require_relative "adapters/registry"
+require_relative "api/map"
 
 module Datadog
   module Core
@@ -108,7 +108,7 @@ module Datadog
 
                 # Resolve fallback and merge headers
                 fallback = api_options.delete(:fallback)
-                api_options[:headers] = @default_headers.merge((api_options[:headers] || {}))
+                api_options[:headers] = @default_headers.merge(api_options[:headers] || {})
 
                 # Add API::Instance with all settings
                 instances[key] = API::Instance.new(
@@ -171,14 +171,14 @@ module Datadog
           # Raised when built without defining APIs.
           class NoApisError < StandardError
             def message
-              'No APIs configured for transport!'
+              "No APIs configured for transport!"
             end
           end
 
           # Raised when client built without defining a default API.
           class NoDefaultApiError < StandardError
             def message
-              'No default API configured for transport!'
+              "No default API configured for transport!"
             end
           end
         end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'env'
-require_relative '../response'
+require_relative "env"
+require_relative "../response"
 
 module Datadog
   module Core

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../../../core/transport/response'
+require_relative "../../../core/transport/response"
 
 module Datadog
   module Core

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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require_relative 'http/builder'
-require_relative 'http/adapters/net'
-require_relative 'http/adapters/unix_socket'
-require_relative 'http/adapters/test'
-require_relative '../environment/container'
-require_relative '../environment/ext'
+require_relative "http/builder"
+require_relative "http/adapters/net"
+require_relative "http/adapters/unix_socket"
+require_relative "http/adapters/test"
+require_relative "../environment/container"
+require_relative "../environment/ext"
 
 module Datadog
   module Core
@@ -51,7 +51,7 @@ module Datadog
 
         def default_headers
           {
-            Core::Transport::Ext::HTTP::HEADER_CLIENT_COMPUTED_TOP_LEVEL => '1',
+            Core::Transport::Ext::HTTP::HEADER_CLIENT_COMPUTED_TOP_LEVEL => "1",
             Core::Transport::Ext::HTTP::HEADER_META_LANG =>
               Datadog::Core::Environment::Ext::LANG,
             Core::Transport::Ext::HTTP::HEADER_META_LANG_VERSION =>
@@ -70,7 +70,7 @@ module Datadog
             unless Datadog.configuration.apm.tracing.enabled
               # Sending this header to the agent will disable metrics computation (and billing) on the agent side
               # by pretending it has already been done on the library side.
-              headers[Core::Transport::Ext::HTTP::HEADER_CLIENT_COMPUTED_STATS] = 'yes'
+              headers[Core::Transport::Ext::HTTP::HEADER_CLIENT_COMPUTED_STATS] = "yes"
             end
           end
         end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'http/client'
+require_relative "http/client"
 
 module Datadog
   module Core

data/lib/datadog/core/utils/at_fork_monkey_patch.rb

@@ -6,7 +6,13 @@ module Datadog
       # Monkey patches `Kernel#fork` and similar functions, adding an `at_fork` callback mechanism which
       # is used to restart observability after the VM forks (e.g. in multiprocess Ruby apps).
       module AtForkMonkeyPatch
-        AT_FORK_CHILD_BLOCKS = [] # rubocop:disable Style/MutableConstant Used to store blocks to run, mutable by design.
+        AT_FORK_BEFORE_BLOCKS = [] # rubocop:disable Style/MutableConstant -- Used to store blocks to run, mutable by design.
+        private_constant :AT_FORK_BEFORE_BLOCKS
+
+        AT_FORK_PARENT_BLOCKS = [] # rubocop:disable Style/MutableConstant -- Used to store blocks to run, mutable by design.
+        private_constant :AT_FORK_PARENT_BLOCKS
+
+        AT_FORK_CHILD_BLOCKS = [] # rubocop:disable Style/MutableConstant -- Used to store blocks to run, mutable by design.
         private_constant :AT_FORK_CHILD_BLOCKS
 
         def self.supported?
@@ -16,7 +22,7 @@ module Datadog
         def self.apply!
           return false unless supported?
 
-          if RubyVersion.is?('< 3.1')
+          if RubyVersion.is?("< 3.1")
             [
               ::Process.singleton_class, # Process.fork
               ::Kernel.singleton_class,  # Kernel.fork
@@ -32,19 +38,41 @@ module Datadog
         end
 
         def self.run_at_fork_blocks(stage)
-          raise(ArgumentError, "Unsupported stage #{stage}") unless stage == :child
-
-          AT_FORK_CHILD_BLOCKS.each(&:call)
+          blocks_for(stage).each(&:call)
         end
 
+        # Registers a block to run at the given fork +stage+ (+:before+,
+        # +:parent+, or +:child+).
+        #
+        # Returns the registered block so callers can keep a handle to it and
+        # later deregister it via {.remove_at_fork}.
         def self.at_fork(stage, &block)
-          raise(ArgumentError, "Unsupported stage #{stage}") unless stage == :child
-          raise(ArgumentError, 'Missing block argument') unless block
+          raise(ArgumentError, "Missing block argument") unless block
 
-          AT_FORK_CHILD_BLOCKS << block
+          blocks_for(stage) << block
 
-          true
+          block
+        end
+
+        # Deregisters a block previously registered with {.at_fork} for the given
+        # +stage+. It is a no-op (does not raise) when +block+ was never
+        # registered (or was already removed). Raises +ArgumentError+ for an
+        # unknown stage, matching the {.at_fork} contract.
+        def self.remove_at_fork(stage, block)
+          blocks_for(stage).delete(block)
+
+          nil
+        end
+
+        def self.blocks_for(stage)
+          case stage
+          when :before then AT_FORK_BEFORE_BLOCKS
+          when :parent then AT_FORK_PARENT_BLOCKS
+          when :child then AT_FORK_CHILD_BLOCKS
+          else raise(ArgumentError, "Unsupported stage #{stage}")
+          end
         end
+        private_class_method :blocks_for
 
         # Adds `at_fork` behavior; see parent module for details.
         module KernelMonkeyPatch
@@ -59,15 +87,29 @@ module Datadog
               end
             end
 
+            # Run pre-fork callbacks in the parent, just before forking.
+            AtForkMonkeyPatch.run_at_fork_blocks(:before)
+
             # Start fork
             # If a block is provided, use the wrapped version.
-            result = child_block.nil? ? super : super(&child_block)
+            begin
+              result = child_block.nil? ? super : super(&child_block)
+            rescue Exception # rubocop:disable Lint/RescueException -- re-raised unchanged; we only need to run parent cleanup first
+              # The fork failed and we are still in the parent; run `:parent` to
+              # restore any state the `:before` blocks set up, then re-raise.
+              AtForkMonkeyPatch.run_at_fork_blocks(:parent)
+              raise
+            end
 
             # When fork gets called without a block, it returns twice:
             # If we're in the fork, result = nil: trigger child callbacks.
-            # If we're in the parent, result = pid: we do nothing.
+            # If we're in the parent, result = pid: trigger parent callbacks.
             # (If it gets called with a block, it only returns on the parent)
-            AtForkMonkeyPatch.run_at_fork_blocks(:child) if result.nil?
+            if result.nil?
+              AtForkMonkeyPatch.run_at_fork_blocks(:child)
+            else
+              AtForkMonkeyPatch.run_at_fork_blocks(:parent)
+            end
 
             result
           end
@@ -78,9 +120,24 @@ module Datadog
           # Hook provided by Ruby 3.1+ for observability libraries that want to know about fork, see
           # https://github.com/ruby/ruby/pull/5017 and https://bugs.ruby-lang.org/issues/17795
           def _fork
-            pid = super
+            AtForkMonkeyPatch.run_at_fork_blocks(:before)
+
+            begin
+              pid = super
+            rescue Exception # rubocop:disable Lint/RescueException -- re-raised unchanged; we only need to run parent cleanup first
+              # The fork failed, so no child was created and we are still in the
+              # parent. The `:before` blocks already ran (and may hold resources,
+              # e.g. a locked mutex); run the `:parent` blocks so that state is
+              # restored, then re-raise.
+              AtForkMonkeyPatch.run_at_fork_blocks(:parent)
+              raise
+            end
 
-            AtForkMonkeyPatch.run_at_fork_blocks(:child) if pid == 0
+            if pid == 0
+              AtForkMonkeyPatch.run_at_fork_blocks(:child)
+            else
+              AtForkMonkeyPatch.run_at_fork_blocks(:parent)
+            end
 
             pid
           end
@@ -89,8 +146,19 @@ module Datadog
           # keeps executing code in the child process, killing off the parent, thus effectively replacing it.
           # This is not covered by `_fork` and thus we have some extra code for it.
           def daemon(*args)
-            result = super
+            AtForkMonkeyPatch.run_at_fork_blocks(:before)
+
+            begin
+              result = super
+            rescue Exception # rubocop:disable Lint/RescueException -- re-raised unchanged; we only need to run parent cleanup first
+              # `daemon` failed, so the original process survives; run `:parent`
+              # to restore state the `:before` blocks set up, then re-raise.
+              AtForkMonkeyPatch.run_at_fork_blocks(:parent)
+              raise
+            end
 
+            # `daemon` kills the parent, so there is no surviving parent to run
+            # `:parent` callbacks in; only the child continues executing.
             AtForkMonkeyPatch.run_at_fork_blocks(:child)
 
             result

data/lib/datadog/core/utils/base64_codec.rb

@@ -7,15 +7,15 @@ module Datadog
       # which is no longer a default gem since Ruby 3.4.
       module Base64Codec
         def self.encode64(bin)
-          [bin].pack('m')
+          [bin].pack("m")
         end
 
         def self.strict_encode64(bin)
-          [bin].pack('m0')
+          [bin].pack("m0")
         end
 
         def self.strict_decode64(str)
-          str.unpack1('m0') #: String # 'm0' format always returns a String
+          str.unpack1("m0") #: String # 'm0' format always returns a String
         end
       end
     end

data/lib/datadog/core/utils/duration.rb

@@ -6,7 +6,7 @@ module Datadog
       # Helper methods for parsing string values into Numeric
       module Duration
         def self.call(value, base: :s)
-          cast = if value.include?('.')
+          cast = if value.include?(".")
             method(:Float)
           else
             method(:Integer)

data/lib/datadog/core/utils/forking.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../../ruby_version'
+require_relative "../../ruby_version"
 
 module Datadog
   module Core
@@ -47,7 +47,7 @@ module Datadog
           # object will cause forking to not be detected in the fork when it should have.
           #
           # This wrapper prevents this by initializing the fork PID when the object is created.
-          if RubyVersion.is?('>= 3')
+          if RubyVersion.is?(">= 3")
             def initialize(*args, **kwargs, &block)
               super
               update_fork_pid!

data/lib/datadog/core/utils/lru_cache.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module Datadog
   module Core
@@ -16,8 +16,8 @@ module Datadog
         def_delegators :@store, :clear, :empty?
 
         def initialize(max_size)
-          raise ArgumentError, 'max_size must be an Integer' unless max_size.is_a?(Integer)
-          raise ArgumentError, 'max_size must be greater than 0' if max_size <= 0
+          raise ArgumentError, "max_size must be an Integer" unless max_size.is_a?(Integer)
+          raise ArgumentError, "max_size must be greater than 0" if max_size <= 0
 
           @max_size = max_size
           @store = {}

data/lib/datadog/core/utils/network.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'ipaddr'
+require "ipaddr"
 
 module Datadog
   module Core
@@ -21,7 +21,7 @@ module Datadog
           cf-connecting-ipv6
         ].freeze
 
-        CGNAT_IP_RANGE = IPAddr.new('100.64.0.0/10')
+        CGNAT_IP_RANGE = IPAddr.new("100.64.0.0/10")
 
         class << self
           # Returns a client IP associated with the request if it was
@@ -75,8 +75,8 @@ module Datadog
 
               next unless value
 
-              ips = value.split(',')
-              ips = process_forwarded_header_values(ips) if name == 'forwarded'
+              ips = value.split(",")
+              ips = process_forwarded_header_values(ips) if name == "forwarded"
 
               ips.each do |ip|
                 parsed_ip = ip_to_ipaddr(ip.strip)
@@ -92,11 +92,11 @@ module Datadog
             values.each_with_object([]) do |value, acc|
               value.downcase!
 
-              value.split(';').each do |tuple_str|
+              value.split(";").each do |tuple_str|
                 tuple_str.strip!
-                next unless tuple_str.start_with?('for=')
+                next unless tuple_str.start_with?("for=")
 
-                tuple_str.delete_prefix!('for=')
+                tuple_str.delete_prefix!("for=")
                 tuple_str.delete!('"')
 
                 acc << tuple_str
@@ -110,14 +110,14 @@ module Datadog
           # The rationale is that in valid IPv6 addresses, colons will always preced dots,
           #   and in valid IPv4 addresses dots will always preced colons.
           def likely_ipv4?(value)
-            dot_index = value.index('.') || value.size
-            colon_index = value.index(':') || value.size
+            dot_index = value.index(".") || value.size
+            colon_index = value.index(":") || value.size
 
             dot_index < colon_index
           end
 
           def strip_zone_specifier(ipv6)
-            ipv6.gsub(/%.*/, '')
+            ipv6.gsub(/%.*/, "")
           end
 
           def strip_ipv6_port(ip)
@@ -129,7 +129,7 @@ module Datadog
           end
 
           def strip_ipv4_port(ip)
-            ip.gsub(/:\d+\z/, '')
+            ip.gsub(/:\d+\z/, "")
           end
 
           def global_ip?(parsed_ip)

data/lib/datadog/core/utils/only_once_successful.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'only_once'
+require_relative "only_once"
 
 module Datadog
   module Core

data/lib/datadog/core/utils/safe_dup.rb

@@ -22,7 +22,8 @@ module Datadog
           end
         end
 
-        def self.frozen_dup(v)
+        # Steep: https://github.com/soutaro/steep/issues/2001
+        def self.frozen_dup(v) # steep:ignore MethodBodyTypeMismatch
           # For the case of a String we use the methods -@
           # That method are only for String objects
           # they are faster and chepaer on the memory side.

data/lib/datadog/core/utils/sequence.rb

@@ -5,18 +5,15 @@ module Datadog
     module Utils
       # Generates values from a consistent sequence
       class Sequence
-        def initialize(seed = 0, &block)
+        def initialize(seed = 0)
           @seed = seed
           @current = seed
-          @next_item = block
         end
 
         def next
-          # Steep: https://github.com/soutaro/steep/issues/477
-          # @type ivar @next_item: ^(::Integer) -> Integer
-          next_item = @next_item ? @next_item.call(@current) : @current
+          current = @current
           @current += 1
-          next_item
+          current
         end
 
         def reset!

data/lib/datadog/core/utils/spawn_monkey_patch.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../../ruby_version'
+require_relative "../../ruby_version"
 
 module Datadog
   module Core
@@ -21,7 +21,7 @@ module Datadog
         # Prepends `Process.spawn` to merge `env_provider` output into the child's environment hash.
         module ProcessSpawnPatch
           # The One and Only Correct Delegation Pattern
-          if RubyVersion.is?('>= 3')
+          if RubyVersion.is?(">= 3")
             def spawn(*args, **kwargs) # steep:ignore DifferentMethodParameterKind
               super(*SpawnMonkeyPatch.inject_envs(args), **kwargs)
             end