ddtrace 1.12.1 → 1.23.2

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

@@ -56,58 +56,28 @@ module Datadog
 
         # Returns tracer version, comforming to https://semver.org/spec/v2.0.0.html
         def tracer_version_semver2
-          # from ddtrace/version.rb, we have MAJOR.MINOR.PATCH plus optional .PRE and .BUILD
-          # - transform .PRE to -PRE if present
-          # - transform .BUILD to +BUILD if present
-          # - keep triplet segments before that
+          major, minor, patch, rest = tracer_version.split('.', 4)
 
-          m = SEMVER2_RE.match(tracer_version)
+          semver = "#{major}.#{minor}.#{patch}"
 
-          pre = "-#{m[:pre]}" if m[:pre]
-          build = "+gha#{m[:gha_run_id]}.g#{m[:git_sha]}.#{m[:branch].tr('.', '-')}" if m[:build]
+          return semver unless rest
 
-          "#{m[:major]}.#{m[:minor]}.#{m[:patch]}#{pre}#{build}"
-        end
+          pre = ''
+          build = ''
+
+          rest.split('.').tap do |segments|
+            if segments.length >= 4
+              pre   = "-#{segments.shift}"
+              build = "+#{segments.join('.')}"
+            elsif segments.length == 1
+              pre = "-#{segments.shift}"
+            else
+              build = "+#{segments.join('.')}"
+            end
+          end
 
-        SEMVER2_RE = /
-          ^
-          # mandatory segments
-          (?<major>\d+)
-          \.
-          (?<minor>\d+)
-          \.
-          (?<patch>\d+)
-
-          # pre segments start with a value
-          # - containing at least one alpha
-          # - that is not part of our build segments expected values
-          # and stop with a value that is not part of our build segments expected values
-          (?:
-            \.
-            (?<pre>
-              (?!gha)
-              [a-zA-Z0-9]*[a-zA-Z][a-zA-Z0-9]*
-              (?:
-                \.
-                (?!gha)
-                [a-zA-Z0-9]+
-              )*
-            )
-          )?
-
-          # build segments: ours include CI info (`gha`), then git (`g`), then branch name
-          (?:
-            \.
-            (?<build>
-              gha(?<gha_run_id>\d+)
-              \.
-              g(?<git_sha>[a-f0-9]+)
-              \.
-              (?<branch>(?:[a-zA-Z0-9.])+)
-            )
-          )?
-          $
-        /xm.freeze
+          semver + pre + build
+        end
       end
     end
   end

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

@@ -9,12 +9,18 @@ module Datadog
       module Platform
         module_function
 
+        # @return [String] ISA of host; `uname -m`
+        def architecture
+          Identity.lang_version >= '2.2' ? Etc.uname[:machine] : Gem::Platform.local.cpu
+        end
+
         # @return [String] name of host; `uname -n`
         def hostname
           Identity.lang_version >= '2.2' ? Etc.uname[:nodename] : nil
         end
 
-        # @return [String] name of kernel; `uname -s`
+        # System name, normally `Linux` or `Darwin` (but 'Mac OS X' on JRuby);
+        # @return [String] name of kernel; `uname -s`.
         def kernel_name
           Identity.lang_version >= '2.2' ? Etc.uname[:sysname] : Gem::Platform.local.os.capitalize
         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/environment/yjit.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    module Environment
+      # Reports YJIT primitive runtime statistics.
+      module YJIT
+        module_function
+
+        # Inline code size
+        def inline_code_size
+          ::RubyVM::YJIT.runtime_stats[:inline_code_size]
+        end
+
+        # Outlined code size
+        def outlined_code_size
+          ::RubyVM::YJIT.runtime_stats[:outlined_code_size]
+        end
+
+        # GCed pages
+        def freed_page_count
+          ::RubyVM::YJIT.runtime_stats[:freed_page_count]
+        end
+
+        # GCed code size
+        def freed_code_size
+          ::RubyVM::YJIT.runtime_stats[:freed_code_size]
+        end
+
+        # Live pages
+        def live_page_count
+          ::RubyVM::YJIT.runtime_stats[:live_page_count]
+        end
+
+        # Code GC count
+        def code_gc_count
+          ::RubyVM::YJIT.runtime_stats[:code_gc_count]
+        end
+
+        # Size of memory region allocated for JIT code
+        def code_region_size
+          ::RubyVM::YJIT.runtime_stats[:code_region_size]
+        end
+
+        # Total number of object shapes
+        def object_shape_count
+          ::RubyVM::YJIT.runtime_stats[:object_shape_count]
+        end
+
+        def available?
+          defined?(::RubyVM::YJIT) \
+            && ::RubyVM::YJIT.enabled? \
+            && ::RubyVM::YJIT.respond_to?(:runtime_stats)
+        end
+      end
+    end
+  end
+end

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

