ddtrace 0.45.0 → 0.50.0

data/lib/ddtrace/profiling/preload.rb

@@ -0,0 +1,3 @@
+require 'ddtrace'
+
+Datadog.profiler.start if Datadog.profiler

data/lib/ddtrace/profiling/profiler.rb

@@ -0,0 +1,30 @@
+module Datadog
+  # Profiling entry point, which coordinates collectors and a scheduler
+  class Profiler
+    attr_reader \
+      :collectors,
+      :scheduler
+
+    def initialize(collectors, scheduler)
+      @collectors = collectors
+      @scheduler = scheduler
+    end
+
+    def start
+      collectors.each(&:start)
+      scheduler.start
+    end
+
+    def shutdown!
+      Datadog.logger.debug('Shutting down profiler')
+
+      collectors.each do |collector|
+        collector.enabled = false
+        collector.stop(true)
+      end
+
+      scheduler.enabled = false
+      scheduler.stop(true)
+    end
+  end
+end

data/lib/ddtrace/profiling/recorder.rb

@@ -0,0 +1,95 @@
+require 'ddtrace/profiling/buffer'
+require 'ddtrace/profiling/flush'
+
+module Datadog
+  module Profiling
+    # Stores profiling events gathered by `Collector`s
+    class Recorder
+      attr_reader :max_size
+
+      def initialize(event_classes, max_size)
+        @buffers = {}
+        @last_flush_time = Time.now.utc
+        @max_size = max_size
+
+        # Add a buffer for each class
+        event_classes.each do |event_class|
+          @buffers[event_class] = Profiling::Buffer.new(max_size)
+        end
+
+        # Event classes can only be added ahead of time
+        @buffers.freeze
+      end
+
+      def [](event_class)
+        @buffers[event_class]
+      end
+
+      def push(events)
+        if events.is_a?(Array)
+          # Push multiple events
+          event_class = events.first.class
+          raise UnknownEventError, event_class unless @buffers.key?(event_class)
+
+          @buffers[event_class].concat(events)
+        else
+          # Push single event
+          event_class = events.class
+          raise UnknownEventError, event_class unless @buffers.key?(event_class)
+
+          @buffers[event_class].push(events)
+        end
+      end
+
+      def flush
+        event_count = 0
+
+        event_groups, start, finish = update_time do
+          @buffers.collect do |event_class, buffer|
+            events = buffer.pop
+            next if events.empty?
+
+            event_count += events.length
+            EventGroup.new(event_class, events)
+          end.compact
+        end
+
+        Flush.new(
+          start,
+          finish,
+          event_groups,
+          event_count
+        )
+      end
+
+      # NOTE: Remember that if the recorder is being accessed by multiple threads, this is an inherently racy operation.
+      def empty?
+        @buffers.values.all?(&:empty?)
+      end
+
+      # Error when event of an unknown type is used with the Recorder
+      class UnknownEventError < StandardError
+        attr_reader :event_class
+
+        def initialize(event_class)
+          @event_class = event_class
+        end
+
+        def message
+          @message ||= "Unknown event class '#{event_class}' for profiling recorder."
+        end
+      end
+
+      private
+
+      def update_time
+        start = @last_flush_time
+        result = yield
+        @last_flush_time = Time.now.utc
+
+        # Return event groups, start time, finish time
+        [result, start, @last_flush_time]
+      end
+    end
+  end
+end

data/lib/ddtrace/profiling/scheduler.rb

