ddtrace 1.1.0 → 1.12.1

data/lib/datadog/core/diagnostics/health.rb

@@ -1,7 +1,7 @@
-# typed: strict
+# frozen_string_literal: true
 
-require 'datadog/core/diagnostics/ext'
-require 'datadog/core/metrics/client'
+require_relative '../metrics/client'
+require_relative '../../tracing/diagnostics/health'
 
 module Datadog
   module Core
@@ -10,26 +10,8 @@ module Datadog
       module Health
         # Health metrics for diagnostics
         class Metrics < Core::Metrics::Client
-          count :api_errors, Ext::Health::Metrics::METRIC_API_ERRORS
-          count :api_requests, Ext::Health::Metrics::METRIC_API_REQUESTS
-          count :api_responses, Ext::Health::Metrics::METRIC_API_RESPONSES
-          count :error_context_overflow, Ext::Health::Metrics::METRIC_ERROR_CONTEXT_OVERFLOW
-          count :error_instrumentation_patch, Ext::Health::Metrics::METRIC_ERROR_INSTRUMENTATION_PATCH
-          count :error_span_finish, Ext::Health::Metrics::METRIC_ERROR_SPAN_FINISH
-          count :error_unfinished_spans, Ext::Health::Metrics::METRIC_ERROR_UNFINISHED_SPANS
-          count :instrumentation_patched, Ext::Health::Metrics::METRIC_INSTRUMENTATION_PATCHED
-          count :queue_accepted, Ext::Health::Metrics::METRIC_QUEUE_ACCEPTED
-          count :queue_accepted_lengths, Ext::Health::Metrics::METRIC_QUEUE_ACCEPTED_LENGTHS
-          count :queue_dropped, Ext::Health::Metrics::METRIC_QUEUE_DROPPED
-          count :traces_filtered, Ext::Health::Metrics::METRIC_TRACES_FILTERED
-          count :transport_trace_too_large, Ext::Health::Metrics::METRIC_TRANSPORT_TRACE_TOO_LARGE
-          count :transport_chunked, Ext::Health::Metrics::METRIC_TRANSPORT_CHUNKED
-          count :writer_cpu_time, Ext::Health::Metrics::METRIC_WRITER_CPU_TIME
-
-          gauge :queue_length, Ext::Health::Metrics::METRIC_QUEUE_LENGTH
-          gauge :queue_max_length, Ext::Health::Metrics::METRIC_QUEUE_MAX_LENGTH
-          gauge :queue_spans, Ext::Health::Metrics::METRIC_QUEUE_SPANS
-          gauge :sampling_service_cache_length, Ext::Health::Metrics::METRIC_SAMPLING_SERVICE_CACHE_LENGTH
+          # TODO: Don't reference this. Have tracing add its metrics behavior.
+          extend Tracing::Diagnostics::Health::Metrics
         end
       end
     end

data/lib/datadog/core/encoding.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require 'json'
 require 'msgpack'
 
@@ -10,8 +8,6 @@ module Datadog
       # Encoder interface that provides the logic to encode traces and service
       # @abstract
       module Encoder
-        include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
-
         def content_type
           raise NotImplementedError
         end

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

@@ -1,6 +1,4 @@
-# typed: true
-
-require 'datadog/core/environment/ext'
+require_relative 'ext'
 
 module Datadog
   module Core
@@ -10,8 +8,6 @@ module Datadog
       # about the current Linux container identity.
       # @see https://man7.org/linux/man-pages/man7/cgroups.7.html
       module Cgroup