@@ -1,32 +1,15 @@
+# frozen_string_literal: true
+
 module Datadog
   module Core
     module Git
       # Defines constants for Git tags
       module Ext
-        TAG_BRANCH = 'git.branch'.freeze
-        TAG_REPOSITORY_URL = 'git.repository_url'.freeze
-        TAG_TAG = 'git.tag'.freeze
-
-        TAG_COMMIT_AUTHOR_DATE = 'git.commit.author.date'.freeze
-        TAG_COMMIT_AUTHOR_EMAIL = 'git.commit.author.email'.freeze
-        TAG_COMMIT_AUTHOR_NAME = 'git.commit.author.name'.freeze
-        TAG_COMMIT_COMMITTER_DATE = 'git.commit.committer.date'.freeze
-        TAG_COMMIT_COMMITTER_EMAIL = 'git.commit.committer.email'.freeze
-        TAG_COMMIT_COMMITTER_NAME = 'git.commit.committer.name'.freeze
-        TAG_COMMIT_MESSAGE = 'git.commit.message'.freeze
-        TAG_COMMIT_SHA = 'git.commit.sha'.freeze
+        TAG_REPOSITORY_URL = '_dd.git.repository_url'
+        TAG_COMMIT_SHA = '_dd.git.commit.sha'
 
-        ENV_REPOSITORY_URL = 'DD_GIT_REPOSITORY_URL'.freeze
-        ENV_COMMIT_SHA = 'DD_GIT_COMMIT_SHA'.freeze
-        ENV_BRANCH = 'DD_GIT_BRANCH'.freeze
-        ENV_TAG = 'DD_GIT_TAG'.freeze
-        ENV_COMMIT_MESSAGE = 'DD_GIT_COMMIT_MESSAGE'.freeze
-        ENV_COMMIT_AUTHOR_NAME = 'DD_GIT_COMMIT_AUTHOR_NAME'.freeze
-        ENV_COMMIT_AUTHOR_EMAIL = 'DD_GIT_COMMIT_AUTHOR_EMAIL'.freeze
-        ENV_COMMIT_AUTHOR_DATE = 'DD_GIT_COMMIT_AUTHOR_DATE'.freeze
-        ENV_COMMIT_COMMITTER_NAME = 'DD_GIT_COMMIT_COMMITTER_NAME'.freeze
-        ENV_COMMIT_COMMITTER_EMAIL = 'DD_GIT_COMMIT_COMMITTER_EMAIL'.freeze
-        ENV_COMMIT_COMMITTER_DATE = 'DD_GIT_COMMIT_COMMITTER_DATE'.freeze
+        ENV_REPOSITORY_URL = 'DD_GIT_REPOSITORY_URL'
+        ENV_COMMIT_SHA = 'DD_GIT_COMMIT_SHA'
       end
     end
   end

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Datadog
   module Core
     module Logging
       module Ext
         # The technology from which the log originated.
         # @see https://docs.datadoghq.com/api/latest/logs/#send-logs
-        DD_SOURCE = 'ruby'.freeze
+        DD_SOURCE = 'ruby'
       end
     end
   end

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

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 module Datadog
   module Core
     module Metrics
       # @public_api
       module Ext
-        DEFAULT_HOST = '127.0.0.1'.freeze
+        DEFAULT_HOST = '127.0.0.1'
         DEFAULT_PORT = 8125
 
-        TAG_LANG = 'language'.freeze
-        TAG_LANG_INTERPRETER = 'language-interpreter'.freeze
-        TAG_LANG_VERSION = 'language-version'.freeze
-        TAG_TRACER_VERSION = 'tracer-version'.freeze
+        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/remote/client/capabilities.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 require_relative '../../../appsec/remote'
+require_relative '../../../tracing/remote'
 
 module Datadog
   module Core
     module Remote
       class Client
-        # Capbailities
+        # Capabilities
         class Capabilities
           attr_reader :products, :capabilities, :receivers, :base64_capabilities
 
