ddtrace 0.51.1 → 0.52.0

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'set'
 require 'time'
 

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
@@ -58,8 +59,7 @@ module Datadog
           # Here we check if the behavior is enabled
           inherit_context_configuration = ENV['LOGGING_INHERIT_CONTEXT']
 
-          inherit_context_configuration.nil? ||
-          (inherit_context_configuration && !%w[false no 0].include?(inherit_context_configuration.downcase))
+          inherit_context_configuration.nil? || !%w[false no 0].include?(inherit_context_configuration.downcase)
         end
       end
     end

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ffi'
 
 module Datadog

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

@@ -1,3 +1,4 @@
+# typed: false
 module Datadog
   module Profiling
     module Ext

data/lib/ddtrace/profiling/flush.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'datadog/core/environment/identity'
 require 'datadog/core/environment/socket'
 

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,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'ddtrace/profiling/flush'

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

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

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

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

@@ -1,3 +1,4 @@
+# typed: false
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: lib/ddtrace/profiling/pprof/pprof.proto
 

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/profiling'
 require 'ddtrace/profiling/events/stack'
 require 'ddtrace/profiling/pprof/builder'
@@ -79,19 +80,29 @@ module Datadog
             )
           ]
 
-          unless stack_sample.trace_id.nil? || stack_sample.trace_id.zero?
+          trace_id = stack_sample.trace_id || 0
+          span_id = stack_sample.span_id || 0
+
+          if trace_id != 0 && span_id != 0
             @processed_with_trace_ids += 1
+
             labels << Perftools::Profiles::Label.new(
               key: builder.string_table.fetch(Datadog::Ext::Profiling::Pprof::LABEL_KEY_TRACE_ID),
-              str: builder.string_table.fetch(stack_sample.trace_id.to_s)
+              str: builder.string_table.fetch(trace_id.to_s)
             )
-          end
 
-          unless stack_sample.span_id.nil? || stack_sample.span_id.zero?
             labels << Perftools::Profiles::Label.new(
               key: builder.string_table.fetch(Datadog::Ext::Profiling::Pprof::LABEL_KEY_SPAN_ID),
-              str: builder.string_table.fetch(stack_sample.span_id.to_s)
+              str: builder.string_table.fetch(span_id.to_s)
             )
+
+            trace_resource = stack_sample.trace_resource_container && stack_sample.trace_resource_container.latest
+            if trace_resource && !trace_resource.empty?
+              labels << Perftools::Profiles::Label.new(
+                key: builder.string_table.fetch(Datadog::Ext::Profiling::Pprof::LABEL_KEY_TRACE_ENDPOINT),
+                str: builder.string_table.fetch(trace_resource)
+              )
+            end
           end
 
           labels

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

@@ -1,3 +1,4 @@
+# typed: strict
 require 'ddtrace/utils/string_table'
 
 module Datadog

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/profiling/pprof/payload'
 require 'ddtrace/profiling/pprof/message_set'
 require 'ddtrace/profiling/pprof/builder'

data/lib/ddtrace/profiling/preload.rb

@@ -1,3 +1,4 @@
+# typed: strict
 require 'ddtrace'
 
 Datadog.profiler.start if Datadog.profiler

data/lib/ddtrace/profiling/profiler.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   # Profiling entry point, which coordinates collectors and a scheduler
   class Profiler

data/lib/ddtrace/profiling/recorder.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/profiling/buffer'
 require 'ddtrace/profiling/flush'
 
@@ -7,9 +8,9 @@ module Datadog
     class Recorder
       attr_reader :max_size
 
-      def initialize(event_classes, max_size)
+      def initialize(event_classes, max_size, last_flush_time: Time.now.utc)
         @buffers = {}
-        @last_flush_time = Time.now.utc
+        @last_flush_time = last_flush_time
         @max_size = max_size
 
         # Add a buffer for each class

data/lib/ddtrace/profiling/scheduler.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/utils/time'
 
 require 'ddtrace/worker'
@@ -11,7 +12,12 @@ module Datadog
       include Workers::Polling
 
       DEFAULT_INTERVAL_SECONDS = 60
-      MIN_INTERVAL_SECONDS = 0
+      MINIMUM_INTERVAL_SECONDS = 0
+
+      # Profiles with duration less than this will not be reported
+      PROFILE_DURATION_THRESHOLD_SECONDS = 1
+
+      private_constant :DEFAULT_INTERVAL_SECONDS, :MINIMUM_INTERVAL_SECONDS, :PROFILE_DURATION_THRESHOLD_SECONDS
 
       attr_reader \
         :exporters,
@@ -89,13 +95,21 @@ module Datadog
 
         # Update wait time to try to wake consistently on time.
         # Don't drop below the minimum interval.
