ddtrace 0.42.0 → 0.54.2

data/lib/ddtrace/ext/runtime.rb

@@ -1,16 +1,12 @@
+# typed: true
 require 'ddtrace/version'
 
 module Datadog
   module Ext
     module Runtime
-      # Identity
-      LANG = 'ruby'.freeze
-      LANG_INTERPRETER = (RUBY_ENGINE + '-' + RUBY_PLATFORM).freeze
-      LANG_VERSION = RUBY_VERSION
-      RUBY_ENGINE =  ::RUBY_ENGINE # e.g. 'ruby', 'jruby', 'truffleruby'
-      TRACER_VERSION = Datadog::VERSION::STRING
-
+      TAG_ID = 'runtime-id'.freeze
       TAG_LANG = 'language'.freeze
+      TAG_PID = 'system.pid'.freeze
 
       # Metrics
       module Metrics
@@ -19,6 +15,8 @@ module Datadog
         METRIC_CLASS_COUNT = 'runtime.ruby.class_count'.freeze
         METRIC_GC_PREFIX = 'runtime.ruby.gc'.freeze
         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
 
         TAG_SERVICE = 'service'.freeze
       end

data/lib/ddtrace/ext/sampling.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Ext
     module Sampling

data/lib/ddtrace/ext/sql.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Ext
     module SQL

data/lib/ddtrace/ext/test.rb

@@ -0,0 +1,9 @@
+# typed: true
+module Datadog
+  module Ext
+    # Defines constants for test behavior
+    module Test
+      ENV_MODE_ENABLED = 'DD_TRACE_TEST_MODE_ENABLED'.freeze
+    end
+  end
+end

data/lib/ddtrace/ext/transport.rb

@@ -1,18 +1,32 @@
+# typed: true
 module Datadog
   module Ext
     module Transport
       module HTTP
+        ADAPTER = :net_http # DEV: Rename to simply `:http`, as Net::HTTP is an implementation detail.
         DEFAULT_HOST = '127.0.0.1'.freeze
         DEFAULT_PORT = 8126
+        DEFAULT_TIMEOUT_SECONDS = 1
         ENV_DEFAULT_HOST = 'DD_AGENT_HOST'.freeze
         ENV_DEFAULT_PORT = 'DD_TRACE_AGENT_PORT'.freeze
         ENV_DEFAULT_URL = 'DD_TRACE_AGENT_URL'.freeze
         HEADER_CONTAINER_ID = 'Datadog-Container-ID'.freeze
+        HEADER_DD_API_KEY = 'DD-API-KEY'.freeze
         HEADER_META_LANG = 'Datadog-Meta-Lang'.freeze
         HEADER_META_LANG_VERSION = 'Datadog-Meta-Lang-Version'.freeze
         HEADER_META_LANG_INTERPRETER = 'Datadog-Meta-Lang-Interpreter'.freeze
         HEADER_META_TRACER_VERSION = 'Datadog-Meta-Tracer-Version'.freeze
       end
+
+      module Test
+        ADAPTER = :test
+      end
+
+      module UnixSocket
+        ADAPTER = :unix
+        DEFAULT_PATH = '/var/run/datadog/apm.socket'.freeze
+        DEFAULT_TIMEOUT_SECONDS = 1
+      end
     end
   end
 end

data/lib/ddtrace/forced_tracing.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/manual_tracing'
 require 'ddtrace/ext/priority'
 
@@ -7,11 +8,13 @@ module Datadog
     class << self
       def keep(span)
         return if span.nil? || span.context.nil?
+
         span.context.sampling_priority = Datadog::Ext::Priority::USER_KEEP
       end
 
       def drop(span)
         return if span.nil? || span.context.nil?
+
         span.context.sampling_priority = Datadog::Ext::Priority::USER_REJECT
       end
     end

data/lib/ddtrace/logger.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'logger'
 
 module Datadog
@@ -23,7 +24,7 @@ module Datadog
       end
 
       if message.nil?
-        if block_given?
+        if block
           super(severity, message, progname) do
             "[#{self.progname}] #{where}#{yield}"
           end

data/lib/ddtrace/metrics.rb

