ddtrace 0.53.0 → 1.0.0.beta1

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

@@ -1,156 +0,0 @@
-# typed: false
-require 'ffi'
-
-module Datadog
-  module Profiling
-    module Ext
-      # C-struct for retrieving clock ID from pthread
-      class CClockId < FFI::Struct
-        layout :value, :int
-      end
-
-      # Enables interfacing with pthread via FFI
-      module NativePthread
-        extend FFI::Library
-        ffi_lib ['pthread', 'libpthread.so.0']
-        attach_function :pthread_self, [], :ulong
-        attach_function :pthread_getcpuclockid, [:ulong, CClockId], :int
-
-        # NOTE: Only returns thread ID for thread that evaluates this call.
-        #       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_pthread_thread_id(thread)
-          return unless ::Thread.current == thread
-
-          pthread_self
-        end
-
-        def self.get_clock_id(thread, pthread_id)
-          return unless ::Thread.current == thread && pthread_id
-
-          clock = CClockId.new
-          clock[:value] = 0
-          pthread_getcpuclockid(pthread_id, clock).zero? ? clock[:value] : nil
-        end
-      end
-
-      # Extension used to enable CPU-time profiling via use of pthread's `getcpuclockid`.
-      module CThread
-        def self.prepended(base)
-          # Threads that have already been created, will not have resolved
-          # a thread/clock ID. This is because these IDs can only be resolved
-          # from within the thread's execution context, which we do not control.
-          #
-          # We can mitigate this for the current thread via #update_native_ids,
-          # since we are currently running within its execution context. We cannot
-          # do this for any other threads that may have been created already.
-          # (This is why it's important that CThread is applied before anything else runs.)
-          base.current.send(:update_native_ids) if base.current.is_a?(CThread)
-        end
-
-        # 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 and the regression tests added to this module's specs 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 variables. This subclass of thread only shows up when
-        # the `Process.detach` API gets used.
-        # In this module's specs you can find crash regression tests that include a way of reproducing it.
-        #
-        # The workaround is to use `defined?` to check first if the instance variable exists. This seems to be fine
-        # with Ruby.
-        # Note that this crash doesn't affect `@foo ||=` nor instance variable writes (after the first write ever of any
-        # instance variable on a `Process::Waiter`, then further reads and writes to that or any other instance are OK;
-        # 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 :pthread_thread_id
-        else
-          def pthread_thread_id
-            defined?(@pthread_thread_id) && @pthread_thread_id
-          end
-        end
-
-        def initialize(*args)
-          @pid = ::Process.pid
-          @pthread_thread_id = nil
-          @clock_id = nil
-
-          # Wrap the work block with our own
-          # so we can retrieve the native thread ID within the thread's context.
-          wrapped_block = proc do |*t_args|
-            # Set native thread ID & clock ID
-            update_native_ids
-            yield(*t_args)
-          end
-          wrapped_block.ruby2_keywords if wrapped_block.respond_to?(:ruby2_keywords, true)
-
-          super(*args, &wrapped_block)
-        end
-        ruby2_keywords :initialize if respond_to?(:ruby2_keywords, true)
-
-        def cpu_time(unit = :float_second)
-          ::Process.clock_gettime(clock_id, unit) if clock_id
-        end
-
-        def cpu_time_instrumentation_installed?
-          # If this thread was started before this module was added to Thread OR if something caused the initialize
-          # method above not to be properly called on new threads, this instance variable is never defined (never set to
-          # any value at all, including nil).
-          #
-          # Thus, we can use @clock_id as a canary to detect a thread that has missing instrumentation, because we
-          # know that in initialize above we always set this variable to nil.
-          defined?(@clock_id) != nil
-        end
-
-        private
-
-        def clock_id
-          update_native_ids if forked?
-          defined?(@clock_id) && @clock_id
-        end
-
-        def forked?
-          ::Process.pid != (@pid ||= nil)
-        end
-
-        def update_native_ids
-          # Can only resolve if invoked from same thread
-          return unless ::Thread.current == self
-
-          @pid = ::Process.pid
-          @pthread_thread_id = NativePthread.get_pthread_thread_id(self)
-          @clock_id = NativePthread.get_clock_id(self, @pthread_thread_id)
-        end
-      end
-
-      # Threads in Ruby can be started by creating a new instance of `Thread` (or a subclass) OR by calling
-      # `start`/`fork` on `Thread` (or a subclass).
-      #
-      # This module intercepts calls to `start`/`fork`, ensuring that the `update_native_ids` operation is correctly
-      # called once the new thread starts.
-      #
-      # Note that unlike CThread above, this module should be prepended to the `Thread`'s singleton class, not to
-      # the class.
-      module WrapThreadStartFork
-        def start(*args)
-          # Wrap the work block with our own
-          # so we can retrieve the native thread ID within the thread's context.
-          wrapped_block = proc do |*t_args|
-            # Set native thread ID & clock ID
-            ::Thread.current.send(:update_native_ids)
-            yield(*t_args)
-          end
-          wrapped_block.ruby2_keywords if wrapped_block.respond_to?(:ruby2_keywords, true)
-
-          super(*args, &wrapped_block)
-        end
-        ruby2_keywords :start if respond_to?(:ruby2_keywords, true)
-
-        alias fork start
-      end
-    end
-  end
-end

