datadog 2.38.0 → 2.47.0

data/lib/datadog/core/extensions.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'configuration'
+require_relative "configuration"
 
 # Global namespace that includes all Datadog functionality.
 # @public_api

data/lib/datadog/core/feature_flags.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'json'
+require "json"
 
 module Datadog
   module Core
@@ -44,7 +44,7 @@ module Datadog
         #
         # @return [Boolean] True if there was an error
         def error?
-          reason == 'ERROR'
+          reason == "ERROR"
         end
 
         private

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

@@ -5,11 +5,11 @@ module Datadog
     module Git
       # Defines constants for Git tags
       module Ext
-        TAG_REPOSITORY_URL = '_dd.git.repository_url'
-        TAG_COMMIT_SHA = '_dd.git.commit.sha'
+        TAG_REPOSITORY_URL = "_dd.git.repository_url"
+        TAG_COMMIT_SHA = "_dd.git.commit.sha"
 
-        ENV_REPOSITORY_URL = 'DD_GIT_REPOSITORY_URL'
-        ENV_COMMIT_SHA = 'DD_GIT_COMMIT_SHA'
+        ENV_REPOSITORY_URL = "DD_GIT_REPOSITORY_URL"
+        ENV_COMMIT_SHA = "DD_GIT_COMMIT_SHA"
       end
     end
   end

data/lib/datadog/core/logger.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'logger'
+require "logger"
 
 module Datadog
   module Core
@@ -9,7 +9,7 @@ module Datadog
     # - adds last caller stack-trace info to know where the message comes from
     # @public_api
     class Logger < ::Logger
-      PREFIX = 'datadog'
+      PREFIX = "datadog"
 
       def initialize(*args, &block)
         super
@@ -18,7 +18,7 @@ module Datadog
       end
 
       def add(severity, message = nil, progname = nil, &block)
-        where = ''
+        where = ""
 
         # We are in debug mode, or this is an error, add stack trace to help debugging
         if debug? || severity >= ::Logger::ERROR

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

@@ -6,7 +6,7 @@ module Datadog
       module Ext
         # The technology from which the log originated.
         # @see https://docs.datadoghq.com/api/latest/logs/#send-logs
-        DD_SOURCE = 'ruby'
+        DD_SOURCE = "ruby"
       end
     end
   end

data/lib/datadog/core/metrics/client.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require_relative '../utils/time'
-require_relative '../utils/only_once'
-require_relative '../telemetry/logger'
-require_relative '../configuration/ext'
+require_relative "../utils/time"
+require_relative "../utils/only_once"
+require_relative "../telemetry/logger"
+require_relative "../configuration/ext"
 
-require_relative 'ext'
-require_relative 'options'
-require_relative 'helpers'
-require_relative 'logging'
-require_relative 'metric'
+require_relative "ext"
+require_relative "options"
+require_relative "helpers"
+require_relative "logging"
+require_relative "metric"
 
 module Datadog
   module Core
@@ -39,10 +39,10 @@ module Datadog
         def supported?
           version = dogstatsd_version
 
-          !version.nil? && version >= Gem::Version.new('3.3.0') &&
+          !version.nil? && version >= Gem::Version.new("3.3.0") &&
             # dogstatsd-ruby >= 5.0 & < 5.2.0 has known issues with process forks
             # and do not support the single thread mode we use to avoid this problem.
-            !(version >= Gem::Version.new('5.0') && version < Gem::Version.new('5.3'))
+            !(version >= Gem::Version.new("5.0") && version < Gem::Version.new("5.3"))
         end
 
         def enabled?
@@ -62,7 +62,7 @@ module Datadog
         end
 
         def default_statsd_client
-          require 'datadog/statsd'
+          require "datadog/statsd"
 
           # Create a StatsD client that points to the agent.
           #
@@ -74,7 +74,7 @@ module Datadog
           # overhead.
           #
           # Versions < 5.0 are always single-threaded, but do not have the kwarg option.
-          options = if dogstatsd_version >= Gem::Version.new('5.2')
+          options = if dogstatsd_version >= Gem::Version.new("5.2")
             {single_thread: true}
           else
             {}
@@ -103,7 +103,7 @@ module Datadog
           logger.error(
             "Failed to send count stat. Cause: #{e.class}: #{e.message} Source: #{Array(e.backtrace).first}"
           )
-          telemetry.report(e, description: 'Failed to send count stat')
+          telemetry.report(e, description: "Failed to send count stat")
         end
 
         def distribution(stat, value = nil, options = nil, &block)
