ddtrace 1.4.2 → 1.19.0

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

@@ -1,4 +1,4 @@
-# typed: true
+# frozen_string_literal: true
 
 require_relative '../../../ddtrace/version'
 
@@ -15,12 +15,12 @@ module Datadog
                            RUBY_VERSION
                          end
 
-        ENV_API_KEY = 'DD_API_KEY'.freeze
-        ENV_ENVIRONMENT = 'DD_ENV'.freeze
-        ENV_SERVICE = 'DD_SERVICE'.freeze
-        ENV_SITE = 'DD_SITE'.freeze
-        ENV_TAGS = 'DD_TAGS'.freeze
-        ENV_VERSION = 'DD_VERSION'.freeze
+        ENV_API_KEY = 'DD_API_KEY'
+        ENV_ENVIRONMENT = 'DD_ENV'
+        ENV_SERVICE = 'DD_SERVICE'
+        ENV_SITE = 'DD_SITE'
+        ENV_TAGS = 'DD_TAGS'
+        ENV_VERSION = 'DD_VERSION'
         FALLBACK_SERVICE_NAME =
           begin
             File.basename($PROGRAM_NAME, '.*')
@@ -28,15 +28,15 @@ module Datadog
             'ruby'
           end.freeze
 
-        LANG = 'ruby'.freeze
+        LANG = 'ruby'
         LANG_ENGINE = RUBY_ENGINE
-        LANG_INTERPRETER = "#{RUBY_ENGINE}-#{RUBY_PLATFORM}".freeze
+        LANG_INTERPRETER = "#{RUBY_ENGINE}-#{RUBY_PLATFORM}"
         LANG_PLATFORM = RUBY_PLATFORM
         LANG_VERSION = RUBY_VERSION
         RUBY_ENGINE = ::RUBY_ENGINE # e.g. 'ruby', 'jruby', 'truffleruby'
-        TAG_ENV = 'env'.freeze
-        TAG_SERVICE = 'service'.freeze
-        TAG_VERSION = 'version'.freeze
+        TAG_ENV = 'env'
+        TAG_SERVICE = 'service'
+        TAG_VERSION = 'version'
 
         # TODO: Migrate to Datadog::Tracing
         TRACER_VERSION = DDTrace::VERSION::STRING

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

@@ -1,4 +1,4 @@
-# typed: true
+# frozen_string_literal: true
 
 module Datadog
   module Core

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

@@ -1,4 +1,4 @@
-# typed: false
+# frozen_string_literal: true
 
 require 'securerandom'
 
@@ -49,9 +49,65 @@ module Datadog
           Core::Environment::Ext::LANG_VERSION
         end
 
+        # Returns tracer version, rubygems-style
         def tracer_version
           Core::Environment::Ext::TRACER_VERSION
         end
+
+        # 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
+
+          m = SEMVER2_RE.match(tracer_version)
+
+          pre = "-#{m[:pre]}" if m[:pre]
+          build = "+gha#{m[:gha_run_id]}.g#{m[:git_sha]}.#{m[:branch].tr('.', '-')}" if m[:build]
+
+          "#{m[:major]}.#{m[:minor]}.#{m[:patch]}#{pre}#{build}"
+        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
       end
     end
   end

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

@@ -1,5 +1,3 @@
-# typed: false
-
 require 'etc'
 
 require_relative 'identity'

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

@@ -1,4 +1,4 @@
-# typed: false
+# frozen_string_literal: true
 
 require 'socket'
 require_relative '../utils/forking'

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

@@ -1,4 +1,4 @@
-# typed: true
+# frozen_string_literal: true
 
 module Datadog
   module Core

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

@@ -1,4 +1,4 @@
-# typed: false
+# frozen_string_literal: true
 
 module Datadog
   module Core
@@ -9,49 +9,21 @@ module Datadog
       module VariableHelpers
         extend self
 
-        def env_to_bool(var, default = nil)
-          var = decode_array(var)
-          var && ENV.key?(var) ? ENV[var].to_s.strip.downcase == 'true' : default
-        end
-
-        def env_to_int(var, default = nil)
-          var = decode_array(var)
-          var && ENV.key?(var) ? ENV[var].to_i : default
-        end
-
-        def env_to_float(var, default = nil)
-          var = decode_array(var)
-          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.
+        # Reads an environment variable as a Boolean.
         #