@@ -1,10 +1,12 @@
+# typed: false
 require 'ddtrace/ext/metrics'
 
 require 'set'
 require 'logger'
-require 'ddtrace/environment'
+require 'datadog/core/environment/identity'
+require 'ddtrace/ext/environment'
+require 'ddtrace/utils/only_once'
 require 'ddtrace/utils/time'
-require 'ddtrace/runtime/identity'
 
 module Datadog
   # Acts as client for sending metrics (via Statsd)
@@ -12,16 +14,24 @@ module Datadog
   class Metrics
     attr_reader :statsd
 
-    def initialize(options = {})
-      @statsd = options.fetch(:statsd) { default_statsd_client if supported? }
-      @enabled = options.fetch(:enabled, true)
+    def initialize(statsd: nil, enabled: true, **_)
+      @statsd =
+        if supported?
+          statsd || default_statsd_client
+        else
+          ignored_statsd_warning if statsd
+          nil
+        end
+      @enabled = enabled
     end
 
     def supported?
-      version = Gem.loaded_specs['dogstatsd-ruby'] \
-                  && Gem.loaded_specs['dogstatsd-ruby'].version
+      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'))
     end
 
     def enabled?
@@ -41,10 +51,25 @@ module Datadog
     end
 
     def default_statsd_client
-      require 'datadog/statsd' unless defined?(::Datadog::Statsd)
+      require 'datadog/statsd'
 
       # Create a StatsD client that points to the agent.
-      Datadog::Statsd.new(default_hostname, default_port)
+      #
+      # We use `single_thread: true`, as dogstatsd-ruby >= 5.0 creates a background thread
+      # by default, but does not handle forks correctly, causing resource leaks.
+      #
+      # Using dogstatsd-ruby >= 5.0 is still valuable, as it supports
+      # transparent batch metric submission, which reduces submission
+      # overhead.
+      #
+      # Versions < 5.0 are always single-threaded, but do not have the kwarg option.
+      options = if dogstatsd_version >= Gem::Version.new('5.2')
+                  { single_thread: true }
+                else
+                  {}
+                end
+
+      Datadog::Statsd.new(default_hostname, default_port, **options)
     end
 
     def configure(options = {})
@@ -58,41 +83,45 @@ module Datadog
 
     def count(stat, value = nil, options = nil, &block)
       return unless send_stats? && statsd.respond_to?(:count)
-      value, options = yield if block_given?
+
+      value, options = yield if block
       raise ArgumentError if value.nil?
 
       statsd.count(stat, value, metric_options(options))
     rescue StandardError => e