@@ -117,7 +117,7 @@ module Datadog
           logger.error(
             "Failed to send distribution stat. Cause: #{e.class}: #{e.message} Source: #{Array(e.backtrace).first}"
           )
-          telemetry.report(e, description: 'Failed to send distribution stat')
+          telemetry.report(e, description: "Failed to send distribution stat")
         end
 
         def increment(stat, options = nil)
@@ -130,7 +130,7 @@ module Datadog
           logger.error(
             "Failed to send increment stat. Cause: #{e.class}: #{e.message} Source: #{Array(e.backtrace).first}"
           )
-          telemetry.report(e, description: 'Failed to send increment stat')
+          telemetry.report(e, description: "Failed to send increment stat")
         end
 
         def gauge(stat, value = nil, options = nil, &block)
@@ -144,7 +144,7 @@ module Datadog
           logger.error(
             "Failed to send gauge stat. Cause: #{e.class}: #{e.message} Source: #{Array(e.backtrace).first}"
           )
-          telemetry.report(e, description: 'Failed to send gauge stat')
+          telemetry.report(e, description: "Failed to send gauge stat")
         end
 
         def time(stat, options = nil)
@@ -164,7 +164,7 @@ module Datadog
             logger.error(
               "Failed to send time stat. Cause: #{e.class}: #{e.message} Source: #{Array(e.backtrace).first}"
             )
-            telemetry.report(e, description: 'Failed to send time stat')
+            telemetry.report(e, description: "Failed to send time stat")
           end
         end
 
@@ -186,7 +186,7 @@ module Datadog
               Datadog::Statsd::VERSION &&
               Gem::Version.new(Datadog::Statsd::VERSION)
           ) ||
-            Gem.loaded_specs['dogstatsd-ruby']&.version
+            Gem.loaded_specs["dogstatsd-ruby"]&.version
         end
 
         IGNORED_STATSD_ONLY_ONCE = Utils::OnlyOnce.new
@@ -195,7 +195,7 @@ module Datadog
         def ignored_statsd_warning
           IGNORED_STATSD_ONLY_ONCE.run do
             logger.warn(
-              'Ignoring user-supplied statsd instance as currently-installed version of dogstastd-ruby is incompatible. ' \
+              "Ignoring user-supplied statsd instance as currently-installed version of dogstastd-ruby is incompatible. " \
               "To fix this, ensure that you have `gem 'dogstatsd-ruby', '~> 5.3'` on your Gemfile or gems.rb file."
             )
           end

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

@@ -5,13 +5,13 @@ module Datadog
     module Metrics
       # @public_api
       module Ext
-        DEFAULT_HOST = '127.0.0.1'
+        DEFAULT_HOST = "127.0.0.1"
         DEFAULT_PORT = 8125
 
-        TAG_LANG = 'language'
-        TAG_LANG_INTERPRETER = 'language-interpreter'
-        TAG_LANG_VERSION = 'language-version'
-        TAG_TRACER_VERSION = 'tracer-version'
+        TAG_LANG = "language"
+        TAG_LANG_INTERPRETER = "language-interpreter"
+        TAG_LANG_VERSION = "language-version"
+        TAG_TRACER_VERSION = "tracer-version"
       end
     end
   end

data/lib/datadog/core/metrics/helpers.rb

@@ -10,7 +10,7 @@ module Datadog
           :distribution,
           :increment,
           :gauge,
-          :time
+          :time,
         ].each do |metric_type|
           define_method(metric_type) do |name, stat|
             name = name.to_sym

data/lib/datadog/core/metrics/logging.rb

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

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative 'ext'
-require_relative '../environment/ext'
-require_relative '../environment/identity'
+require_relative "ext"
+require_relative "../environment/ext"
+require_relative "../environment/identity"
 
 module Datadog
   module Core
@@ -16,8 +16,8 @@ module Datadog
             "#{Ext::TAG_LANG_VERSION}:#{Environment::Identity.lang_version}",
             # TODO: Technically not accurate, if tracing version diverges from datadog gem version
             #       If we extract tracing to its own gem, this needs to be updated.
-            "#{Ext::TAG_TRACER_VERSION}:#{Environment::Identity.gem_datadog_version}"
-          ].freeze
+            "#{Ext::TAG_TRACER_VERSION}:#{Environment::Identity.gem_datadog_version}",
+          ].freeze,
         }.freeze
 
         def metric_options(options = nil)

data/lib/datadog/core/pin.rb

@@ -63,7 +63,7 @@ module Datadog
       # rubocop:enable Style/TrivialAccessors
 
       def to_s
