ddtrace 0.49.0 → 0.50.0

data/lib/ddtrace/ext/app_types.rb

@@ -6,7 +6,6 @@ module Datadog
       CACHE = 'cache'.freeze
       WORKER = 'worker'.freeze
       CUSTOM = 'custom'.freeze
-      TEST = 'test'.freeze
     end
   end
 end

data/lib/ddtrace/ext/test.rb

@@ -1,24 +1,8 @@
 module Datadog
   module Ext
-    # Defines constants for test tags
+    # Defines constants for test behavior
     module Test
-      TAG_ARGUMENTS = 'test.arguments'.freeze
-      TAG_FRAMEWORK = 'test.framework'.freeze
-      TAG_NAME = 'test.name'.freeze
-      TAG_SKIP_REASON = 'test.skip_reason'.freeze
-      TAG_STATUS = 'test.status'.freeze
-      TAG_SUITE = 'test.suite'.freeze
-      TAG_TRAITS = 'test.traits'.freeze
-      TAG_TYPE = 'test.type'.freeze
-
-      # TODO: is there a better place for SPAN_KIND?
-      TAG_SPAN_KIND = 'span.kind'.freeze
-
-      module Status
-        PASS = 'pass'.freeze
-        FAIL = 'fail'.freeze
-        SKIP = 'skip'.freeze
-      end
+      ENV_MODE_ENABLED = 'DD_TRACE_TEST_MODE_ENABLED'.freeze
     end
   end
 end

data/lib/ddtrace/metrics.rb

@@ -3,8 +3,9 @@ require 'ddtrace/ext/metrics'
 require 'set'
 require 'logger'
 require 'ddtrace/environment'
-require 'ddtrace/utils/time'
 require 'ddtrace/runtime/identity'
+require 'ddtrace/utils/only_once'
+require 'ddtrace/utils/time'
 
 module Datadog
   # Acts as client for sending metrics (via Statsd)
@@ -18,8 +19,14 @@ module Datadog
     end
 
     def supported?
-      version = Gem.loaded_specs['dogstatsd-ruby'] \
-                  && Gem.loaded_specs['dogstatsd-ruby'].version
+      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
+        )
 
       !version.nil? && (version >= Gem::Version.new('3.3.0'))
     end
@@ -43,6 +50,8 @@ module Datadog
     def default_statsd_client
       require 'datadog/statsd'
 
+      incompatible_statsd_warning
+
       # Create a StatsD client that points to the agent.
       Datadog::Statsd.new(default_hostname, default_port)
     end
@@ -226,5 +235,21 @@ module Datadog
     include Options
     extend Options
     extend Helpers
+
+    private
+
+    INCOMPATIBLE_STATSD_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+    private_constant :INCOMPATIBLE_STATSD_ONLY_ONCE
+
+    def incompatible_statsd_warning
+      return if Gem.loaded_specs['dogstatsd-ruby'].version < Gem::Version.new('5.0')
+
+      INCOMPATIBLE_STATSD_ONLY_ONCE.run do
+        Datadog.logger.warn(
+          'This version of `ddtrace` is incompatible with `dogstastd-ruby` version >= 5.0 and can ' \
+          'cause unbounded memory usage. Please use `dogstastd-ruby` version < 5.0 instead.'
+        )
+      end
+    end
   end
 end

data/lib/ddtrace/opentelemetry/extensions.rb

@@ -6,7 +6,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/opentracer.rb

@@ -1,40 +1,21 @@
-module Datadog
-  # Namespace for ddtrace OpenTracing implementation
-  module OpenTracer
-    module_function
+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

@@ -16,8 +16,8 @@ module Datadog
         )
       end
 
-      base.send(:extend, CommonMethods)
-      base.send(:include, CommonMethods)
+      base.extend(CommonMethods)
+      base.include(CommonMethods)
     end
 
     # Defines some common methods for patching, that can be used

data/lib/ddtrace/profiling.rb

@@ -14,8 +14,7 @@ module Datadog
       # NOTE: Only the first matching reason is returned, so try to keep a nice order on reasons -- e.g. tell users
       # first that they can't use this on JRuby before telling them that they are missing protobuf
 