@@ -0,0 +1,116 @@
+require 'ddtrace/utils/time'
+
+require 'ddtrace/worker'
+require 'ddtrace/workers/polling'
+
+module Datadog
+  module Profiling
+    # Periodically (every DEFAULT_INTERVAL_SECONDS) takes data from the `Recorder` and pushes them to all configured
+    # `Exporter`s. Runs on its own background thread.
+    class Scheduler < Worker
+      include Workers::Polling
+
+      DEFAULT_INTERVAL_SECONDS = 60
+      MIN_INTERVAL_SECONDS = 0
+
+      attr_reader \
+        :exporters,
+        :recorder
+
+      def initialize(
+        recorder,
+        exporters,
+        fork_policy: Workers::Async::Thread::FORK_POLICY_RESTART, # Restart in forks by default
+        interval: DEFAULT_INTERVAL_SECONDS,
+        enabled: true
+      )
+        @recorder = recorder
+        @exporters = [exporters].flatten
+
+        # Workers::Async::Thread settings
+        self.fork_policy = fork_policy
+
+        # Workers::IntervalLoop settings
+        self.loop_base_interval = interval
+
+        # Workers::Polling settings
+        self.enabled = enabled
+      end
+
+      def start
+        perform
+      end
+
+      def perform
+        # A profiling flush may be called while the VM is shutting down, to report the last profile. When we do so,
+        # we impose a strict timeout. This means this last profile may or may not be sent, depending on if the flush can
+        # successfully finish in the strict timeout.
+        # This can be somewhat confusing (why did it not get reported?), so let's at least log what happened.
+        interrupted = true
+
+        begin
+          flush_and_wait
+          interrupted = false
+        ensure
+          Datadog.logger.debug('#flush was interrupted or failed before it could complete') if interrupted
+        end
+      end
+
+      def loop_back_off?
+        false
+      end
+
+      def after_fork
+        # Clear recorder's buffers by flushing events.
+        # Objects from parent process will copy-on-write,
+        # and we don't want to send events for the wrong process.
+        recorder.flush
+      end
+
+      # Configure Workers::IntervalLoop to not report immediately when scheduler starts
+      #
+      # When a scheduler gets created (or reset), we don't want it to immediately try to flush; we want it to wait for
+      # the loop wait time first. This avoids an issue where the scheduler reported a mostly-empty profile if the
+      # application just started but this thread took a bit longer so there's already samples in the recorder.
+      def loop_wait_before_first_iteration?
+        true
+      end
+
+      def work_pending?
+        !recorder.empty?
+      end
+
+      private
+
+      def flush_and_wait
+        run_time = Datadog::Utils::Time.measure do
+          flush_events
+        end
+
+        # 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
+      end
+
+      def flush_events
+        # Get events from recorder
+        flush = recorder.flush
+
+        # Send events to each exporter
+        if flush.event_count > 0
+          exporters.each do |exporter|
+            begin
+              exporter.export(flush)
+            rescue StandardError => e
+              Datadog.logger.error(
+                "Unable to export #{flush.event_count} profiling events. Cause: #{e} Location: #{e.backtrace.first}"
+              )
+            end
+          end
+        end
+
+        flush
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+require 'ddtrace'
+require 'ddtrace/utils/only_once'
+require 'ddtrace/profiling'
+require 'ddtrace/profiling/ext/cpu'
+require 'ddtrace/profiling/ext/forking'
+
+module Datadog
+  module Profiling
+    module Tasks
+      # Takes care of loading our extensions/monkey patches to handle fork() and CPU profiling.
+      class Setup
+        ACTIVATE_EXTENSIONS_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+
+        def run
+          ACTIVATE_EXTENSIONS_ONLY_ONCE.run do
+            begin
+              activate_forking_extensions
+              activate_cpu_extensions
+              setup_at_fork_hooks
+            rescue StandardError, ScriptError => e
+              Datadog.logger.warn { "Profiler extensions unavailable. Cause: #{e.message} Location: #{e.backtrace.first}" }
+            end
+          end
+        end
+
+        private
+
+        def activate_forking_extensions
+          if Ext::Forking.supported?
+            Ext::Forking.apply!
+          elsif Datadog.configuration.profiling.enabled
+            Datadog.logger.debug('Profiler forking extensions skipped; forking not supported.')
+          end
+        rescue StandardError, ScriptError => e
+          Datadog.logger.warn do
+            "Profiler forking extensions unavailable. Cause: #{e.message} Location: #{e.backtrace.first}"
+          end
+        end
+
+        def activate_cpu_extensions
+          if Ext::CPU.supported?
+            Ext::CPU.apply!
+          elsif Datadog.configuration.profiling.enabled
+            Datadog.logger.info do
+              'CPU time profiling skipped because native CPU time is not supported: ' \
+              "#{Ext::CPU.unsupported_reason}. Profiles containing Wall time will still be reported."
+            end
+          end
+        rescue StandardError, ScriptError => e
+          Datadog.logger.warn do
+            "Profiler CPU profiling extensions unavailable. Cause: #{e.message} Location: #{e.backtrace.first}"
+          end
+        end
+
+        def setup_at_fork_hooks
+          if Process.respond_to?(:at_fork)
+            Process.at_fork(:child) do
+              begin
+                # When Ruby forks, clock IDs for each of the threads
+                # will change. We can only update these IDs from the
+                # execution context of the thread that owns it.
+                # This hook will update the IDs for the main thread
+                # after a fork occurs.
+                Thread.current.send(:update_native_ids) if Thread.current.respond_to?(:update_native_ids, true)
+
+                # 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}" }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/profiling/transport/client.rb

@@ -0,0 +1,12 @@
+module Datadog
+  module Profiling
+    module Transport
+      # Generic interface for profiling transports
+      module Client
+        def send_profiling_flush(flush)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/profiling/transport/http.rb