-        pretty_options = options.to_a.map { |k, v| "#{k}:#{v}" }.join(', ')
+        pretty_options = options.to_a.map { |k, v| "#{k}:#{v}" }.join(", ")
         "Pin(#{pretty_options})"
       end
 

data/lib/datadog/core/process_discovery.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative 'process_discovery/tracer_memfd'
-require_relative 'environment/process'
-require_relative 'environment/container'
+require_relative "process_discovery/tracer_memfd"
+require_relative "environment/process"
+require_relative "environment/container"
 
 module Datadog
   module Core
@@ -23,7 +23,11 @@ module Datadog
           metadata = get_metadata(settings)
 
           shutdown!
-          @file_descriptor = _native_store_tracer_metadata(Datadog.logger, **metadata)
+          @file_descriptor = _native_store_tracer_metadata(
+            Datadog.logger,
+            settings.tracing.otel_thread_context_enabled,
+            **metadata
+          )
         end
 
         def shutdown!
@@ -48,12 +52,12 @@ module Datadog
             tracer_language: Core::Environment::Identity.lang,
             tracer_version: Core::Environment::Identity.gem_datadog_version_semver2,
             hostname: Core::Environment::Socket.hostname,
-            service_name: settings.service || '',
-            service_env: settings.env || '',
-            service_version: settings.version || '',
+            service_name: settings.service || "",
+            service_env: settings.env || "",
+            service_version: settings.version || "",
             # Follows Java: https://github.com/DataDog/dd-trace-java/blob/2ebc964340ac530342cc389ba68ff0f5070d5f9f/dd-trace-core/src/main/java/datadog/trace/core/servicediscovery/ServiceDiscovery.java#L37-L38
-            process_tags: settings.experimental_propagate_process_tags_enabled ? Core::Environment::Process.serialized : '',
-            container_id: Core::Environment::Container.container_id || ''
+            process_tags: settings.experimental_propagate_process_tags_enabled ? Core::Environment::Process.serialized : "",
+            container_id: Core::Environment::Container.container_id || "",
           }
         end
       end

data/lib/datadog/core/rate_limiter.rb

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

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

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
-require_relative '../../utils/base64_codec'
-require_relative '../../../appsec/remote'
-require_relative '../../../tracing/remote'
-require_relative '../../../di/remote'
-require_relative '../../../symbol_database'
-require_relative '../../../symbol_database/remote'
-require_relative '../../../open_feature/remote'
+require_relative "../../utils/base64_codec"
+require_relative "../../../appsec/remote"
+require_relative "../../../tracing/remote"
+require_relative "../../../di/remote"
+require_relative "../../../symbol_database"
+require_relative "../../../symbol_database/remote"
 
 module Datadog
   module Core
@@ -14,17 +13,52 @@ module Datadog
       class Client
         # Capabilities
         class Capabilities
-          attr_reader :products, :capabilities, :receivers, :base64_capabilities
-
-          def initialize(settings, telemetry)
+          def initialize(settings, telemetry:)
             @capabilities = []
             @products = []
             @receivers = []
             @telemetry = telemetry
+            @mutex = Mutex.new
 
             register(settings)
 
-            @base64_capabilities = capabilities_to_base64
+            @base64_capabilities = capabilities_to_base64(@capabilities)
+          end
+
+          def capabilities
+            @mutex.synchronize { @capabilities.dup }
+          end
+
+          def products
+            @mutex.synchronize { @products.dup }
+          end
+
+          def receivers
+            @mutex.synchronize { @receivers.dup }
+          end
+
+          def base64_capabilities
+            @mutex.synchronize { @base64_capabilities }
+          end
+
+          def register_runtime(capabilities:, products:, receivers:)
+            @mutex.synchronize do
+              register_capabilities(capabilities)
+              register_products(products)
+              register_receivers(receivers)
+              @base64_capabilities = capabilities_to_base64(@capabilities)
+            end
+            nil
+          end
+
+          def add_products(*products)
+            @mutex.synchronize { register_products(products) }
+            nil
+          end
+
+          def remove_products(*products)
+            @mutex.synchronize { products.each { |product| @products.delete(product) } }
+            nil
           end
 
           private
@@ -47,18 +81,10 @@ module Datadog
             register_products(Datadog::Tracing::Remote.products)
             register_receivers(Datadog::Tracing::Remote.receivers(@telemetry))
 
