ddtrace 0.54.2 → 1.10.1

data/lib/datadog/profiling/collectors/old_stack.rb

@@ -0,0 +1,301 @@
+require_relative '../../core/utils/only_once'
+require_relative '../../core/utils/time'
+require_relative '../../core/worker'
+require_relative '../../core/workers/polling'
+require_relative '../backtrace_location'
+require_relative '../events/stack'
+require_relative '../native_extension'
+
+module Datadog
+  module Profiling
+    module Collectors
+      # Collects stack trace samples from Ruby threads for both CPU-time (if available) and wall-clock.
+      # Runs on its own background thread.
+      #
+      # This class has the prefix "Old" because it will be deprecated by the new native CPU Profiler
+      class OldStack < Core::Worker
+        include Core::Workers::Polling
+
+        DEFAULT_MAX_TIME_USAGE_PCT = 2.0
+        MIN_INTERVAL = 0.01
+        THREAD_LAST_CPU_TIME_KEY = :datadog_profiler_last_cpu_time
+        THREAD_LAST_WALL_CLOCK_KEY = :datadog_profiler_last_wall_clock
+        SYNTHETIC_STACK_IN_NATIVE_CODE = [BacktraceLocation.new('', 0, 'In native code').freeze].freeze
+
+        # This default was picked based on the current sampling performance and on expected concurrency on an average
+        # Ruby MRI application. Lowering this optimizes for latency (less impact each time we sample), and raising
+        # optimizes for coverage (less chance to miss what a given thread is doing).
+        DEFAULT_MAX_THREADS_SAMPLED = 16
+
+        attr_reader \
+          :recorder,
+          :max_frames,
+          :trace_identifiers_helper,
+          :ignore_thread,
+          :max_time_usage_pct,
+          :thread_api,
+          :cpu_time_provider
+
+        def initialize(
+          recorder,
+          max_frames:,
+          trace_identifiers_helper:, # Usually an instance of Profiling::TraceIdentifiers::Helper
+          ignore_thread: nil,
+          max_time_usage_pct: DEFAULT_MAX_TIME_USAGE_PCT,
+          max_threads_sampled: DEFAULT_MAX_THREADS_SAMPLED,
+          thread_api: Thread,
+          cpu_time_provider: Profiling::NativeExtension,
+          fork_policy: Core::Workers::Async::Thread::FORK_POLICY_RESTART, # Restart in forks by default
+          interval: MIN_INTERVAL,
+          enabled: true
+        )
+          @recorder = recorder
+          @max_frames = max_frames
+          @trace_identifiers_helper = trace_identifiers_helper
+          @ignore_thread = ignore_thread
+          @max_time_usage_pct = max_time_usage_pct
+          @max_threads_sampled = max_threads_sampled
+          @thread_api = thread_api
+          # Only set the provider if it's able to work in the current Ruby/OS combo
+          @cpu_time_provider = cpu_time_provider unless cpu_time_provider.cpu_time_ns_for(thread_api.current).nil?
+
+          # Workers::Async::Thread settings
+          self.fork_policy = fork_policy
+
+          # Workers::IntervalLoop settings
+          self.loop_base_interval = interval
+
+          # Workers::Polling settings
+          self.enabled = enabled
+
+          # Cache this proc, since it's pretty expensive to keep recreating it
+          @build_backtrace_location = method(:build_backtrace_location).to_proc
+          # Cache this buffer, since it's pretty expensive to keep accessing it
+          @stack_sample_event_recorder = recorder[Events::StackSample]
+          # See below for details on why this is needed
+          @needs_process_waiter_workaround = Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.7')
+        end
+
+        def start
+          reset_cpu_time_tracking
+          perform
+        end
+
+        def perform
+          collect_and_wait
+        end
+
+        def collect_and_wait
+          run_time = Core::Utils::Time.measure do
+            collect_events
+          end
+
+          # Update wait time to throttle profiling
+          self.loop_wait_time = compute_wait_time(run_time)
+        end
+
+        def collect_events
+          events = []
+          current_wall_time_ns = get_current_wall_time_timestamp_ns
+
+          # Collect backtraces from each thread
+          threads_to_sample.each do |thread|
+            next unless thread.alive?
+            next if ignore_thread.is_a?(Proc) && ignore_thread.call(thread)
+
+            event = collect_thread_event(thread, current_wall_time_ns)
+            events << event unless event.nil?
+          end
+
+          # Send events to recorder
+          recorder.push(events) unless events.empty?
+
+          events
+        end
+
+        def collect_thread_event(thread, current_wall_time_ns)
+          locations = thread.backtrace_locations
+          return if locations.nil?
+
+          # Having empty locations means that the thread is alive, but we don't know what it's doing:
+          #
+          # 1. It can be starting up
+          #    ```
+          #    > Thread.new { sleep }.backtrace
+          #    => [] # <-- note the thread hasn't actually started running sleep yet, we got there first
+          #    ```
+          # 2. It can be running native code
+          #    ```
+          #    > t = Process.detach(fork { sleep })
+          #    => #<Process::Waiter:0x00007ffe7285f7a0 run>
+          #    > t.backtrace
+          #    => [] # <-- this can happen even minutes later, e.g. it's not a race as in 1.
+          #    ```
+          #    This effect has been observed in threads created by the Iodine web server and the ffi gem
+          #
+          # To give customers visibility into these threads, we replace the empty stack with one containing a
+          # synthetic placeholder frame, so that these threads are properly represented in the UX.
+          locations = SYNTHETIC_STACK_IN_NATIVE_CODE if locations.empty?
+
+          # Get actual stack size then trim the stack
+          stack_size = locations.length
+          locations = locations[0..(max_frames - 1)]
+
+          # Convert backtrace locations into structs
+          locations = convert_backtrace_locations(locations)
+
+          thread_id = thread.object_id
+          root_span_id, span_id, trace_resource = trace_identifiers_helper.trace_identifiers_for(thread)
+          cpu_time = get_cpu_time_interval!(thread)
+          wall_time_interval_ns =
+            get_elapsed_since_last_sample_and_set_value(thread, THREAD_LAST_WALL_CLOCK_KEY, current_wall_time_ns)
+
+          Events::StackSample.new(
+            nil,
+            locations,
+            stack_size,
+            thread_id,
+            root_span_id,
+            span_id,
+            trace_resource,
+            cpu_time,
+            wall_time_interval_ns
+          )
+        end
+
+        def get_cpu_time_interval!(thread)
+          return unless cpu_time_provider
+
+          current_cpu_time_ns = cpu_time_provider.cpu_time_ns_for(thread)
+
+          return unless current_cpu_time_ns
+
+          get_elapsed_since_last_sample_and_set_value(thread, THREAD_LAST_CPU_TIME_KEY, current_cpu_time_ns)
+        end
+
+        def compute_wait_time(used_time)
+          # We took used_time to get the last sample.
+          #
+          # What we're computing here is -- if used_time corresponds to max_time_usage_pct of the time we should
+          # spend working, how much is (100% - max_time_usage_pct) of the time?
+          #
+          # For instance, if we took 10ms to sample, and max_time_usage_pct is 1%, then the other 99% is 990ms, which
+          # means we need to sleep for 990ms to guarantee that we don't spend more than 1% of the time working.
+          used_time_ns = used_time * 1e9
+          interval = (used_time_ns / (max_time_usage_pct / 100.0)) - used_time_ns
+          [interval / 1e9, MIN_INTERVAL].max
+        end
+
+        # Convert backtrace locations into structs
+        # Re-use old backtrace location objects if they already exist in the buffer
+        def convert_backtrace_locations(locations)
+          locations.collect do |location|
+            # Re-use existing BacktraceLocation if identical copy, otherwise build a new one.
+            @stack_sample_event_recorder.cache(:backtrace_locations).fetch(
+              # Function name
+              location.base_label,
+              # Line number
+              location.lineno,
+              # Filename
+              location.path,
+              # Build function
+              &@build_backtrace_location
+            )
+          end
+        end
+
+        def build_backtrace_location(_id, base_label, lineno, path)
+          string_table = @stack_sample_event_recorder.string_table
+
+          Profiling::BacktraceLocation.new(
+            string_table.fetch_string(base_label),
+            lineno,
+            string_table.fetch_string(path)
+          )
+        end
+
+        def reset_after_fork
+          recorder.reset_after_fork
+
+          # NOTE: We could perhaps also call #reset_cpu_time_tracking here, although it's not needed because we always
+          # call in in #start.
+        end
+
+        private
+
+        # If the profiler is started for a while, stopped and then restarted OR whenever the process forks, we need to
+        # clean up any leftover per-thread counters, so that the first sample after starting doesn't end up with:
+        #
+        # a) negative time: At least on my test docker container, and on the reliability environment, after the process
+        #    forks, the cpu time reference changes and (old cpu time - new cpu time) can be < 0
+        #
+        # b) large amount of time: if the profiler was started, then stopped for some amount of time, and then
+        #    restarted, we don't want the first sample to be "blamed" for multiple minutes of CPU time
+        #
+        # By resetting the last cpu time seen, we start with a clean slate every time we start the stack collector.
+        def reset_cpu_time_tracking
+          thread_api.list.each do |thread|
+            # See below for details on why this is needed
+            next if @needs_process_waiter_workaround && thread.is_a?(::Process::Waiter)
+
+            thread.thread_variable_set(THREAD_LAST_CPU_TIME_KEY, nil)
+            thread.thread_variable_set(THREAD_LAST_WALL_CLOCK_KEY, nil)
+          end
+        end
+
+        def get_elapsed_since_last_sample_and_set_value(thread, key, current_value)
+          # Process::Waiter crash workaround:
+          #
+          # This is a workaround for a Ruby VM segfault (usually something like
+          # "[BUG] Segmentation fault at 0x0000000000000008") in the affected Ruby versions.
+          # See https://bugs.ruby-lang.org/issues/17807 for details.
+          #
+          # In those Ruby versions, there's a very special subclass of `Thread` called `Process::Waiter` that causes VM
+          # crashes whenever something tries to read its instance or thread variables. This subclass of thread only
+          # shows up when the `Process.detach` API gets used.
+          # In the specs you'll find crash regression tests that include a way of reproducing it.
+          #
+          # As workaround for now we just skip it for the affected Rubies
+          return 0 if @needs_process_waiter_workaround && thread.is_a?(::Process::Waiter)
+
+          last_value = thread.thread_variable_get(key) || current_value
+          thread.thread_variable_set(key, current_value)
+
+          current_value - last_value
+        end
+
+        # Whenever there are more than max_threads_sampled active, we only sample a subset of them.
+        # We do this to avoid impacting the latency of the service being profiled. We want to avoid doing
+        # a big burst of work all at once (sample everything), and instead do a little work each time
+        # (sample a bit by bit).
+        #
+        # Because we pick the threads to sample randomly, we'll eventually sample all threads -- just not at once.
+        # Notice also that this will interact with our dynamic sampling mechanism -- if samples are faster, we take
+        # them more often, if they are slower, we take them less often -- which again means that over a longer period
+        # we should take sample roughly the same samples.
+        #
+        # One downside of this approach is that if there really are many threads, the resulting wall clock times
+        # in a one minute profile may "drift" around the 60 second mark, e.g. maybe we only sampled a thread once per
+        # second and only 59 times, so we'll report 59s, but on the next report we'll include the missing one, so
+        # then the result will be 61s. I've observed 60 +- 1.68 secs for an app with ~65 threads, given the
+        # default maximum of 16 threads. This seems a reasonable enough margin of error given the improvement to
+        # latency (especially on such a large application! -> even bigger latency impact if we tried to sample all
+        # threads).
+        #
+        def threads_to_sample
+          all_threads = thread_api.list
+
+          if all_threads.size > @max_threads_sampled
+            all_threads.sample(@max_threads_sampled)
+          else
+            all_threads
+          end
+        end
+
+        def get_current_wall_time_timestamp_ns
+          Core::Utils::Time.get_time(:nanosecond)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Datadog
+  module Profiling
+    module Collectors
+      # Used to gather a stack trace from a given Ruby thread. Stores its output on a `StackRecorder`.
+      #
+      # This class is not empty; all of this class is implemented as native code.
+      class Stack # rubocop:disable Lint/EmptyClass
+      end
+    end
+  end
+end