@@ -0,0 +1,118 @@
+require 'ddtrace/ext/runtime'
+require 'ddtrace/ext/transport'
+
+require 'ddtrace/runtime/container'
+
+require 'ddtrace/profiling/transport/http/builder'
+require 'ddtrace/profiling/transport/http/api'
+
+require 'ddtrace/transport/http/adapters/net'
+require 'ddtrace/transport/http/adapters/test'
+require 'ddtrace/transport/http/adapters/unix_socket'
+
+module Datadog
+  module Profiling
+    module Transport
+      # Namespace for HTTP transport components
+      module HTTP
+        module_function
+
+        # Builds a new Transport::HTTP::Client
+        def new(&block)
+          Builder.new(&block).to_transport
+        end
+
+        # Builds a new Transport::HTTP::Client with default settings
+        # Pass a block to override any settings.
+        def default(profiling_upload_timeout_seconds:, agent_settings: nil, site: nil, api_key: nil)
+          new do |transport|
+            transport.headers default_headers
+
+            # Configure adapter & API
+            if site && api_key
+              configure_for_agentless(
+                transport,
+                profiling_upload_timeout_seconds: profiling_upload_timeout_seconds,
+                site: site,
+                api_key: api_key
+              )
+            else
+              unless agent_settings
+                raise(
+                  ArgumentError,
+                  "Missing configuration for #{self}.default: All of `agent_settings`, `site` and `api_key` are nil"
+                )
+              end
+
+              configure_for_agent(
+                transport,
+                profiling_upload_timeout_seconds: profiling_upload_timeout_seconds,
+                agent_settings: agent_settings
+              )
+            end
+          end
+        end
+
+        def default_headers
+          {
+            Datadog::Ext::Transport::HTTP::HEADER_META_LANG => Datadog::Ext::Runtime::LANG,
+            Datadog::Ext::Transport::HTTP::HEADER_META_LANG_VERSION => Datadog::Ext::Runtime::LANG_VERSION,
+            Datadog::Ext::Transport::HTTP::HEADER_META_LANG_INTERPRETER => Datadog::Ext::Runtime::LANG_INTERPRETER,
+            Datadog::Ext::Transport::HTTP::HEADER_META_TRACER_VERSION => Datadog::Ext::Runtime::TRACER_VERSION
+          }.tap do |headers|
+            # Add container ID, if present.
+            container_id = Datadog::Runtime::Container.container_id
+            headers[Datadog::Ext::Transport::HTTP::HEADER_CONTAINER_ID] = container_id unless container_id.nil?
+          end
+        end
+
+        private_class_method def default_adapter
+          :net_http
+        end
+
+        private_class_method def configure_for_agent(transport, profiling_upload_timeout_seconds:, agent_settings:)
+          apis = API.agent_defaults
+
+          transport.adapter(
+            default_adapter,
+            agent_settings.hostname,
+            agent_settings.port,
+            # We explictly use profiling_upload_timeout_seconds instead of agent_settings.timeout because profile
+            # uploads are bigger and thus we employ a separate configuration.
+            timeout: profiling_upload_timeout_seconds,
+            ssl: agent_settings.ssl
+          )
+          transport.api(API::V1, apis[API::V1], default: true)
+
+          # NOTE: This proc, when it exists, usually overrides the transport specified above
+          if agent_settings.deprecated_for_removal_transport_configuration_proc
+            agent_settings.deprecated_for_removal_transport_configuration_proc.call(transport)
+          end
+        end
+
+        private_class_method def configure_for_agentless(transport, profiling_upload_timeout_seconds:, site:, api_key:)
+          apis = API.api_defaults
+
+          site_uri = URI(format(Datadog::Ext::Profiling::Transport::HTTP::URI_TEMPLATE_DD_API, site))
+          hostname = site_uri.host
+          port = site_uri.port
+
+          transport.adapter(
+            default_adapter,
+            hostname,
+            port,
+            timeout: profiling_upload_timeout_seconds,
+            ssl: site_uri.scheme == 'https'
+          )
+          transport.api(API::V1, apis[API::V1], default: true)
+          transport.headers(Datadog::Ext::Transport::HTTP::HEADER_DD_API_KEY => api_key)
+        end
+
+        # Add adapters to registry
+        Builder::REGISTRY.set(Datadog::Transport::HTTP::Adapters::Net, :net_http)
+        Builder::REGISTRY.set(Datadog::Transport::HTTP::Adapters::Test, :test)
+        Builder::REGISTRY.set(Datadog::Transport::HTTP::Adapters::UnixSocket, :unix)
+      end
+    end
+  end
+end