@@ -28,6 +29,10 @@ module Datadog
               register_products(Datadog::AppSec::Remote.products)
               register_receivers(Datadog::AppSec::Remote.receivers)
             end
+
+            register_capabilities(Datadog::Tracing::Remote.capabilities)
+            register_products(Datadog::Tracing::Remote.products)
+            register_receivers(Datadog::Tracing::Remote.receivers)
           end
 
           def register_capabilities(capabilities)
@@ -48,7 +53,7 @@ module Datadog
             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*')
 
-            Base64.encode64(binary).chomp
+            Base64.strict_encode64(binary)
           end
         end
       end

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

@@ -10,6 +10,7 @@ module Datadog
     module Remote
       # Client communicates with the agent and sync remote configuration
       class Client
+        class TransportError < StandardError; end
         class SyncError < StandardError; end
 
         attr_reader :transport, :repository, :id, :dispatcher
@@ -107,6 +108,8 @@ module Datadog
             else
               dispatcher.dispatch(changes, repository)
             end
+          elsif response.internal_error?
+            raise TransportError, response.to_s
           end
         end
         # rubocop:enable Metrics/AbcSize,Metrics/PerceivedComplexity,Metrics/MethodLength,Metrics/CyclomaticComplexity

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'
 
@@ -13,25 +13,23 @@ module Datadog
       # Configures the HTTP transport to communicate with the agent
       # to fetch and sync the remote configuration
       class Component
-        BARRIER_TIMEOUT = 1.0 # second
-
-        attr_reader :client
+        attr_reader :client, :healthy
 
         def initialize(settings, capabilities, agent_settings)
           transport_options = {}
           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)
+          @barrier = Barrier.new(settings.remote.boot_timeout_seconds)
 
           @client = Client.new(transport_v7, capabilities)
-          healthy = false
+          @healthy = false
           Datadog.logger.debug { "new remote configuration client: #{@client.id}" }
 
           @worker = Worker.new(interval: settings.remote.poll_interval_seconds) do
-            unless healthy || negotiation.endpoint?('/v0.7/config')
+            unless @healthy || negotiation.endpoint?('/v0.7/config')
               @barrier.lift
 
               next
@@ -39,12 +37,17 @@ module Datadog
 
             begin
               @client.sync
-              healthy ||= true
+              @healthy ||= true
             rescue Client::SyncError => e
               Datadog.logger.error do
                 "remote worker client sync error: #{e.message} location: #{Array(e.backtrace).first}. skipping sync"
               end
             rescue StandardError => e
+              # In case of unexpected errors, reset the negotiation object
+              # given external conditions have changed and the negotiation
+              # negotiation object stores error logging state that should be reset.
+              negotiation = Negotiation.new(settings, agent_settings)
+
               Datadog.logger.error do
                 "remote worker error: #{e.class.name} #{e.message} location: #{Array(e.backtrace).first}. "\
                 'reseting client state'
@@ -52,7 +55,7 @@ module Datadog
 
               # client state is unknown, state might be corrupted
               @client = Client.new(transport_v7, capabilities)
-              healthy = false
+              @healthy = false
               Datadog.logger.debug { "new remote configuration client: #{@client.id}" }
 
               # TODO: bail out if too many errors?
@@ -62,13 +65,22 @@ module Datadog
           end
         end
 
-        def barrier(kind)
+        # Starts the Remote Configuration worker without waiting for first run
+        def start
           @worker.start
+        end
 
-          case kind
-          when :once
-            @barrier.wait_once
-          end
+        # Is the Remote Configuration worker running?
+        def started?
+          @worker.started?
+        end
+
+        # If the worker is not initialized, initialize it.
+        #
+        # Then, waits for one client sync to be executed if `kind` is `:once`.
+        def barrier(_kind)
+          start
+          @barrier.wait_once
         end
 
         def shutdown!
@@ -89,34 +101,37 @@ module Datadog
           def wait_once(timeout = nil)
             # TTAS (Test and Test-And-Set) optimisation
             # Since @once only ever goes from false to true, this is semantically valid
-            return if @once
+            return :pass if @once
 
             begin
               @mutex.lock
 
-              return if @once
+              return :pass if @once
 
               timeout ||= @timeout
 
