ddtrace 0.49.0 → 0.52.0

data/lib/ddtrace/profiling/event.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Profiling
     # Describes a sample of some data obtained from the runtime.

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/profiling/event'
 
 module Datadog
@@ -6,12 +7,13 @@ module Datadog
       # Describes a stack profiling event
       class Stack < Event
         attr_reader \
-          :frames,
           :hash,
-          :span_id,
-          :thread_id,
+          :frames,
           :total_frame_count,
-          :trace_id
+          :thread_id,
+          :trace_id,
+          :span_id,
+          :trace_resource_container
 
         def initialize(
           timestamp,
@@ -19,7 +21,8 @@ module Datadog
           total_frame_count,
           thread_id,
           trace_id,
-          span_id
+          span_id,
+          trace_resource_container
         )
           super(timestamp)
 
@@ -28,15 +31,16 @@ module Datadog
           @thread_id = thread_id
           @trace_id = trace_id
           @span_id = span_id
+          @trace_resource_container = trace_resource_container
 
           @hash = [
             thread_id,
             trace_id,
             span_id,
-            [
-              frames.collect(&:hash),
-              total_frame_count
-            ]
+            # trace_resource_container is deliberately not included -- events that share the same (trace_id, span_id)
+            # pair should also have the same trace_resource_container
+            frames.collect(&:hash),
+            total_frame_count
           ].hash
         end
       end
@@ -54,6 +58,7 @@ module Datadog
           thread_id,
           trace_id,
           span_id,
+          trace_resource_container,
           cpu_time_interval_ns,
           wall_time_interval_ns
         )
@@ -63,40 +68,14 @@ module Datadog
             total_frame_count,
             thread_id,
             trace_id,
-            span_id
+            span_id,
+            trace_resource_container
           )
 
           @cpu_time_interval_ns = cpu_time_interval_ns
           @wall_time_interval_ns = wall_time_interval_ns
         end
       end
-
-      # Describes a stack sample with exception
-      class StackExceptionSample < Stack
-        attr_reader \
-          :exception
-
-        def initialize(
-          timestamp,
-          frames,
-          total_frame_count,
-          thread_id,
-          trace_id,
-          span_id,
-          exception
-        )
-          super(
-            timestamp,
-            frames,
-            total_frame_count,
-            thread_id,
-            trace_id,
-            span_id
-          )
-
-          @exception = exception
-        end
-      end
     end
   end
 end

data/lib/ddtrace/profiling/exporter.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/profiling/transport/io/client'
 
 module Datadog

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Profiling
     module Ext
@@ -24,8 +25,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
@@ -43,9 +44,23 @@ module Datadog
           elsif Gem::Specification.find_all_by_name('rollbar', ROLLBAR_INCOMPATIBLE_VERSIONS).any?
             'You have an incompatible rollbar gem version installed; ensure that you have rollbar >= 3.1.2 by ' \
             "adding `gem 'rollbar', '>= 3.1.2'` to your Gemfile or gems.rb file. " \
-            'See https://github.com/rollbar/rollbar-gem/pull/1018 for details.'
+            'See https://github.com/rollbar/rollbar-gem/pull/1018 for details'
+          elsif Gem::Specification.find_all_by_name('logging').any? && logging_inherit_context_enabled?
+            'The `logging` gem is installed and its thread inherit context feature is enabled. ' \
+            "Please add LOGGING_INHERIT_CONTEXT=false to your application's environment variables to disable the " \
+            'conflicting `logging` gem feature. ' \
+            'See https://github.com/TwP/logging/pull/230 for details'
           end
         end
+
+        private_class_method def self.logging_inherit_context_enabled?
+          # The logging gem provides a mechanism to disable the conflicting behavior, see
+          # https://github.com/TwP/logging/blob/ae9872d093833b2a5a34cbe1faa4e895a81f6845/lib/logging/diagnostic_context.rb#L418
+          # Here we check if the behavior is enabled
+          inherit_context_configuration = ENV['LOGGING_INHERIT_CONTEXT']
+
+          inherit_context_configuration.nil? || !%w[false no 0].include?(inherit_context_configuration.downcase)
+        end
       end
     end
   end

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ffi'
 
 module Datadog