-      ruby_engine_unsupported? || ruby_version_unsupported? ||
-        protobuf_gem_unavailable? || protobuf_version_unsupported? || protobuf_failed_to_load?
+      ruby_engine_unsupported? || protobuf_gem_unavailable? || protobuf_version_unsupported? || protobuf_failed_to_load?
     end
 
     def self.ruby_engine_unsupported?
@@ -23,20 +22,21 @@ module Datadog
     end
     private_class_method :ruby_engine_unsupported?
 
-    def self.ruby_version_unsupported?
-      'Ruby >= 2.1 is required' if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.1')
-    end
-    private_class_method :ruby_version_unsupported?
-
     def self.protobuf_gem_unavailable?
-      if Gem.loaded_specs['google-protobuf'].nil?
+      # NOTE: On environments where protobuf is already loaded, we skip the check. This allows us to support environments
+      # where no Gem.loaded_version is NOT available but customers are able to load protobuf; see for instance
+      # https://github.com/teamcapybara/capybara/commit/caf3bcd7664f4f2691d0ca9ef3be9a2a954fecfb
+      if !defined?(::Google::Protobuf) && Gem.loaded_specs['google-protobuf'].nil?
         "Missing google-protobuf dependency; please add `gem 'google-protobuf', '~> 3.0'` to your Gemfile or gems.rb file"
       end
     end
     private_class_method :protobuf_gem_unavailable?
 
     def self.protobuf_version_unsupported?
-      if Gem.loaded_specs['google-protobuf'].version < GOOGLE_PROTOBUF_MINIMUM_VERSION
+      # See above for why we skip the check when protobuf is already loaded; note that when protobuf was already loaded
+      # we skip the version check to avoid the call to Gem.loaded_specs. Unfortunately, protobuf does not seem to
+      # expose the gem version constant elsewhere, so in that setup we are not able to check the version.
+      if !defined?(::Google::Protobuf) && Gem.loaded_specs['google-protobuf'].version < GOOGLE_PROTOBUF_MINIMUM_VERSION
         'Your google-protobuf is too old; ensure that you have google-protobuf >= 3.0 by ' \
         "adding `gem 'google-protobuf', '~> 3.0'` to your Gemfile or gems.rb file"
       end
@@ -66,6 +66,8 @@ module Datadog
         require 'google/protobuf'
         @protobuf_loaded = true
       rescue LoadError => e