-        include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
-
         LINE_REGEX = /^(\d+):([^:]*):(.+)$/.freeze
 
         Descriptor = Struct.new(

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

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

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

@@ -1,14 +1,10 @@
-# typed: true
-
-require 'datadog/core/environment/cgroup'
+require_relative 'cgroup'
 
 module Datadog
   module Core
     module Environment
       # For container environments
       module Container
-        include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
-
         UUID_PATTERN = '[0-9a-f]{8}[-_]?[0-9a-f]{4}[-_]?[0-9a-f]{4}[-_]?[0-9a-f]{4}[-_]?[0-9a-f]{12}'.freeze
         CONTAINER_PATTERN = '[0-9a-f]{64}'.freeze
 

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

@@ -1,6 +1,4 @@
-# typed: true
-
-require 'ddtrace/version'
+require_relative '../../../ddtrace/version'
 
 module Datadog
   module Core

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,9 +1,9 @@
-# typed: false
+# frozen_string_literal: true
 
 require 'securerandom'
 
-require 'datadog/core/environment/ext'
-require 'datadog/core/utils/forking'
+require_relative 'ext'
+require_relative '../utils/forking'
 
 module Datadog
   module Core
@@ -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

@@ -0,0 +1,38 @@
+require 'etc'
+
+require_relative 'identity'
+
+module Datadog
+  module Core
+    module Environment
+      # For gathering information about the platform
+      module Platform
+        module_function
+
+        # @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`
+        def kernel_name
+          Identity.lang_version >= '2.2' ? Etc.uname[:sysname] : Gem::Platform.local.os.capitalize
+        end
+
+        # @return [String] kernel release; `uname -r`
+        def kernel_release
+          if Identity.lang_engine == 'jruby'
+            Etc.uname[:version] # Java's `os.version` maps to `uname -r`
+          elsif Identity.lang_version >= '2.2'
+            Etc.uname[:release]
+          end
+        end
+
+        # @return [String] kernel version; `uname -v`
+        def kernel_version
+          Etc.uname[:version] if Identity.lang_engine != 'jruby' && Identity.lang_version >= '2.2'
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
-# typed: false
+# frozen_string_literal: true
 
 require 'socket'
-require 'datadog/core/utils/forking'
+require_relative '../utils/forking'
 
 module Datadog
   module Core

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,18 +9,51 @@ 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
+        # Reads an environment variable as a Boolean.
+        #
+        # @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].to_s.strip
+            value.downcase!
+            value == 'true' || value == '1' # rubocop:disable Style/MultipleComparison
+          else
+            default
+          end
         end
 
-        def env_to_int(var, default = nil)
-          var = decode_array(var)
+        # 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
 
-        def env_to_float(var, default = nil)
-          var = decode_array(var)
+        # 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
 
@@ -33,8 +66,16 @@ module Datadog
         # 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 [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]
 
@@ -59,8 +100,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/error.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-# typed: false
-
-require 'datadog/core/utils'
+require_relative 'utils'
 
 module Datadog
   module Core

data/lib/datadog/core/extensions.rb

@@ -1,6 +1,6 @@
-# typed: true
+# frozen_string_literal: true
 
-require 'datadog/core/configuration'
+require_relative 'configuration'
 
 # Global namespace that includes all Datadog functionality.
 # @public_api

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

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Core
     module Git

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

@@ -1,13 +1,12 @@
-# typed: false
+require_relative '../utils/time'
+require_relative '../utils/only_once'
+require_relative '../configuration/ext'
 
-require 'datadog/core/utils/time'
-require 'datadog/core/utils/only_once'
-
-require 'datadog/core/metrics/ext'
-require 'datadog/core/metrics/options'
-require 'datadog/core/metrics/helpers'
-require 'datadog/core/metrics/logging'
-require 'datadog/core/metrics/metric'
+require_relative 'ext'
+require_relative 'options'
+require_relative 'helpers'
+require_relative 'logging'
+require_relative 'metric'
 
 module Datadog
   module Core
@@ -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,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Core
     module Metrics
@@ -7,8 +5,6 @@ module Datadog
       module Ext
         DEFAULT_HOST = '127.0.0.1'.freeze
         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

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,8 +1,6 @@
-# typed: true
-
-require 'datadog/core/metrics/ext'
-require 'datadog/core/environment/ext'
-require 'datadog/core/environment/identity'
+require_relative 'ext'
+require_relative '../environment/ext'
+require_relative '../environment/identity'
 
 module Datadog
   module Core

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,57 @@
+# frozen_string_literal: true
+
+require_relative '../../../appsec/remote'
+
+module Datadog
+  module Core
+    module Remote
+      class Client
+        # Capbailities
+        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
+          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