@@ -16,9 +17,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 +66,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 +92,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 +121,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

@@ -1,3 +1,4 @@
+# typed: false
 module Datadog
   module Profiling
     module Ext
@@ -24,13 +25,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

@@ -1,5 +1,6 @@
-require 'ddtrace/runtime/identity'
-require 'ddtrace/runtime/socket'
+# typed: false
+require 'datadog/core/environment/identity'
+require 'datadog/core/environment/socket'
 
 module Datadog
   module Profiling
@@ -18,20 +19,22 @@ module Datadog
       :runtime_engine,
       :runtime_platform,
       :runtime_version,
-      :profiler_version
+      :profiler_version,
+      :tags
     ) do
       def initialize(*args)
         super
-        self.runtime_id = runtime_id || Datadog::Runtime::Identity.id
+        self.runtime_id = runtime_id || Datadog::Core::Environment::Identity.id
         self.service = service || Datadog.configuration.service
         self.env = env || Datadog.configuration.env
         self.version = version || Datadog.configuration.version
-        self.host = host || Datadog::Runtime::Socket.hostname
-        self.language = language || Datadog::Runtime::Identity.lang
-        self.runtime_engine = runtime_engine || Datadog::Runtime::Identity.lang_engine
-        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.host = host || Datadog::Core::Environment::Socket.hostname
+        self.language = language || Datadog::Core::Environment::Identity.lang
+        self.runtime_engine = runtime_engine || Datadog::Core::Environment::Identity.lang_engine
+        self.runtime_platform = runtime_platform || Datadog::Core::Environment::Identity.lang_platform
+        self.runtime_version = runtime_version || Datadog::Core::Environment::Identity.lang_version
+        self.profiler_version = profiler_version || Datadog::Core::Environment::Identity.tracer_version
+        self.tags = tags || Datadog.configuration.tags
       end
     end
 

data/lib/ddtrace/profiling/native_extension.rb

@@ -0,0 +1,18 @@
+# typed: true
+module Datadog
+  module Profiling
+    # This module contains classes and methods which are implemented using native code in the
+    # ext/ddtrace_profiling_native_extension folder
+    module NativeExtension
+      private_class_method def self.working?
+        native_working?
+      end
+
+      unless singleton_class.private_method_defined?(:native_working?)
+        private_class_method def self.native_working?
+          false
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,6 @@
+# typed: true
+# frozen_string_literal: true
+
 require 'ddtrace/profiling/flush'
 require 'ddtrace/profiling/pprof/message_set'
 require 'ddtrace/profiling/pprof/string_table'
@@ -7,9 +10,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 +24,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 +52,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 +66,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

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/profiling'
 
 module Datadog
@@ -62,6 +63,10 @@ module Datadog
           Array.new(@sample_type_mappings.length, Datadog::Ext::Profiling::Pprof::SAMPLE_VALUE_NO_VALUE)
         end
 
+        def debug_statistics
+          # Empty; can be used by subclasses to report a string containing debug statistics to be logged
+        end
+
         # Represents a grouped event
         # 'sample' is an example event object from the group.
         # 'values' is the the summation of the group's sample values

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/utils/object_set'
 
 module Datadog
@@ -5,7 +6,9 @@ module Datadog
     module Pprof
       # Acts as a unique dictionary of protobuf messages
       class MessageSet < Utils::ObjectSet
-        alias_method :messages, :objects
+        def messages
+          objects
+        end
       end
     end
   end

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

@@ -1,10 +1,11 @@
+# typed: true
 module Datadog
   module Profiling
     module Pprof
       # Pprof output data.
       # Includes encoded data and list of types.
       Payload = Struct.new(:data, :types) do
-        def initialize(*args)
+        def initialize(data, types)
           super
           self.types = types || []
         end