-        self.loop_wait_time = [loop_base_interval - run_time, MIN_INTERVAL_SECONDS].max
+        self.loop_wait_time = [loop_base_interval - run_time, MINIMUM_INTERVAL_SECONDS].max
       end
 
       def flush_events
         # Get events from recorder
         flush = recorder.flush
 
+        if duration_below_threshold?(flush)
+          Datadog.logger.debug do
+            "Skipped exporting profiling events as profile duration is below minimum (#{flush.event_count} events skipped)"
+          end
+
+          return flush
+        end
+
         # Send events to each exporter
         if flush.event_count > 0
           exporters.each do |exporter|
@@ -103,7 +117,7 @@ module Datadog
               exporter.export(flush)
             rescue StandardError => e
               Datadog.logger.error(
-                "Unable to export #{flush.event_count} profiling events. Cause: #{e} Location: #{e.backtrace.first}"
+                "Unable to export #{flush.event_count} profiling events. Cause: #{e} Location: #{Array(e.backtrace).first}"
               )
             end
           end
@@ -111,6 +125,10 @@ module Datadog
 
         flush
       end
+
+      def duration_below_threshold?(flush)
+        (flush.finish - flush.start) < PROFILE_DURATION_THRESHOLD_SECONDS
+      end
     end
   end
 end

data/lib/ddtrace/profiling/tasks/setup.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace'
 require 'ddtrace/utils/only_once'
 require 'ddtrace/profiling'
@@ -18,7 +19,9 @@ module Datadog
               activate_cpu_extensions
               setup_at_fork_hooks
             rescue StandardError, ScriptError => e
-              Datadog.logger.warn { "Profiler extensions unavailable. Cause: #{e.message} Location: #{e.backtrace.first}" }
+              Datadog.logger.warn do
+                "Profiler extensions unavailable. Cause: #{e.message} Location: #{Array(e.backtrace).first}"
+              end
             end
           end
         end
@@ -33,7 +36,7 @@ module Datadog
           end
         rescue StandardError, ScriptError => e
           Datadog.logger.warn do
-            "Profiler forking extensions unavailable. Cause: #{e.message} Location: #{e.backtrace.first}"
+            "Profiler forking extensions unavailable. Cause: #{e.message} Location: #{Array(e.backtrace).first}"
           end
         end
 
@@ -48,7 +51,7 @@ module Datadog
           end
         rescue StandardError, ScriptError => e
           Datadog.logger.warn do
-            "Profiler CPU profiling extensions unavailable. Cause: #{e.message} Location: #{e.backtrace.first}"
+            "Profiler CPU profiling extensions unavailable. Cause: #{e.message} Location: #{Array(e.backtrace).first}"
           end
         end
 
@@ -66,7 +69,9 @@ module Datadog
                 # Restart profiler, if enabled
                 Datadog.profiler.start if Datadog.profiler
               rescue StandardError => e
-                Datadog.logger.warn { "Error during post-fork hooks. Cause: #{e.message} Location: #{e.backtrace.first}" }
+                Datadog.logger.warn do
+                  "Error during post-fork hooks. Cause: #{e.message} Location: #{Array(e.backtrace).first}"
+                end
               end
             end
           end

data/lib/ddtrace/profiling/trace_identifiers/ddtrace.rb

@@ -0,0 +1,41 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'ddtrace/ext/http'
+
+module Datadog
+  module Profiling
+    module TraceIdentifiers
+      # Used by Datadog::Profiling::TraceIdentifiers::Helper to get the trace identifiers (trace id and span id) for a
+      # given thread, if there is an active trace for that thread in Datadog.tracer.
+      class Ddtrace
+        def initialize(tracer: nil)
+          @tracer = (tracer if tracer.respond_to?(:call_context))
+        end
+
+        def trace_identifiers_for(thread)
+          return unless @tracer
+
+          context = @tracer.call_context(thread)
+          return unless context
+
+          trace_id = context.trace_id || 0
+          span_id = context.span_id || 0
+
+          [trace_id, span_id, maybe_extract_resource(context.current_root_span)] if trace_id != 0 && span_id != 0
+        end
+
+        private
+
+        # NOTE: Currently we're only interested in HTTP service endpoints. Over time, this list may be expanded.
+        # Resources MUST NOT include personal identifiable information (PII); this should not be the case with
+        # ddtrace integrations, but worth mentioning just in case :)
+        def maybe_extract_resource(root_span)
+          return unless root_span
+
+          root_span.resource_container if root_span.span_type == Datadog::Ext::HTTP::TYPE_INBOUND
+        end
+      end
+    end
+  end
+end