+        # NOTE: We use Kernel#warn here because this code gets run BEFORE Datadog.logger is actually set up.
+        # In the future it'd be nice to shuffle the logger startup to happen first to avoid this special case.
         Kernel.warn(
           "[DDTRACE] Error while loading google-protobuf gem. Cause: '#{e.message}' Location: '#{e.backtrace.first}'. " \
           'This can happen when google-protobuf is missing its native components. ' \

data/lib/ddtrace/profiling/collectors/stack.rb

@@ -122,7 +122,7 @@ module Datadog
           # Convert backtrace locations into structs
           locations = convert_backtrace_locations(locations)
 
-          thread_id = thread.respond_to?(:native_thread_id) ? thread.native_thread_id : thread.object_id
+          thread_id = thread.respond_to?(:pthread_thread_id) ? thread.pthread_thread_id : thread.object_id
           trace_id, span_id = get_trace_identifiers(thread)
           cpu_time = get_cpu_time_interval!(thread)
 
@@ -224,6 +224,7 @@ module Datadog
             #    In this case, the fix is to make sure ddtrace gets loaded before any other parts of the application.
             #
             # b) The thread was started using the Ruby native APIs (e.g. from a C extension such as ffi).
+            #    Known cases right now that trigger this are the ethon/typhoeus gems.
             #    We currently have no solution for this case; these threads will always be missing our CPU instrumentation.
             #
             # c) The thread was started with `Thread.start`/`Thread.fork` and hasn't yet enabled the instrumentation.
@@ -232,7 +233,9 @@ module Datadog
             #    it to run and our instrumentation to be applied.
             #
             if thread_api.current.respond_to?(:cpu_time) && thread_api.current.cpu_time
-              Datadog.logger.debug("Detected thread ('#{thread}') with missing CPU profiling instrumentation.")
+              Datadog.logger.debug(
+                "Thread ('#{thread}') is missing profiling instrumentation; other threads should be unaffected"
+              )
             end
           end
         end

data/lib/ddtrace/profiling/encoding/profile.rb

@@ -1,4 +1,5 @@
 require 'set'
+require 'time'
 
 require 'ddtrace/profiling/flush'
 require 'ddtrace/profiling/pprof/template'
@@ -21,6 +22,11 @@ module Datadog
             # Add all events to the pprof
             flush.event_groups.each { |event_group| template.add_events!(event_group.event_class, event_group.events) }
 
+            Datadog.logger.debug do
+              "Encoding profile covering #{flush.start.iso8601} to #{flush.finish.iso8601}, " \
+              "events: #{flush.event_count} (#{template.debug_statistics})"
+            end
+
             # Build the profile and encode it
             template.to_pprof
           end

data/lib/ddtrace/profiling/ext/cpu.rb

@@ -24,8 +24,8 @@ module Datadog
           # Applying CThread to Thread will ensure any new threads
           # will provide a thread/clock ID for CPU timing.
           require 'ddtrace/profiling/ext/cthread'
-          ::Thread.send(:prepend, Profiling::Ext::CThread)
-          ::Thread.singleton_class.send(:prepend, Datadog::Profiling::Ext::WrapThreadStartFork)
+          ::Thread.prepend(Profiling::Ext::CThread)
+          ::Thread.singleton_class.prepend(Datadog::Profiling::Ext::WrapThreadStartFork)
         end
 
         def self.unsupported_reason

data/lib/ddtrace/profiling/ext/cthread.rb

@@ -16,9 +16,9 @@ module Datadog
         attach_function :pthread_getcpuclockid, [:ulong, CClockId], :int
 
         # NOTE: Only returns thread ID for thread that evaluates this call.
-        #       a.k.a. evaluating `get_native_thread_id(thread_a)` from within
+        #       a.k.a. evaluating `get_pthread_thread_id(thread_a)` from within
         #       `thread_b` will return `thread_b`'s thread ID, not `thread_a`'s.
-        def self.get_native_thread_id(thread)
+        def self.get_pthread_thread_id(thread)
           return unless ::Thread.current == thread
 
           pthread_self
@@ -65,16 +65,16 @@ module Datadog
         # it looks like there's some lazily-created structure that is missing and did not get created).
         if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3') &&
            Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7')
-          attr_reader :native_thread_id
+          attr_reader :pthread_thread_id
         else
-          def native_thread_id
-            defined?(@native_thread_id) && @native_thread_id
+          def pthread_thread_id
+            defined?(@pthread_thread_id) && @pthread_thread_id
           end
         end
 
         def initialize(*args)
           @pid = ::Process.pid
-          @native_thread_id = nil
+          @pthread_thread_id = nil
           @clock_id = nil
 
           # Wrap the work block with our own
@@ -91,9 +91,7 @@ module Datadog
         ruby2_keywords :initialize if respond_to?(:ruby2_keywords, true)
 
         def cpu_time(unit = :float_second)
-          return unless clock_id && ::Process.respond_to?(:clock_gettime)
-
-          ::Process.clock_gettime(clock_id, unit)
+          ::Process.clock_gettime(clock_id, unit) if clock_id
         end
 
         def cpu_time_instrumentation_installed?
@@ -122,8 +120,8 @@ module Datadog
           return unless ::Thread.current == self
 
           @pid = ::Process.pid
-          @native_thread_id = NativePthread.get_native_thread_id(self)
-          @clock_id = NativePthread.get_clock_id(self, @native_thread_id)
+          @pthread_thread_id = NativePthread.get_pthread_thread_id(self)
+          @clock_id = NativePthread.get_clock_id(self, @pthread_thread_id)
         end
       end
 

data/lib/ddtrace/profiling/ext/forking.rb

@@ -24,13 +24,13 @@ module Datadog
           #       It could also have collisions with other libraries that patch.
           #       Opt to modify the inheritance of each relevant target instead.
           modules.each do |mod|
-            if mod.class <= Module
-              mod.singleton_class.class_eval do
-                prepend Kernel
-              end
-            else
-              mod.class.send(:prepend, Kernel)
-            end
+            clazz = if mod.class <= Module
+                      mod.singleton_class
+                    else
+                      mod.class
+                    end
+
+            clazz.prepend(Kernel)
           end
         end
 

data/lib/ddtrace/profiling/flush.rb

@@ -18,7 +18,8 @@ module Datadog
       :runtime_engine,
       :runtime_platform,
       :runtime_version,
-      :profiler_version
+      :profiler_version,
+      :tags
     ) do
       def initialize(*args)
         super