data/lib/datadog/profiling/collectors/thread_context.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Profiling
+    module Collectors
+      # Used to trigger sampling of threads, based on external "events", such as:
+      # * periodic timer for cpu-time and wall-time
+      # * VM garbage collection events
+      # * VM object allocation events
+      # Triggering of this component (e.g. watching for the above "events") is implemented by
+      # Collectors::CpuAndWallTimeWorker.
+      # The stack collection itself is handled using the Datadog::Profiling::Collectors::Stack.
+      # Almost all of this class is implemented as native code.
+      #
+      # Methods prefixed with _native_ are implemented in `collectors_thread_context.c`
+      class ThreadContext
+        def initialize(recorder:, max_frames:, tracer:)
+          tracer_context_key = safely_extract_context_key_from(tracer)
+          self.class._native_initialize(self, recorder, max_frames, tracer_context_key)
+        end
+
+        def inspect
+          # Compose Ruby's default inspect with our custom inspect for the native parts
+          result = super()
+          result[-1] = "#{self.class._native_inspect(self)}>"
+          result
+        end
+
+        def reset_after_fork
+          self.class._native_reset_after_fork(self)
+        end
+
+        private
+
+        def safely_extract_context_key_from(tracer)
+          provider = tracer && tracer.respond_to?(:provider) && tracer.provider
+
+          return unless provider
+
+          context = provider.instance_variable_get(:@context)
+          context && context.instance_variable_get(:@key)
+        end
+      end
+    end
+  end
+end