data/lib/ddtrace/profiling/flush.rb

@@ -1,44 +0,0 @@
-# typed: false
-require 'datadog/core/environment/identity'
-require 'datadog/core/environment/socket'
-
-module Datadog
-  module Profiling
-    # Entity class used to represent metadata for a given profile
-    Flush = Struct.new(
-      :start,
-      :finish,
-      :event_groups,
-      :event_count,
-      :runtime_id,
-      :service,
-      :env,
-      :version,
-      :host,
-      :language,
-      :runtime_engine,
-      :runtime_platform,
-      :runtime_version,
-      :profiler_version,
-      :tags
-    ) do
-      def initialize(*args)
-        super
-        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::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
-
-    # Represents a collection of events of a specific type being flushed.
-    EventGroup = Struct.new(:event_class, :events).freeze
-  end
-end

data/lib/ddtrace/profiling/native_extension.rb

@@ -1,18 +0,0 @@
-# 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,120 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-require 'ddtrace/profiling/flush'
-require 'ddtrace/profiling/pprof/message_set'
-require 'ddtrace/profiling/pprof/string_table'
-
-module Datadog
-  module Profiling
-    module Pprof
-      # Accumulates profile data and produces a Perftools::Profiles::Profile
-      class Builder
-        DEFAULT_ENCODING = 'UTF-8'
-        DESC_FRAME_OMITTED = 'frame omitted'
-        DESC_FRAMES_OMITTED = 'frames omitted'
-
-        attr_reader \
-          :functions,
-          :locations,
-          :mappings,
-          :sample_types,
-          :samples,
-          :string_table
-
-        def initialize
-          @functions = 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)
-          Perftools::Profiles::Profile.encode(profile).force_encoding(DEFAULT_ENCODING)
-        end
-
-        def build_profile
-          Perftools::Profiles::Profile.new(
-            sample_type: @sample_types.messages,
-            sample: @samples,
-            mapping: @mappings.messages,
-            location: @locations.values,
-            function: @functions.messages,
-            string_table: @string_table.strings
-          )
-        end
-
-        def build_value_type(type, unit)
-          Perftools::Profiles::ValueType.new(
-            type: @string_table.fetch(type),
-            unit: @string_table.fetch(unit)
-          )
-        end
-
-        def build_locations(backtrace_locations, length)
-          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[Profiling::BacktraceLocation.new('', 0, "#{omitted} #{desc}")]
-          end
-
-          locations
-        end
-
-        def build_location(id, backtrace_location)
-          Perftools::Profiles::Location.new(
-            id: id,
-            line: [build_line(
-              @functions.fetch(
-                backtrace_location.path,
-                backtrace_location.base_label,
-                &@build_function
-              ).id,
-              backtrace_location.lineno
-            )]
-          )
-        end
-
-        def build_line(function_id, line_number)
-          Perftools::Profiles::Line.new(
-            function_id: function_id,
-            line: line_number
-          )
-        end
-
-        def build_function(id, filename, function_name)
-          Perftools::Profiles::Function.new(
-            id: id,
-            name: @string_table.fetch(function_name),
-            filename: @string_table.fetch(filename)
-          )
-        end
-
-        def build_mapping(id, filename)
-          Perftools::Profiles::Mapping.new(
-            id: id,
-            filename: @string_table.fetch(filename)
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,103 +0,0 @@
-# typed: true
-require 'ddtrace/ext/profiling'
-
-module Datadog
-  module Profiling
-    module Pprof
-      # Base class for converters that convert profiling events to pprof
-      class Converter
-        attr_reader \
-          :builder
-
-        # Override in child class to define sample types
-        # this converter uses when building samples.
-        def self.sample_value_types
-          raise NotImplementedError
-        end
-
-        def initialize(builder, sample_type_mappings)
-          @builder = builder
-          @sample_type_mappings = sample_type_mappings
-        end
-
-        def group_events(events)
-          # Event grouping in format:
-          # [key, EventGroup]
-          event_groups = {}
-
-          # Aggregate each event into a group
-          # with identical properties, but different values.
-          events.each do |event|
-            key = yield(event)
-            values = build_event_values(event)
-
-            unless key.nil?
-              if event_groups.key?(key)
-                # Update existing group from event
-                update_group(event_groups[key], event, values)
-              else
-                # Add new group
-                event_groups[key] = new_group(event, values)
-              end
-            end
-          end
-
-          event_groups
-        end
-
-        def add_events!(events)
-          raise NotImplementedError
-        end
-
-        def sample_value_index(type)
-          index = @sample_type_mappings[type]
-          raise UnknownSampleTypeMappingError, type unless index
-
-          index
-        end
-
-        def build_event_values(event)
-          # Build a value array that matches the length of the sample types
-          # Populate all values with "no value" by default
-          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 summation of the group's sample values
-        EventGroup = Struct.new(:sample, :values)
-
-        # Error when the mapping of a sample type to value index is unknown
-        class UnknownSampleTypeMappingError < StandardError
-          attr_reader :type
-
-          def initialize(type)
-            @type = type
-          end
-
-          def message
-            "Mapping for sample value type '#{type}' to index is unknown."
-          end
-        end
-
-        protected
-
-        def new_group(event, values)
-          EventGroup.new(event, values)
-        end
-
-        def update_group(event_group, event, values)
-          # Update values for group
-          group_values = event_group.values
-          group_values.each_with_index do |group_value, i|
-            group_values[i] = group_value + values[i]
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-# typed: true
-require 'ddtrace/utils/object_set'
-
-module Datadog
-  module Profiling
-    module Pprof
-      # Acts as a unique dictionary of protobuf messages
-      class MessageSet < Utils::ObjectSet
-        def messages
-          objects
-        end
-      end
-    end
-  end
-end

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

@@ -1,82 +0,0 @@
-# typed: false
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: lib/ddtrace/profiling/pprof/pprof.proto
-
-require 'google/protobuf'
-
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_message "perftools.profiles.Profile" do
-    repeated :sample_type, :message, 1, "perftools.profiles.ValueType"
-    repeated :sample, :message, 2, "perftools.profiles.Sample"
-    repeated :mapping, :message, 3, "perftools.profiles.Mapping"
-    repeated :location, :message, 4, "perftools.profiles.Location"
-    repeated :function, :message, 5, "perftools.profiles.Function"
-    repeated :string_table, :string, 6
-    optional :drop_frames, :int64, 7
-    optional :keep_frames, :int64, 8
-    optional :time_nanos, :int64, 9
-    optional :duration_nanos, :int64, 10
-    optional :period_type, :message, 11, "perftools.profiles.ValueType"
-    optional :period, :int64, 12
-    repeated :comment, :int64, 13
-    optional :default_sample_type, :int64, 14
-  end
-  add_message "perftools.profiles.ValueType" do
-    optional :type, :int64, 1
-    optional :unit, :int64, 2
-  end
-  add_message "perftools.profiles.Sample" do
-    repeated :location_id, :uint64, 1
-    repeated :value, :int64, 2
-    repeated :label, :message, 3, "perftools.profiles.Label"
-  end
-  add_message "perftools.profiles.Label" do
-    optional :key, :int64, 1
-    optional :str, :int64, 2
-    optional :num, :int64, 3
-    optional :num_unit, :int64, 4
-  end
-  add_message "perftools.profiles.Mapping" do
-    optional :id, :uint64, 1
-    optional :memory_start, :uint64, 2
-    optional :memory_limit, :uint64, 3
-    optional :file_offset, :uint64, 4
-    optional :filename, :int64, 5
-    optional :build_id, :int64, 6
-    optional :has_functions, :bool, 7
-    optional :has_filenames, :bool, 8
-    optional :has_line_numbers, :bool, 9
-    optional :has_inline_frames, :bool, 10
-  end
-  add_message "perftools.profiles.Location" do
-    optional :id, :uint64, 1
-    optional :mapping_id, :uint64, 2
-    optional :address, :uint64, 3
-    repeated :line, :message, 4, "perftools.profiles.Line"
-    optional :is_folded, :bool, 5
-  end
-  add_message "perftools.profiles.Line" do
-    optional :function_id, :uint64, 1
-    optional :line, :int64, 2
-  end
-  add_message "perftools.profiles.Function" do
-    optional :id, :uint64, 1
-    optional :name, :int64, 2
-    optional :system_name, :int64, 3
-    optional :filename, :int64, 4
-    optional :start_line, :int64, 5
-  end
-end
-
-module Perftools
-  module Profiles
-    Profile = Google::Protobuf::DescriptorPool.generated_pool.lookup("perftools.profiles.Profile").msgclass
-    ValueType = Google::Protobuf::DescriptorPool.generated_pool.lookup("perftools.profiles.ValueType").msgclass
-    Sample = Google::Protobuf::DescriptorPool.generated_pool.lookup("perftools.profiles.Sample").msgclass
-    Label = Google::Protobuf::DescriptorPool.generated_pool.lookup("perftools.profiles.Label").msgclass
-    Mapping = Google::Protobuf::DescriptorPool.generated_pool.lookup("perftools.profiles.Mapping").msgclass
-    Location = Google::Protobuf::DescriptorPool.generated_pool.lookup("perftools.profiles.Location").msgclass
-    Line = Google::Protobuf::DescriptorPool.generated_pool.lookup("perftools.profiles.Line").msgclass
-    Function = Google::Protobuf::DescriptorPool.generated_pool.lookup("perftools.profiles.Function").msgclass
-  end
-end

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

@@ -1,143 +0,0 @@
-# typed: true
-require 'ddtrace/ext/profiling'
-require 'ddtrace/profiling/events/stack'
-require 'ddtrace/profiling/pprof/builder'
-require 'ddtrace/profiling/pprof/converter'
-
-module Datadog
-  module Profiling
-    module Pprof
-      # Builds a profile from a StackSample
-      #
-      # NOTE: This class may appear stateless but is in fact stateful; a new instance should be created for every
-      # encoded profile.
-      class StackSample < Converter
-        SAMPLE_TYPES = {
-          cpu_time_ns: [
-            Datadog::Ext::Profiling::Pprof::VALUE_TYPE_CPU,
-            Datadog::Ext::Profiling::Pprof::VALUE_UNIT_NANOSECONDS
-          ],
-          wall_time_ns: [
-            Datadog::Ext::Profiling::Pprof::VALUE_TYPE_WALL,
-            Datadog::Ext::Profiling::Pprof::VALUE_UNIT_NANOSECONDS
-          ]
-        }.freeze
-
-        def self.sample_value_types
-          SAMPLE_TYPES
-        end
-
-        def initialize(*_)
-          super
-
-          @most_recent_trace_samples = {}
-          @processed_unique_stacks = 0
-          @processed_with_trace_ids = 0
-        end
-
-        def add_events!(stack_samples)
-          new_samples = build_samples(stack_samples)
-          builder.samples.concat(new_samples)
-        end
-
-        def stack_sample_group_key(stack_sample)
-          # We want to make sure we have the most recent sample for any trace.
-          # (This is done here to save an iteration over all samples.)
-          update_most_recent_trace_sample(stack_sample)
-
-          stack_sample.hash
-        end
-
-        # Track the most recent sample for each trace
-        def update_most_recent_trace_sample(stack_sample)
-          return unless stack_sample.trace_id && stack_sample.trace_resource
-
-          # Update trace resource with most recent value
-          if (most_recent_trace_sample = @most_recent_trace_samples[stack_sample.trace_id])
-            if most_recent_trace_sample.timestamp < stack_sample.timestamp
-              @most_recent_trace_samples[stack_sample.trace_id] = stack_sample
-            end
-          else
-            # Add trace resource
-            @most_recent_trace_samples[stack_sample.trace_id] = stack_sample
-          end
-        end
-
-        def build_samples(stack_samples)
-          groups = group_events(stack_samples, &method(:stack_sample_group_key))
-          groups.collect do |_group_key, group|
-            @processed_unique_stacks += 1
-            build_sample(group.sample, group.values)
-          end
-        end
-
-        def build_sample(stack_sample, values)
-          locations = builder.build_locations(
-            stack_sample.frames,
-            stack_sample.total_frame_count
-          )
-
-          Perftools::Profiles::Sample.new(
-            location_id: locations.collect { |location| location['id'.freeze] },
-            value: values,
-            label: build_sample_labels(stack_sample)
-          )
-        end
-
-        def build_event_values(stack_sample)
-          no_value = Datadog::Ext::Profiling::Pprof::SAMPLE_VALUE_NO_VALUE
-          values = super(stack_sample)
-          values[sample_value_index(:cpu_time_ns)] = stack_sample.cpu_time_interval_ns || no_value
-          values[sample_value_index(:wall_time_ns)] = stack_sample.wall_time_interval_ns || no_value
-          values
-        end
-
-        def build_sample_labels(stack_sample)
-          labels = [
-            Perftools::Profiles::Label.new(
-              key: builder.string_table.fetch(Datadog::Ext::Profiling::Pprof::LABEL_KEY_THREAD_ID),
-              str: builder.string_table.fetch(stack_sample.thread_id.to_s)
-            )
-          ]
-
-          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(trace_id.to_s)
-            )
-
-            labels << Perftools::Profiles::Label.new(
-              key: builder.string_table.fetch(Datadog::Ext::Profiling::Pprof::LABEL_KEY_SPAN_ID),
-              str: builder.string_table.fetch(span_id.to_s)
-            )
-
-            # Use most up-to-date trace resource, if available.
-            # Otherwise, use the trace resource provided.
-            trace_resource = (
-              @most_recent_trace_samples[stack_sample.trace_id] \
-              || stack_sample
-            ).trace_resource
-
-            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
-        end
-
-        def debug_statistics
-          "unique stacks: #{@processed_unique_stacks}, of which had active traces: #{@processed_with_trace_ids}"
-        end
-      end
-    end
-  end
-end

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

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