-      Datadog.logger.error("Failed to send count stat. Cause: #{e.message} Source: #{e.backtrace.first}")
+      Datadog.logger.error("Failed to send count stat. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
     end
 
     def distribution(stat, value = nil, options = nil, &block)
       return unless send_stats? && statsd.respond_to?(:distribution)
-      value, options = yield if block_given?
+
+      value, options = yield if block
       raise ArgumentError if value.nil?
 
       statsd.distribution(stat, value, metric_options(options))
     rescue StandardError => e
-      Datadog.logger.error("Failed to send distribution stat. Cause: #{e.message} Source: #{e.backtrace.first}")
+      Datadog.logger.error("Failed to send distribution stat. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
     end
 
     def increment(stat, options = nil)
       return unless send_stats? && statsd.respond_to?(:increment)
+
       options = yield if block_given?
 
       statsd.increment(stat, metric_options(options))
     rescue StandardError => e
-      Datadog.logger.error("Failed to send increment stat. Cause: #{e.message} Source: #{e.backtrace.first}")
+      Datadog.logger.error("Failed to send increment stat. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
     end
 
     def gauge(stat, value = nil, options = nil, &block)
       return unless send_stats? && statsd.respond_to?(:gauge)
-      value, options = yield if block_given?
+
+      value, options = yield if block
       raise ArgumentError if value.nil?
 
       statsd.gauge(stat, value, metric_options(options))
     rescue StandardError => e
-      Datadog.logger.error("Failed to send gauge stat. Cause: #{e.message} Source: #{e.backtrace.first}")
+      Datadog.logger.error("Failed to send gauge stat. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
     end
 
     def time(stat, options = nil)
@@ -100,7 +129,7 @@ module Datadog
 
       # Calculate time, send it as a distribution.
       start = Utils::Time.get_time
-      return yield
+      yield
     ensure
       begin
         if send_stats? && !start.nil?
@@ -108,7 +137,7 @@ module Datadog
           distribution(stat, ((finished - start) * 1000), options)
         end
       rescue StandardError => e
-        Datadog.logger.error("Failed to send time stat. Cause: #{e.message} Source: #{e.backtrace.first}")
+        Datadog.logger.error("Failed to send time stat. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
       end
     end
 
@@ -116,6 +145,10 @@ module Datadog
       metrics.each { |m| send(m.type, *[m.name, m.value, m.options].compact) }
     end
 
+    def close
+      @statsd.close if @statsd && @statsd.respond_to?(:close)
+    end
+
     Metric = Struct.new(:type, :name, :value, :options) do
       def initialize(*args)
         super
@@ -127,10 +160,10 @@ module Datadog
     module Options
       DEFAULT = {
         tags: DEFAULT_TAGS = [
-          "#{Ext::Metrics::TAG_LANG}:#{Runtime::Identity.lang}".freeze,
-          "#{Ext::Metrics::TAG_LANG_INTERPRETER}:#{Runtime::Identity.lang_interpreter}".freeze,
-          "#{Ext::Metrics::TAG_LANG_VERSION}:#{Runtime::Identity.lang_version}".freeze,
-          "#{Ext::Metrics::TAG_TRACER_VERSION}:#{Runtime::Identity.tracer_version}".freeze
+          "#{Ext::Metrics::TAG_LANG}:#{Core::Environment::Identity.lang}".freeze,
+          "#{Ext::Metrics::TAG_LANG_INTERPRETER}:#{Core::Environment::Identity.lang_interpreter}".freeze,
+          "#{Ext::Metrics::TAG_LANG_VERSION}:#{Core::Environment::Identity.lang_version}".freeze,
+          "#{Ext::Metrics::TAG_TRACER_VERSION}:#{Core::Environment::Identity.tracer_version}".freeze
         ].freeze
       }.freeze
 
@@ -186,7 +219,7 @@ module Datadog
         attr_accessor :logger
 
         def initialize(logger = nil)
-          @logger = logger || Logger.new(STDOUT).tap do |l|
+          @logger = logger || Logger.new($stdout).tap do |l|
             l.level = Logger::INFO
             l.progname = nil
             l.formatter = proc do |_severity, datetime, _progname, msg|
@@ -218,5 +251,32 @@ module Datadog
     include Options
     extend Options
     extend Helpers
+
+    private
+
+    def dogstatsd_version
+      return @dogstatsd_version if instance_variable_defined?(:@dogstatsd_version)
+
+      @dogstatsd_version = (
+        defined?(Datadog::Statsd::VERSION) &&
+          Datadog::Statsd::VERSION &&
+          Gem::Version.new(Datadog::Statsd::VERSION)
+      ) || (
+        Gem.loaded_specs['dogstatsd-ruby'] &&
+          Gem.loaded_specs['dogstatsd-ruby'].version
+      )
+    end
+
+    IGNORED_STATSD_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+    private_constant :IGNORED_STATSD_ONLY_ONCE
+
+    def ignored_statsd_warning
+      IGNORED_STATSD_ONLY_ONCE.run do
+        Datadog.logger.warn(
+          '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
+    end
   end
 end

data/lib/ddtrace/opentelemetry/extensions.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/span'
 require 'ddtrace/opentelemetry/span'
 
@@ -6,7 +7,7 @@ module Datadog
     # Defines extensions to ddtrace for OpenTelemetry support
     module Extensions
       def self.extended(base)
-        Datadog::Span.send(:prepend, OpenTelemetry::Span)
+        Datadog::Span.prepend(OpenTelemetry::Span)
       end
     end
   end

data/lib/ddtrace/opentelemetry/span.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/ext/environment'
 
 module Datadog

data/lib/ddtrace/opentracer/binary_propagator.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module OpenTracer
     # OpenTracing propagator for Datadog::OpenTracer::Tracer

data/lib/ddtrace/opentracer/carrier.rb

@@ -1,3 +1,4 @@
+# typed: strict
 module Datadog
   module OpenTracer
     class Carrier < ::OpenTracing::Carrier

data/lib/ddtrace/opentracer/distributed_headers.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/span'
 require 'ddtrace/ext/distributed'
 
@@ -29,8 +30,10 @@ module Datadog
         # It's important to make a difference between no header,
         # and a header defined to zero.
         return unless hdr
+
         value = hdr.to_i
         return if value < 0
+
         value
       end
 
@@ -45,6 +48,7 @@ module Datadog
       def id(header)
         value = @carrier[header].to_i
         return if value.zero? || value >= Datadog::Span::EXTERNAL_MAX_ID
+
         value < 0 ? value + 0x1_0000_0000_0000_0000 : value
       end
     end

data/lib/ddtrace/opentracer/global_tracer.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module OpenTracer
     # Patch for OpenTracing module

data/lib/ddtrace/opentracer/propagator.rb

@@ -1,3 +1,4 @@
+# typed: false
 module Datadog
   module OpenTracer
     # OpenTracing propagator for Datadog::OpenTracer::Tracer

data/lib/ddtrace/opentracer/rack_propagator.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/propagation/http_propagator'
 
 module Datadog

data/lib/ddtrace/opentracer/scope.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module OpenTracer
     # OpenTracing adapter for scope

data/lib/ddtrace/opentracer/scope_manager.rb

@@ -1,3 +1,4 @@
+# typed: strict
 module Datadog
   module OpenTracer
     class ScopeManager < ::OpenTracing::ScopeManager

data/lib/ddtrace/opentracer/span.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module OpenTracer
     # OpenTracing adapter for Datadog::Span
@@ -73,9 +74,7 @@ module Datadog
         super # Log deprecation warning
 
         # If the fields specify an error
-        if fields.key?(:'error.object')
-          datadog_span.set_error(fields[:'error.object'])
-        end
+        datadog_span.set_error(fields[:'error.object']) if fields.key?(:'error.object')
       end
 
       # Add a log entry to this span
@@ -83,9 +82,7 @@ module Datadog
       # @param fields [Hash] Additional information to log
       def log_kv(timestamp: Time.now, **fields)
         # If the fields specify an error
-        if fields.key?(:'error.object')
-          datadog_span.set_error(fields[:'error.object'])
-        end
+        datadog_span.set_error(fields[:'error.object']) if fields.key?(:'error.object')
       end
 
       # Finish the {Span}

data/lib/ddtrace/opentracer/span_context.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module OpenTracer
     # OpenTracing adapter for SpanContext

data/lib/ddtrace/opentracer/span_context_factory.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module OpenTracer
     # Creates new Datadog::OpenTracer::SpanContext

data/lib/ddtrace/opentracer/text_map_propagator.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/distributed'
 
 module Datadog

data/lib/ddtrace/opentracer/thread_local_scope.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module OpenTracer
     # OpenTracing adapter for thread local scopes
@@ -22,6 +23,7 @@ module Datadog
       # undefined behavior.
       def close
         return unless equal?(manager.active)
+
         span.finish if finish_on_close
         manager.send(:set_scope, @previous_scope)
       end

data/lib/ddtrace/opentracer/thread_local_scope_manager.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module OpenTracer
     # OpenTracing adapter for thread local scope management

data/lib/ddtrace/opentracer/tracer.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/tracer'
 
 module Datadog

data/lib/ddtrace/opentracer.rb

@@ -1,40 +1,22 @@
-module Datadog
-  # Namespace for ddtrace OpenTracing implementation
-  module OpenTracer
-    module_function
+# typed: strict
+require 'opentracing'
+require 'opentracing/carrier'
+require 'ddtrace'
+require 'ddtrace/opentracer/carrier'
+require 'ddtrace/opentracer/tracer'
+require 'ddtrace/opentracer/span'
+require 'ddtrace/opentracer/span_context'
+require 'ddtrace/opentracer/span_context_factory'
+require 'ddtrace/opentracer/scope'
+require 'ddtrace/opentracer/scope_manager'
+require 'ddtrace/opentracer/thread_local_scope'
+require 'ddtrace/opentracer/thread_local_scope_manager'
+require 'ddtrace/opentracer/distributed_headers'
+require 'ddtrace/opentracer/propagator'
+require 'ddtrace/opentracer/text_map_propagator'
+require 'ddtrace/opentracer/binary_propagator'
+require 'ddtrace/opentracer/rack_propagator'
+require 'ddtrace/opentracer/global_tracer'
 
-    def supported?
-      Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.1')
-    end
-
-    def load_opentracer
-      require 'opentracing'
-      require 'opentracing/carrier'
-      require 'ddtrace'
-      require 'ddtrace/opentracer/carrier'
-      require 'ddtrace/opentracer/tracer'
-      require 'ddtrace/opentracer/span'
-      require 'ddtrace/opentracer/span_context'
-      require 'ddtrace/opentracer/span_context_factory'
-      require 'ddtrace/opentracer/scope'
-      require 'ddtrace/opentracer/scope_manager'
-      require 'ddtrace/opentracer/thread_local_scope'
-      require 'ddtrace/opentracer/thread_local_scope_manager'
-      require 'ddtrace/opentracer/distributed_headers'
-      require 'ddtrace/opentracer/propagator'
-      require 'ddtrace/opentracer/text_map_propagator'
-      require 'ddtrace/opentracer/binary_propagator'
-      require 'ddtrace/opentracer/rack_propagator'
-      require 'ddtrace/opentracer/global_tracer'
-
-      # Modify the OpenTracing module functions
-      OpenTracing.module_eval do
-        class << self
-          prepend Datadog::OpenTracer::GlobalTracer
-        end
-      end
-    end
-
-    load_opentracer if supported?
-  end
-end
+# Modify the OpenTracing module functions
+::OpenTracing.singleton_class.prepend(Datadog::OpenTracer::GlobalTracer)

data/lib/ddtrace/patcher.rb

@@ -1,9 +1,24 @@
+# typed: false
+require 'ddtrace/utils/only_once'
+
 module Datadog
-  # Defines some useful patching methods for integrations
+  # Deprecated: This module should no longer be included. It's only being kept around for backwards compatibility
+  # concerns regarding customer usage.
   module Patcher
+    INCLUDED_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+    DO_ONCE_USAGE_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+
     def self.included(base)
-      base.send(:extend, CommonMethods)
-      base.send(:include, CommonMethods)
+      INCLUDED_WARN_ONLY_ONCE.run do
+        Datadog.logger.warn(
+          'Including Datadog::Patcher is deprecated. ' \
+          'For the #do_once behavior, use Datadog::Utils::OnlyOnce instead. ' \
+          'For the #without_warnings behavior, use Datadog::Patcher.without_warnings { ... } as a module function.'
+        )
+      end
+
+      base.extend(CommonMethods)
+      base.include(CommonMethods)
     end
 
     # Defines some common methods for patching, that can be used
@@ -22,11 +37,13 @@ module Datadog
       end
 
       def do_once(key = nil, options = {})
+        DO_ONCE_USAGE_WARN_ONLY_ONCE.run do
+          Datadog.logger.warn('Datadog::Patcher#do_once is deprecated. Use Datadog::Utils::OnlyOnce instead.')
+        end
+
         # If already done, don't do again
         @done_once ||= Hash.new { |h, k| h[k] = {} }
-        if @done_once.key?(key) && @done_once[key].key?(options[:for])
-          return @done_once[key][options[:for]]
-        end
+        return @done_once[key][options[:for]] if @done_once.key?(key) && @done_once[key].key?(options[:for])
 
         # Otherwise 'do'
         yield.tap do
@@ -36,7 +53,12 @@ module Datadog
       end
 
       def done?(key, options = {})
+        DO_ONCE_USAGE_WARN_ONLY_ONCE.run do
+          Datadog.logger.warn('Datadog::Patcher#done? is deprecated. Use Datadog::Utils::OnlyOnce instead.')
+        end
+
         return false unless instance_variable_defined?(:@done_once)
+
         !@done_once.nil? && @done_once.key?(key) && @done_once[key].key?(options[:for])
       end
     end