@@ -32,6 +33,7 @@ module Datadog
         self.runtime_platform = runtime_platform || Datadog::Runtime::Identity.lang_platform
         self.runtime_version = runtime_version || Datadog::Runtime::Identity.lang_version
         self.profiler_version = profiler_version || Datadog::Runtime::Identity.tracer_version
+        self.tags = tags || Datadog.configuration.tags
       end
     end
 

data/lib/ddtrace/profiling/pprof/builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ddtrace/profiling/flush'
 require 'ddtrace/profiling/pprof/message_set'
 require 'ddtrace/profiling/pprof/string_table'
@@ -7,9 +9,9 @@ module Datadog
     module Pprof
       # Accumulates profile data and produces a Perftools::Profiles::Profile
       class Builder
-        DEFAULT_ENCODING = 'UTF-8'.freeze
-        DESC_FRAME_OMITTED = 'frame omitted'.freeze
-        DESC_FRAMES_OMITTED = 'frames omitted'.freeze
+        DEFAULT_ENCODING = 'UTF-8'
+        DESC_FRAME_OMITTED = 'frame omitted'
+        DESC_FRAMES_OMITTED = 'frames omitted'
 
         attr_reader \
           :functions,
@@ -21,11 +23,23 @@ module Datadog
 
         def initialize
           @functions = MessageSet.new(1)
-          @locations = MessageSet.new(1)
+          @locations = initialize_locations_hash
           @mappings = MessageSet.new(1)
           @sample_types = MessageSet.new
           @samples = []
           @string_table = StringTable.new
+
+          # Cache this proc, since it's pretty expensive to keep recreating it
+          @build_function = method(:build_function).to_proc
+        end
+
+        # The locations hash maps unique BacktraceLocation instances to their corresponding pprof Location objects;
+        # there's a 1:1 correspondence, since BacktraceLocations were already deduped
+        def initialize_locations_hash
+          sequence = Utils::Sequence.new(1)
+          Hash.new do |locations_hash, backtrace_location|
+            locations_hash[backtrace_location] = build_location(sequence.next, backtrace_location)
+          end
         end
 
         def encode_profile(profile)
@@ -37,7 +51,7 @@ module Datadog
             sample_type: @sample_types.messages,
             sample: @samples,
             mapping: @mappings.messages,
-            location: @locations.messages,
+            location: @locations.values,
             function: @functions.messages,
             string_table: @string_table.strings
           )
@@ -51,45 +65,29 @@ module Datadog
         end
 
         def build_locations(backtrace_locations, length)
-          locations = backtrace_locations.collect do |backtrace_location|
-            @locations.fetch(
-              # Filename
-              backtrace_location.path,
-              # Line number
-              backtrace_location.lineno,
-              # Function name
-              backtrace_location.base_label,
-              # Build function
-              &method(:build_location)
-            )
-          end
+          locations = backtrace_locations.collect { |backtrace_location| @locations[backtrace_location] }
 
           omitted = length - backtrace_locations.length
 
           # Add placeholder stack frame if frames were truncated
           if omitted > 0
             desc = omitted == 1 ? DESC_FRAME_OMITTED : DESC_FRAMES_OMITTED
-            locations << @locations.fetch(
-              ''.freeze,
-              0,
-              "#{omitted} #{desc}",
-              &method(:build_location)
-            )
+            locations << @locations[Profiling::BacktraceLocation.new('', 0, "#{omitted} #{desc}")]
           end
 
           locations
         end
 
-        def build_location(id, filename, line_number, function_name = nil)
+        def build_location(id, backtrace_location)
           Perftools::Profiles::Location.new(
             id: id,
             line: [build_line(
               @functions.fetch(
-                filename,
-                function_name,
-                &method(:build_function)
+                backtrace_location.path,
+                backtrace_location.base_label,
+                &@build_function
               ).id,
-              line_number
+              backtrace_location.lineno
             )]
           )
         end