-            # Skip DI registration entirely when DI is explicitly disabled
-            # (DD_DYNAMIC_INSTRUMENTATION_ENABLED=false) or when the runtime
-            # cannot run DI (JRuby, Ruby 2.5): in either case no component will
-            # run, so advertising bit 38 or the LIVE_DEBUGGING product would
-            # invite probe configs and an enable signal the tracer must refuse.
-            # When the env var is unset (default) on a supported runtime, DI is
-            # registered so RC can enable it.
             if settings.respond_to?(:dynamic_instrumentation) &&
                 !Datadog::DI::Remote.explicitly_disabled?(settings) &&
                 Datadog::DI.supported_runtime?
               register_capabilities(Datadog::DI::Remote.capabilities)
-              register_products(Datadog::DI::Remote.products)
               register_receivers(Datadog::DI::Remote.receivers(@telemetry))
             end
 
@@ -74,35 +100,36 @@ module Datadog
                 !Datadog::DI::Remote.explicitly_disabled?(settings)
               if Datadog::SymbolDatabase.resolve_enabled(settings.symbol_database.enabled, di_enabled)
                 register_capabilities(Datadog::SymbolDatabase::Remote.capabilities)
-                register_products(Datadog::SymbolDatabase::Remote.products)
                 register_receivers(Datadog::SymbolDatabase::Remote.receivers(@telemetry))
+                # Register the product at startup only when symbol_database is
+                # explicitly set (true here, since resolve_enabled already
+                # excluded false). When it follows DI (enabled nil, default or
+                # explicit), defer the product so it is advertised only once DI
+                # actually starts.
+                unless settings.symbol_database.enabled.nil?
+                  register_products(Datadog::SymbolDatabase::Remote.products)
+                end
               end
             end
-
-            if settings.respond_to?(:open_feature) && settings.open_feature.enabled
-              register_capabilities(Datadog::OpenFeature::Remote.capabilities)
-              register_products(Datadog::OpenFeature::Remote.products)
-              register_receivers(Datadog::OpenFeature::Remote.receivers(@telemetry))
-            end
           end
 
           def register_capabilities(capabilities)
-            @capabilities.concat(capabilities)
+            capabilities.each { |capability| @capabilities << capability unless @capabilities.include?(capability) }
           end
 
           def register_receivers(receivers)
-            @receivers.concat(receivers)
+            receivers.each { |receiver| @receivers << receiver unless @receivers.include?(receiver) }
           end
 
           def register_products(products)
-            @products.concat(products)
+            products.each { |product| @products << product unless @products.include?(product) }
           end
 
-          def capabilities_to_base64
-            return '' if capabilities.empty?
+          def capabilities_to_base64(capabilities)
+            return "" if capabilities.empty?
 
-            cap_to_hexs = capabilities.reduce(:|).to_s(16).tap { |s| s.size.odd? && s.prepend('0') }.scan(/\h\h/)
-            binary = cap_to_hexs.each_with_object([]) { |hex, acc| acc << hex }.map { |e| e.to_i(16) }.pack('C*')
+            cap_to_hexs = capabilities.reduce(:|).to_s(16).tap { |s| s.size.odd? && s.prepend("0") }.scan(/\h\h/)
+            binary = cap_to_hexs.each_with_object([]) { |hex, acc| acc << hex }.map { |e| e.to_i(16) }.pack("C*")
 
             Datadog::Core::Utils::Base64Codec.strict_encode64(binary)
           end

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'securerandom'
+require "securerandom"
 
-require_relative 'configuration'
-require_relative 'dispatcher'
+require_relative "configuration"
+require_relative "dispatcher"
 
 module Datadog
   module Core
@@ -16,6 +16,12 @@ module Datadog
 
         attr_reader :transport, :repository, :id, :dispatcher, :settings, :logger
 
+        # Whether the initial reconcile is still pending, to run on the first
+        # sync whose response contains targets.
+        #
+        # @return [Boolean]
+        attr_reader :pending_initial_reconcile
+
         def initialize(transport, capabilities, settings:, logger:, repository: Configuration::Repository.new)
           @transport = transport
           @settings = settings
@@ -25,27 +31,52 @@ module Datadog
           @id = SecureRandom.uuid
           @capabilities = capabilities
           @dispatcher = Dispatcher.new(@capabilities.receivers)
+          @pending_initial_reconcile = true
         end
 
+        # Polls the agent for remote configuration, applies the response to
+        # the repository and dispatches the resulting changes to the receivers.
+        #
+        # The agent sends an empty response when it holds no targets newer
+        # than the targets version the client reported. Until the client
+        # applies a response that carries targets, it reports the initial
+        # targets version, so an empty response then means the agent has not
+        # received targets from the backend. The initial reconcile therefore
+        # waits for a response that carries targets.
+        #
+        # @return [void]
+        # @raise [TransportError] when the agent reports an internal error
+        # @raise [SyncError] when the response cannot be applied to the repository
         def sync
           # TODO: Skip sync if no capabilities are registered
           response = transport.send_config(payload)
 
           if response.ok?
