ddtrace 0.44.0 → 0.48.0

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

@@ -0,0 +1,10 @@
+require 'ddtrace/utils/string_table'
+
+module Datadog
+  module Profiling
+    module Pprof
+      # Tracks strings and returns IDs
+      class StringTable < Utils::StringTable; end
+    end
+  end
+end

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

@@ -0,0 +1,114 @@
+require 'ddtrace/profiling/pprof/payload'
+require 'ddtrace/profiling/pprof/message_set'
+require 'ddtrace/profiling/pprof/builder'
+
+require 'ddtrace/profiling/events/stack'
+require 'ddtrace/profiling/pprof/stack_sample'
+
+module Datadog
+  module Profiling
+    module Pprof
+      # Converts a collection of profiling events into a Perftools::Profiles::Profile
+      class Template
+        DEFAULT_MAPPINGS = {
+          Events::StackSample => Pprof::StackSample
+        }.freeze
+
+        attr_reader \
+          :builder,
+          :converters,
+          :sample_type_mappings
+
+        def self.for_event_classes(event_classes)
+          # Build a map of event class --> converter class
+          mappings = event_classes.each_with_object({}) do |event_class, m|
+            converter_class = DEFAULT_MAPPINGS[event_class]
+            raise NoProfilingEventConversionError, event_class unless converter_class
+
+            m[event_class] = converter_class
+          end
+
+          new(mappings)
+        end
+
+        def initialize(mappings)
+          @builder = Builder.new
+          @converters = Hash.new { |_h, event_class| raise NoProfilingEventConversionError, event_class }
+          @sample_type_mappings = Hash.new { |_h, type| raise UnknownSampleTypeMappingError, type }
+
+          # Add default mapping
+          builder.mappings.fetch($PROGRAM_NAME, &builder.method(:build_mapping))
+
+          # Combine all sample types from each converter class
+          types = mappings.values.each_with_object({}) do |converter_class, t|
+            t.merge!(converter_class.sample_value_types)
+          end
+
+          # Build the sample types into sample type objects
+          types.each do |type_name, type_args|
+            index = nil
+
+            sample_type = builder.sample_types.fetch(*type_args) do |id, type, unit|
+              index = id
+              builder.build_value_type(type, unit)
+            end
+
+            # Create mapping between the type and index to which its assigned.
+            # Do this for faster lookup while building profile sample values.
+            sample_type_mappings[type_name] = index || builder.sample_types.messages.index(sample_type)
+          end
+
+          # Freeze them so they can't be modified.
+          # We don't want the number of sample types to vary between samples within the same profile.
+          builder.sample_types.freeze
+          sample_type_mappings.freeze
+
+          # Add converters
+          mappings.each do |event_class, converter_class|
+            converters[event_class] = converter_class.new(builder, sample_type_mappings)
+          end
+
+          converters.freeze
+        end
+
+        def add_events!(event_class, events)
+          converters[event_class].add_events!(events)
+        end
+
+        def to_pprof
+          profile = builder.build_profile
+          data = builder.encode_profile(profile)
+          types = sample_type_mappings.keys
+
+          Payload.new(data, types)
+        end
+
+        # Error when an unknown event type is given to be converted
+        class NoProfilingEventConversionError < ArgumentError
+          attr_reader :type
+
+          def initialize(type)
+            @type = type
+          end
+
+          def message
+            "Profiling event type '#{type}' cannot be converted to pprof."
+          end
+        end
+
+        # Error when the mapping of a sample type to value index is unknown
+        class UnknownSampleTypeMappingError < ArgumentError
+          attr_reader :type
+
+          def initialize(type)
+            @type = type
+          end
+
+          def message
+            "Mapping for sample value type '#{type}' is unknown."
+          end
+        end
+      end
+    end
+  end
+end

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,28 @@
+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!
+      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,87 @@
+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
+      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
+
+      # 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,84 @@
+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 = 60
+      MIN_INTERVAL = 0
+
+      attr_reader \
+        :exporters,
+        :recorder
+
+      def initialize(recorder, exporters, options = {})
+        @recorder = recorder
+        @exporters = [exporters].flatten
+
+        # Workers::Async::Thread settings
+        # Restart in forks by default
+        self.fork_policy = options[:fork_policy] || Workers::Async::Thread::FORK_POLICY_RESTART
+
+        # Workers::IntervalLoop settings
+        self.loop_base_interval = options[:interval] || DEFAULT_INTERVAL
+
+        # Workers::Polling settings
+        self.enabled = options.key?(:enabled) ? options[:enabled] == true : true
+      end
+
+      def start
+        perform
+      end
+
+      def perform
+        flush_and_wait
+      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
+
+      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].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
+              error_details = "Cause: #{e} Location: #{e.backtrace.first}"
+              Datadog.logger.error("Unable to export #{flush.event_count} profiling events. #{error_details}")
+            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
+              log "[DDTRACE] Main 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
+            # Log warning if profiling was supposed to be activated.
+            log '[DDTRACE] Forking extensions skipped; forking not supported.'
+          end
+        rescue StandardError, ScriptError => e
+          log "[DDTRACE] Forking extensions unavailable. Cause: #{e.message} Location: #{e.backtrace.first}"
+        end
+
+        def activate_cpu_extensions
+          if Ext::CPU.supported?
+            Ext::CPU.apply!
+          elsif Datadog.configuration.profiling.enabled
+            # Log warning if profiling was supposed to be activated.
+            log "[DDTRACE] CPU profiling skipped because native CPU time is not supported: #{Ext::CPU.unsupported_reason}."
+          end
+        rescue StandardError, ScriptError => e
+          log "[DDTRACE] CPU profiling unavailable. Cause: #{e.message} Location: #{e.backtrace.first}"
+        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
+                log "[DDTRACE] Error during post-fork hooks. Cause: #{e.message} Location: #{e.backtrace.first}"
+              end
+            end
+          end
+        end
+
+        def log(message)
+          # Print to STDOUT for now because logging may not be setup yet...
+          puts message
+        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,122 @@
+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
+      # TODO: Consolidate with Dataog::Transport::HTTP
+      # 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(options = {})
+          new do |transport|
+            transport.headers default_headers
+
+            # Configure adapter & API
+            if options[:site] && options[:api_key]
+              configure_for_agentless(transport, options)
+            else
+              configure_for_agent(transport, options)
+            end
+
+            # Additional options
+            unless options.empty?
+              # Change default API
+              transport.default_api = options[:api_version] if options.key?(:api_version)
+
+              # Add headers
+              transport.headers options[:headers] if options.key?(:headers)
+
+              # Execute on_build callback
+              options[:on_build].call(transport) if options[:on_build].is_a?(Proc)
+            end
+
+            # Call block to apply any customization, if provided.
+            yield(transport) if block_given?
+          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
+
+        def default_adapter
+          :net_http
+        end
+
+        def default_hostname
+          ENV.fetch(Datadog::Ext::Transport::HTTP::ENV_DEFAULT_HOST, Datadog::Ext::Transport::HTTP::DEFAULT_HOST)
+        end
+
+        def default_port
+          ENV.fetch(Datadog::Ext::Transport::HTTP::ENV_DEFAULT_PORT, Datadog::Ext::Transport::HTTP::DEFAULT_PORT).to_i
+        end
+
+        def configure_for_agent(transport, options = {})
+          apis = API.agent_defaults
+
+          hostname = options[:hostname] || default_hostname
+          port = options[:port] || default_port
+
+          adapter_options = {}
+          adapter_options[:timeout] = options[:timeout] if options.key?(:timeout)
+          adapter_options[:ssl] = options[:ssl] if options.key?(:ssl)
+
+          transport.adapter default_adapter, hostname, port, adapter_options
+          transport.api API::V1, apis[API::V1], default: true
+        end
+
+        def configure_for_agentless(transport, options = {})
+          apis = API.api_defaults
+
+          site_uri = URI(format(Datadog::Ext::Profiling::Transport::HTTP::URI_TEMPLATE_DD_API, options[:site]))
+          hostname = options[:hostname] || site_uri.host
+          port = options[:port] || site_uri.port
+
+          adapter_options = {}
+          adapter_options[:timeout] = options[:timeout] if options.key?(:timeout)
+          adapter_options[:ssl] = options[:ssl] || (site_uri.scheme == 'https'.freeze)
+
+          transport.adapter default_adapter, hostname, port, adapter_options
+          transport.api API::V1, apis[API::V1], default: true
+          transport.headers(Datadog::Ext::Transport::HTTP::HEADER_DD_API_KEY => options[: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)
+
+        private \
+          :configure_for_agent,
+          :configure_for_agentless
+      end
+    end
+  end
+end