-              # rbs/core has a bug, timeout type is incorrectly ?Integer
-              @condition.wait(@mutex, _ = timeout)
+              # - starting with Ruby 3.2, ConditionVariable#wait returns nil on
+              #   timeout and an integer otherwise
+              # - before Ruby 3.2, ConditionVariable returns itself
+              # so we have to rely on @once having been set
+              if RUBY_VERSION >= '3.2'
+                lifted = @condition.wait(@mutex, timeout)
+              else
+                @condition.wait(@mutex, timeout)
+                lifted = @once
+              end
+
+              if lifted
+                :lift
+              else
+                @once = true
+                :timeout
+              end
             ensure
               @mutex.unlock
             end
           end
 
-          # Wait for next lift to happen
-          def wait_next(timeout = nil)
-            @mutex.lock
-
-            timeout ||= @timeout
-
-            # rbs/core has a bug, timeout type is incorrectly ?Integer
-            @condition.wait(@mutex, _ = timeout)
-          ensure
-            @mutex.unlock
-          end
-
           # Release all current waiters
           def lift
             @mutex.lock
@@ -130,26 +145,15 @@ module Datadog
         end
 
         class << self
+          # Because the agent might not be available yet, we can't perform agent-specific checks yet, as they
+          # would prevent remote configuration from ever running.
+          #
+          # Those checks are instead performed inside the worker loop.
+          # This allows users to upgrade their agent while keeping their application running.
           def build(settings, agent_settings)
             return unless settings.remote.enabled
 
-            capabilities = Client::Capabilities.new(settings)
-
-            return if capabilities.products.empty?
-
-            negotiation = Negotiation.new(settings, agent_settings)
-
-            unless negotiation.endpoint?('/v0.7/config')
-              Datadog.logger.error do
-                'endpoint unavailable: disabling remote configuration for this process.'
-              end
-
-              return
-            end
-
-            Datadog.logger.debug { 'agent reachable and reports remote configuration endpoint' }
-
-            new(settings, capabilities, agent_settings)
+            new(settings, Client::Capabilities.new(settings), agent_settings)
           end
         end
       end

data/lib/datadog/core/remote/configuration/content.rb

@@ -18,12 +18,14 @@ module Datadog
             end
           end
 
-          attr_reader :path, :data, :hashes
+          attr_reader :path, :data, :hashes, :apply_state, :apply_error
           attr_accessor :version
 
           def initialize(path:, data:)
             @path = path
             @data = data
+            @apply_state = ApplyState::UNACKNOWLEDGED
+            @apply_error = nil
             @hashes = {}
             @version = 0
           end
@@ -36,6 +38,31 @@ module Datadog
             @length ||= @data.size
           end
 
+          # Sets this configuration as successfully applied.
+          def applied
+            @apply_state = ApplyState::ACKNOWLEDGED
+            @apply_error = nil
+          end
+
+          # Sets this configuration as not successfully applied, with
+          # a message describing the error.
+          def errored(error_message)
+            @apply_state = ApplyState::ERROR
+            @apply_error = error_message
+          end
+
+          module ApplyState
+            # Default state of configurations.
+            # Set until the component consuming the configuration has acknowledged it was applied.
+            UNACKNOWLEDGED = 1
+
+            # Set when the configuration has been successfully applied.
+            ACKNOWLEDGED = 2
+
+            # Set when the configuration has been unsuccessfully applied.
+            ERROR = 3
+          end
+
           private
 
           def compute_and_store_hash(type)

data/lib/datadog/core/remote/configuration/repository.rb

@@ -94,7 +94,9 @@ module Datadog
                 {
                   id: content.path.config_id,
                   version: content.version,
-                  product: content.path.product
+                  product: content.path.product,
+                  apply_state: content.apply_state,
+                  apply_error: content.apply_error,
                 }
               end
             end

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

@@ -5,7 +5,8 @@ module Datadog
     module Remote
       module Ext
         ENV_ENABLED = 'DD_REMOTE_CONFIGURATION_ENABLED'
-        ENV_POLL_INTERVAL_SECONDS = 'DD_REMOTE_CONFIGURATION_POLL_INTERVAL_SECONDS'
+        ENV_POLL_INTERVAL_SECONDS = 'DD_REMOTE_CONFIG_POLL_INTERVAL_SECONDS'
+        ENV_BOOT_TIMEOUT_SECONDS = 'DD_REMOTE_CONFIG_BOOT_TIMEOUT_SECONDS'
       end
     end
   end