-            process_response(response)
+            changes = process_response(response)
+            if pending_initial_reconcile && !response.empty?
+              dispatcher.reconcile(changes, repository)
+              @pending_initial_reconcile = false
+            end
           elsif response.internal_error?
             raise TransportError, response.to_s
           end
+          nil
         end
 
         private
 
+        # Applies an OK response to the repository and returns the resulting
+        # change set, which is empty when the response is empty.
+        #
+        # @param response [Transport::Config::Response] the response returned by the agent
+        # @return [Configuration::Repository::ChangeSet] the changes applied by this response
+        # @raise [SyncError] when the response cannot be applied to the repository
         def process_response(response)
           # when response is completely empty, do nothing as in: leave as is
           if response.empty?
-            logger.debug { 'remote: empty response => NOOP' }
+            logger.debug { "remote: empty response => NOOP" }
 
-            return
+            return Configuration::Repository::ChangeSet.new
           end
 
           begin
@@ -61,7 +92,7 @@ module Datadog
           end
 
           # To make sure steep does not complain
-          return unless paths && targets && contents
+          return Configuration::Repository::ChangeSet.new unless paths && targets && contents
 
           # TODO: sometimes it can strangely be so that paths.empty?
           # TODO: sometimes it can strangely be so that targets.empty?
@@ -69,6 +100,14 @@ module Datadog
           apply_config(paths, targets, contents)
         end
 
+        # Applies the response to the repository in a transaction, dispatches the
+        # resulting changes to the receivers and returns them.
+        #
+        # @param paths [Array<Configuration::Path>] ingress paths from the response
+        # @param targets [Configuration::TargetMap] targets keyed by path
+        # @param contents [Configuration::ContentList] contents from the response
+        # @return [Configuration::Repository::ChangeSet] the changes applied by the transaction
+        # @raise [SyncError] when a path has no matching target or content
         def apply_config(paths, targets, contents)
           changes = repository.transaction do |current, transaction|
             # paths to be removed: previously applied paths minus ingress paths
@@ -117,10 +156,12 @@ module Datadog
           end
 
           if changes.empty?
-            logger.debug { 'remote: no changes' }
+            logger.debug { "remote: no changes" }
           else
             dispatcher.dispatch(changes, repository)
           end
+
+          changes
         end
 
         def payload # standard:disable Metrics/MethodLength
@@ -185,7 +226,7 @@ module Datadog
               is_agent: false,
               client_tracer: client_tracer,
               # base64 is needed otherwise the Go agent fails with an unmarshal error
-              capabilities: @capabilities.base64_capabilities
+              capabilities: @capabilities.base64_capabilities,
             },
             cached_target_files: state.cached_target_files,
           }
@@ -210,40 +251,40 @@ module Datadog
         def native_platform
           return @native_platform unless @native_platform.nil?
 
-          os = if RUBY_ENGINE == 'jruby'
-            os_name = java.lang.System.get_property('os.name')
+          os = if RUBY_ENGINE == "jruby"
+            os_name = java.lang.System.get_property("os.name")
 
             case os_name
-            when /linux/i then 'linux'
-            when /mac/i then 'darwin'
+            when /linux/i then "linux"
+            when /mac/i then "darwin"
             else os_name
             end
           else
             Gem::Platform.local.os
           end
 
-          version = if os != 'linux'
+          version = if os != "linux"
             nil
           elsif RUBY_PLATFORM =~ /linux-(.+)$/
             # Old rubygems don't handle non-gnu linux correctly
             Regexp.last_match(1)
           else
-            'gnu'
+            "gnu"
           end
 
-          cpu = if RUBY_ENGINE == 'jruby'
-            os_arch = java.lang.System.get_property('os.arch')
+          cpu = if RUBY_ENGINE == "jruby"
+            os_arch = java.lang.System.get_property("os.arch")
 
             case os_arch
-            when 'amd64' then 'x86_64'
-            when 'aarch64' then (os == 'darwin') ? 'arm64' : 'aarch64'
+            when "amd64" then "x86_64"
+            when "aarch64" then (os == "darwin") ? "arm64" : "aarch64"
             else os_arch
             end
           else
             Gem::Platform.local.cpu
           end
 
-          @native_platform = [cpu, os, version].compact.join('-')
+          @native_platform = [cpu, os, version].compact.join("-")
         end
 
         GemSpecificationFallback = _ = Struct.new(:version, :platform) # rubocop:disable Naming/ConstantName