data/lib/datadog/profiling/component.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Profiling
+    # Profiling component
+    module Component
+      def build_profiler(settings, agent_settings, tracer)
+        return unless settings.profiling.enabled
+
+        # Workaround for weird dependency direction: the Core::Configuration::Components class currently has a
+        # dependency on individual products, in this case the Profiler.
+        # (Note "currently": in the future we want to change this so core classes don't depend on specific products)
+        #
+        # If the current file included a `require 'datadog/profiler'` at its beginning, we would generate circular
+        # requires when used from profiling:
+        #
+        # datadog/profiling
+        #     └─requires─> datadog/core
+        #                      └─requires─> datadog/core/configuration/components
+        #                                       └─requires─> datadog/profiling       # Loop!
+        #
+        # ...thus in #1998 we removed such a require.
+        #
+        # On the other hand, if datadog/core is loaded by a different product and no general `require 'ddtrace'` is
+        # done, then profiling may not be loaded, and thus to avoid this issue we do a require here (which is a
+        # no-op if profiling is already loaded).
+        require_relative '../profiling'
+        return unless Profiling.supported?
+
+        unless defined?(Profiling::Tasks::Setup)
+          # In #1545 a user reported a NameError due to this constant being uninitialized
+          # I've documented my suspicion on why that happened in
+          # https://github.com/DataDog/dd-trace-rb/issues/1545#issuecomment-856049025
+          #
+          # > Thanks for the info! It seems to feed into my theory: there's two moments in the code where we check if
+          # > profiler is "supported": 1) when loading ddtrace (inside preload) and 2) when starting the profile
+          # > after Datadog.configure gets run.
+          # > The problem is that the code assumes that both checks 1) and 2) will always reach the same conclusion:
+          # > either profiler is supported, or profiler is not supported.
+          # > In the problematic case, it looks like in your case check 1 decides that profiler is not
+          # > supported => doesn't load it, and then check 2 decides that it is => assumes it is loaded and tries to
+          # > start it.
+          #
+          # I was never able to validate if this was the issue or why exactly .supported? would change its mind BUT
+          # just in case it happens again, I've left this check which avoids breaking the user's application AND
+          # would instead direct them to report it to us instead, so that we can investigate what's wrong.
+          #
+          # TODO: As of June 2021, most checks in .supported? are related to the google-protobuf gem; so it's
+          # very likely that it was the origin of the issue we saw. Thus, if, as planned we end up moving away from
+          # protobuf OR enough time has passed and no users saw the issue again, we can remove this check altogether.
+          Datadog.logger.error(
+            'Profiling was marked as supported and enabled, but setup task was not loaded properly. ' \
+            'Please report this at https://github.com/DataDog/dd-trace-rb/blob/master/CONTRIBUTING.md#found-a-bug'
+          )
+
+          return
+        end
+
+        # Load extensions needed to support some of the Profiling features
+        Profiling::Tasks::Setup.new.run
+
+        # NOTE: Please update the Initialization section of ProfilingDevelopment.md with any changes to this method
+
+        if settings.profiling.advanced.force_enable_new_profiler
+          print_new_profiler_warnings
+
+          recorder = Datadog::Profiling::StackRecorder.new(
+            cpu_time_enabled: RUBY_PLATFORM.include?('linux'), # Only supported on Linux currently
+            alloc_samples_enabled: false, # Always disabled for now -- work in progress
+          )
+          collector = Datadog::Profiling::Collectors::CpuAndWallTimeWorker.new(
+            recorder: recorder,
+            max_frames: settings.profiling.advanced.max_frames,
+            tracer: tracer,
+            gc_profiling_enabled: should_enable_gc_profiling?(settings),
+            allocation_counting_enabled: settings.profiling.advanced.allocation_counting_enabled,
+          )
+        else
+          trace_identifiers_helper = Profiling::TraceIdentifiers::Helper.new(
+            tracer: tracer,
+            endpoint_collection_enabled: settings.profiling.advanced.endpoint.collection.enabled
+          )
+
+          recorder = build_profiler_old_recorder(settings)
+          collector = build_profiler_oldstack_collector(settings, recorder, trace_identifiers_helper)
+        end
+
+        exporter = build_profiler_exporter(settings, recorder)
+        transport = build_profiler_transport(settings, agent_settings)
+        scheduler = Profiling::Scheduler.new(exporter: exporter, transport: transport)
+
+        Profiling::Profiler.new([collector], scheduler)
+      end
+
+      private
+
+      def build_profiler_old_recorder(settings)
+        Profiling::OldRecorder.new([Profiling::Events::StackSample], settings.profiling.advanced.max_events)
+      end
+
+      def build_profiler_exporter(settings, recorder)
+        code_provenance_collector =
+          (Profiling::Collectors::CodeProvenance.new if settings.profiling.advanced.code_provenance_enabled)
+
+        Profiling::Exporter.new(pprof_recorder: recorder, code_provenance_collector: code_provenance_collector)
+      end
+
+      def build_profiler_oldstack_collector(settings, old_recorder, trace_identifiers_helper)
+        Profiling::Collectors::OldStack.new(
+          old_recorder,
+          trace_identifiers_helper: trace_identifiers_helper,
+          max_frames: settings.profiling.advanced.max_frames
+        )
+      end
+
+      def build_profiler_transport(settings, agent_settings)
+        settings.profiling.exporter.transport ||
+          Profiling::HttpTransport.new(
+            agent_settings: agent_settings,
+            site: settings.site,
+            api_key: settings.api_key,
+            upload_timeout_seconds: settings.profiling.upload.timeout_seconds,
+          )
+      end
+
+      def should_enable_gc_profiling?(settings)
+        # See comments on the setting definition for more context on why it exists.
+        if settings.profiling.advanced.force_enable_gc_profiling
+          if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3')
+            Datadog.logger.debug(
+              'Profiling time/resources spent in Garbage Collection force enabled. Do not use Ractors in combination ' \
+              'with this option as profiles will be incomplete.'
+            )
+          end
+
+          true
+        else
+          false
+        end
+      end
+
+      def print_new_profiler_warnings
+        if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6')
+          Datadog.logger.warn(
+            'New Ruby profiler has been force-enabled. This is a beta feature. Please report any issues ' \
+            'you run into to Datadog support or via <https://github.com/datadog/dd-trace-rb/issues/new>!'
+          )
+        else
+          # For more details on the issue, see the "BIG Issue" comment on `gvl_owner` function in
+          # `private_vm_api_access.c`.
+          Datadog.logger.warn(
+            'New Ruby profiler has been force-enabled on a legacy Ruby version (< 2.6). This is not recommended in ' \
+            'production environments, as due to limitations in Ruby APIs, we suspect it may lead to crashes in very ' \
+            'rare situations. Please report any issues you run into to Datadog support or ' \
+            'via <https://github.com/datadog/dd-trace-rb/issues/new>!'
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+require 'time'
+
+require_relative '../pprof/template'
+
+module Datadog
+  module Profiling
+    module Encoding
+      module Profile
+        # Encodes gathered data into the pprof format
+        module Protobuf
+          module_function
+
+          def encode(event_count:, event_groups:, start:, finish:)
+            # Create a pprof template from the list of event types
+            event_classes = event_groups.collect(&:event_class).uniq
+            template = Pprof::Template.for_event_classes(event_classes)
+
+            # Add all events to the pprof
+            event_groups.each { |event_group| template.add_events!(event_group.event_class, event_group.events) }
+
+            Datadog.logger.debug do
+              max_events = Datadog.configuration.profiling.advanced.max_events
+              events_sampled =
+                if event_count == max_events
+                  'max events limit hit, events were sampled [profile will be biased], '
+                else
+                  ''
+                end
+
+              "Encoding profile covering #{start.iso8601} to #{finish.iso8601}, " \
+              "events: #{event_count} (#{events_sampled}#{template.debug_statistics})"
+            end
+
+            # Build the profile and encode it
+            template.to_pprof(start: start, finish: finish)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/profiling/event.rb

@@ -0,0 +1,13 @@
+module Datadog
+  module Profiling
+    # Describes a sample of some data obtained from the runtime.
+    class Event
+      attr_reader \
+        :timestamp
+
+      def initialize(timestamp = nil)
+        @timestamp = timestamp || Time.now.utc.to_f
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+require_relative '../event'
+
+module Datadog
+  module Profiling
+    module Events
+      # Describes a stack profiling event
+      class Stack < Event
+        attr_reader \
+          :hash,
+          :frames,
+          :total_frame_count,
+          :thread_id,
+          :root_span_id,
+          :span_id,
+          :trace_resource
+
+        def initialize(
+          timestamp,
+          frames,
+          total_frame_count,
+          thread_id,
+          root_span_id,
+          span_id,
+          trace_resource
+        )
+          super(timestamp)
+
+          @frames = frames
+          @total_frame_count = total_frame_count
+          @thread_id = thread_id
+          @root_span_id = root_span_id
+          @span_id = span_id
+          @trace_resource = trace_resource
+
+          @hash = [
+            thread_id,
+            root_span_id,
+            span_id,
+            # trace_resource is deliberately not included -- events that share the same (root_span_id, span_id) refer
+            # to the same trace
+            frames.collect(&:hash),
+            total_frame_count
+          ].hash
+        end
+      end
+
+      # Describes a stack sample
+      class StackSample < Stack
+        attr_reader \
+          :cpu_time_interval_ns,
+          :wall_time_interval_ns
+
+        def initialize(
+          timestamp,
+          frames,
+          total_frame_count,
+          thread_id,
+          root_span_id,
+          span_id,
+          trace_resource,
+          cpu_time_interval_ns,
+          wall_time_interval_ns
+        )
+          super(
+            timestamp,
+            frames,
+            total_frame_count,
+            thread_id,
+            root_span_id,
+            span_id,
+            trace_resource
+          )
+
+          @cpu_time_interval_ns = cpu_time_interval_ns
+          @wall_time_interval_ns = wall_time_interval_ns
+        end
+      end
+    end
+  end
+end