ddtrace 1.2.0 → 1.10.1

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

@@ -1,5 +1,3 @@
-# typed: false
-
 module Datadog
   module Core
     # Namespace for handling application environment
@@ -9,18 +7,45 @@ module Datadog
       module VariableHelpers
         extend self
 
-        def env_to_bool(var, default = nil)
-          var = decode_array(var)
+        # 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`
+        # @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)
           var && ENV.key?(var) ? ENV[var].to_s.strip.downcase == 'true' : default
         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 +58,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 +92,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,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Core
     module Environment
@@ -20,6 +18,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 +39,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,4 @@
-# typed: 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,41 @@
+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,5 +1,3 @@
-# typed: false
-
 module Datadog
   module Core
     module Metrics

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,5 +1,3 @@
-# typed: false
-
 module Datadog
   module Core
     module Metrics

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/runtime/ext.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Core
     module Runtime
@@ -7,7 +5,7 @@ module Datadog
       module Ext
         TAG_ID = 'runtime-id'.freeze
         TAG_LANG = 'language'.freeze
-        TAG_PID = 'system.pid'.freeze
+        TAG_PROCESS_ID = 'process_id'.freeze
 
         # Metrics
         # @public_api
@@ -19,6 +17,8 @@ module Datadog
           METRIC_THREAD_COUNT = 'runtime.ruby.thread_count'.freeze
           METRIC_GLOBAL_CONSTANT_STATE = 'runtime.ruby.global_constant_state'.freeze
           METRIC_GLOBAL_METHOD_STATE = 'runtime.ruby.global_method_state'.freeze
+          METRIC_CONSTANT_CACHE_INVALIDATIONS = 'runtime.ruby.constant_cache_invalidations'.freeze
+          METRIC_CONSTANT_CACHE_MISSES = 'runtime.ruby.constant_cache_misses'.freeze
 
           TAG_SERVICE = 'service'.freeze
         end

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

@@ -1,12 +1,10 @@
-# typed: true
+require_relative 'ext'
 
-require 'datadog/core/runtime/ext'
-
-require 'datadog/core/metrics/client'
-require 'datadog/core/environment/class_count'
-require 'datadog/core/environment/gc'
-require 'datadog/core/environment/thread_count'
-require 'datadog/core/environment/vm_cache'
+require_relative '../metrics/client'
+require_relative '../environment/class_count'
+require_relative '../environment/gc'
+require_relative '../environment/thread_count'
+require_relative '../environment/vm_cache'
 
 module Datadog
   module Core
@@ -57,15 +55,27 @@ module Datadog
 
           try_flush do
             if Core::Environment::VMCache.available?
-              gauge(
+              # Only on Ruby < 3.2
+              gauge_if_not_nil(
                 Core::Runtime::Ext::Metrics::METRIC_GLOBAL_CONSTANT_STATE,
                 Core::Environment::VMCache.global_constant_state
               )
 
-              # global_method_state is not available since Ruby >= 3.0,
-              # as method caching was moved to a per-class basis.
-              global_method_state = Core::Environment::VMCache.global_method_state
-              gauge(Core::Runtime::Ext::Metrics::METRIC_GLOBAL_METHOD_STATE, global_method_state) if global_method_state
+              # Only on Ruby 2.x
+              gauge_if_not_nil(
+                Core::Runtime::Ext::Metrics::METRIC_GLOBAL_METHOD_STATE,
+                Core::Environment::VMCache.global_method_state
+              )
+
+              # Only on Ruby >= 3.2
+              gauge_if_not_nil(
+                Core::Runtime::Ext::Metrics::METRIC_CONSTANT_CACHE_INVALIDATIONS,
+                Core::Environment::VMCache.constant_cache_invalidations
+              )
+              gauge_if_not_nil(
+                Core::Runtime::Ext::Metrics::METRIC_CONSTANT_CACHE_MISSES,
+                Core::Environment::VMCache.constant_cache_misses
+              )
             end
           end
         end
@@ -120,6 +130,10 @@ module Datadog
         def to_metric_name(str)
           str.downcase.gsub(/[-\s]/, '_')
         end
+
+        def gauge_if_not_nil(metric_name, metric_value)
+          gauge(metric_name, metric_value) if metric_value
+        end
       end
     end
   end

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

@@ -0,0 +1,77 @@
+require_relative 'emitter'
+require_relative 'heartbeat'
+require_relative '../utils/forking'
+
+module Datadog
+  module Core
+    module Telemetry
+      # Telemetry entrypoint, coordinates sending telemetry events at various points in app lifecyle
+      class Client
+        attr_reader \
+          :emitter,
+          :enabled,
+          :unsupported,
+          :worker
+
+        include Core::Utils::Forking
+
+        # @param enabled [Boolean] Determines whether telemetry events should be sent to the API
+        def initialize(enabled: true)
+          @enabled = enabled
+          @emitter = Emitter.new
+          @stopped = false
+          @unsupported = false
+          @worker = Telemetry::Heartbeat.new(enabled: @enabled) do
+            heartbeat!
+          end
+        end
+
+        def disable!
+          @enabled = false
+          @worker.enabled = false
+        end
+
+        def started!
+          return if !@enabled || forked?
+
+          res = @emitter.request(:'app-started')
+
+          if res.not_found? # Telemetry is only supported by agent versions 7.34 and up
+            Datadog.logger.debug('Agent does not support telemetry; disabling future telemetry events.')
+            disable!
+            @unsupported = true # Prevent telemetry from getting re-enabled
+          end
+
+          res
+        end
+
+        def emit_closing!
+          return if !@enabled || forked?
+
+          @emitter.request(:'app-closing')
+        end
+
+        def stop!
+          return if @stopped
+
+          @worker.stop(true, 0)
+          @stopped = true
+        end
+
+        def integrations_change!
+          return if !@enabled || forked?
+
+          @emitter.request(:'app-integrations-change')
+        end
+
+        private
+
+        def heartbeat!
+          return if !@enabled || forked?
+
+          @emitter.request(:'app-heartbeat')
+        end
+      end
+    end
+  end
+end