-        # 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.
-        def env_to_list(var, default = [], comma_separated_only:)
-          var = decode_array(var)
+        # @param [String] var environment variable
+        # @param [Array<String>] var list of environment variables
+        # @param [Boolean] 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 [Boolean] if the environment value is the string `true` or `1`
+        # @return [default] if the environment value is not found
+        def env_to_bool(var, default = nil, 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
+            value = ENV[var].to_s.strip
+            value.downcase!
+            value == 'true' || value == '1' # rubocop:disable Style/MultipleComparison
           else
             default
           end
@@ -59,8 +31,21 @@ module Datadog
 
         private
 
-        def decode_array(var)
-          var.is_a?(Array) ? var.find { |env_var| ENV.key?(env_var) } : var
+        def decode_array(var, deprecation_warning)
+          if var.is_a?(Array)
+            var.find.with_index do |env_var, i|
+              found = ENV.key?(env_var)
+
+              # Check if we are using a non-preferred environment variable
+              if deprecation_warning && found && i != 0
+                Datadog::Core.log_deprecation { "#{env_var} environment variable is deprecated, use #{var.first} instead." }
+              end
+
+              found
+            end
+          else
+            var
+          end
         end
       end
     end

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

@@ -1,4 +1,4 @@
-# typed: true
+# frozen_string_literal: true
 
 module Datadog
   module Core
@@ -20,6 +20,9 @@ module Datadog
         # Whenever a constant creation busts the global constant cache
         # this value is incremented. This has a measurable performance impact
         # and thus show be avoided after application warm up.
+        #
+        # This was removed in Ruby 3.2.
+        # @see https://github.com/ruby/ruby/blob/master/doc/NEWS/NEWS-3.2.0.md#implementation-improvements
         def global_constant_state
           ::RubyVM.stat[:global_constant_state]
         end
@@ -38,6 +41,20 @@ module Datadog
           ::RubyVM.stat[:global_method_state]
         end
 
+        # Introduced in Ruby 3.2 to match an improved cache implementation.
+        #
+        # @see https://bugs.ruby-lang.org/issues/18589
+        def constant_cache_invalidations
+          ::RubyVM.stat[:constant_cache_invalidations]
+        end
+
+        # Introduced in Ruby 3.2 to match an improved cache implementation.
+        #
+        # @see https://bugs.ruby-lang.org/issues/18589
+        def constant_cache_misses
+          ::RubyVM.stat[:constant_cache_misses]
+        end
+
         def available?
           defined?(::RubyVM) && ::RubyVM.respond_to?(:stat)
         end

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# typed: false
-
 require_relative 'utils'
 
 module Datadog
@@ -17,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/extensions.rb

@@ -1,4 +1,4 @@
-# typed: true
+# frozen_string_literal: true
 
 require_relative 'configuration'
 

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

@@ -1,34 +1,36 @@
-# typed: true
+# 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
+        GIT_SHA_LENGTH = 40
 
-        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_BRANCH = 'git.branch'
+        TAG_REPOSITORY_URL = 'git.repository_url'
+        TAG_TAG = 'git.tag'
 
-        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
+        TAG_COMMIT_AUTHOR_DATE = 'git.commit.author.date'
+        TAG_COMMIT_AUTHOR_EMAIL = 'git.commit.author.email'
+        TAG_COMMIT_AUTHOR_NAME = 'git.commit.author.name'
+        TAG_COMMIT_COMMITTER_DATE = 'git.commit.committer.date'
+        TAG_COMMIT_COMMITTER_EMAIL = 'git.commit.committer.email'
+        TAG_COMMIT_COMMITTER_NAME = 'git.commit.committer.name'
+        TAG_COMMIT_MESSAGE = 'git.commit.message'
+        TAG_COMMIT_SHA = 'git.commit.sha'
+
+        ENV_REPOSITORY_URL = 'DD_GIT_REPOSITORY_URL'
+        ENV_COMMIT_SHA = 'DD_GIT_COMMIT_SHA'
+        ENV_BRANCH = 'DD_GIT_BRANCH'
+        ENV_TAG = 'DD_GIT_TAG'
+        ENV_COMMIT_MESSAGE = 'DD_GIT_COMMIT_MESSAGE'
+        ENV_COMMIT_AUTHOR_NAME = 'DD_GIT_COMMIT_AUTHOR_NAME'
+        ENV_COMMIT_AUTHOR_EMAIL = 'DD_GIT_COMMIT_AUTHOR_EMAIL'
+        ENV_COMMIT_AUTHOR_DATE = 'DD_GIT_COMMIT_AUTHOR_DATE'
+        ENV_COMMIT_COMMITTER_NAME = 'DD_GIT_COMMIT_COMMITTER_NAME'
+        ENV_COMMIT_COMMITTER_EMAIL = 'DD_GIT_COMMIT_COMMITTER_EMAIL'
+        ENV_COMMIT_COMMITTER_DATE = 'DD_GIT_COMMIT_COMMITTER_DATE'
       end
     end
   end

data/lib/datadog/core/header_collection.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    # A some-what abstract class representing a collection of headers.
+    #
+    # Use the `HeaderCollection.from_hash` function to create a header collection from a `Hash`.
+    # Another option is to use `HashHeaderCollection` directly.
+    class HeaderCollection
+      # Gets a single value of the header with the given name, case insensitive.
+      #
+      # @param [String] header_name Name of the header to get the value of.
+      # @returns [String, nil] A single value of the header, or nil if the header with
+      #   the given name is missing from the collection.
+      def get(header_name)
+        nil
+      end
+
+      # Create a header collection that retrieves headers from the given Hash.
+      #
+      # This can be useful for testing or other trivial use cases.
+      #
+      # @param [Hash] hash Hash with the headers.
+      def self.from_hash(hash)
+        HashHeaderCollection.new(hash)
+      end
+    end
+
+    # A header collection implementation that looks up headers in a Hash.
+    class HashHeaderCollection < HeaderCollection
+      def initialize(hash)
+        super()
+        @hash = {}.tap do |res|
+          hash.each_pair { |key, value| res[key.downcase] = value }
+        end
+      end
+
+      def get(header_name)
+        @hash[header_name.downcase]
+      end
+    end
+  end
+end

data/lib/datadog/core/logger.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require 'logger'
 
 module Datadog

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/client.rb

@@ -1,7 +1,6 @@
-# typed: false
-
 require_relative '../utils/time'
 require_relative '../utils/only_once'
+require_relative '../configuration/ext'
 
 require_relative 'ext'
 require_relative 'options'
@@ -50,11 +49,11 @@ module Datadog
         end
 
         def default_hostname
-          ENV.fetch(Ext::ENV_DEFAULT_HOST, Ext::DEFAULT_HOST)
+          ENV.fetch(Configuration::Ext::Transport::ENV_DEFAULT_HOST, Ext::DEFAULT_HOST)
         end
 
         def default_port
-          ENV.fetch(Ext::ENV_DEFAULT_PORT, Ext::DEFAULT_PORT).to_i
+          ENV.fetch(Configuration::Ext::Metrics::ENV_DEFAULT_PORT, Ext::DEFAULT_PORT).to_i
         end
 
         def default_statsd_client

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

@@ -1,19 +1,17 @@
-# typed: true
+# 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
-        ENV_DEFAULT_HOST = 'DD_AGENT_HOST'.freeze
-        ENV_DEFAULT_PORT = 'DD_METRIC_AGENT_PORT'.freeze
 
-        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/metrics/helpers.rb

@@ -1,4 +1,4 @@
-# typed: false
+# frozen_string_literal: true
 
 module Datadog
   module Core

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require 'logger'
 require 'json'
 

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

@@ -1,4 +1,4 @@
-# typed: false
+# frozen_string_literal: true
 
 module Datadog
   module Core

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative 'ext'
 require_relative '../environment/ext'
 require_relative '../environment/identity'

data/lib/datadog/core/pin.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Core
     # A {Datadog::Core::Pin} sets metadata on a particular object.

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative '../../../appsec/remote'
+require_relative '../../../tracing/remote'
+
+module Datadog
+  module Core
+    module Remote
+      class Client
+        # Capabilities
+        class Capabilities
+          attr_reader :products, :capabilities, :receivers, :base64_capabilities
+
+          def initialize(settings)
+            @capabilities = []
+            @products = []
+            @receivers = []
+
+            register(settings)
+
+            @base64_capabilities = capabilities_to_base64
+          end
+
+          private
+
+          def register(settings)
+            if settings.respond_to?(:appsec) && settings.appsec.enabled
+              register_capabilities(Datadog::AppSec::Remote.capabilities)
+              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)
+            @capabilities.concat(capabilities)
+          end
+
+          def register_receivers(receivers)
+            @receivers.concat(receivers)
+          end
+
+          def register_products(products)
+            @products.concat(products)
+          end
+
+          def capabilities_to_base64
+            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*')
+
+            Base64.encode64(binary).chomp
+          end
+        end
+      end
+    end
+  end
+end