ddtrace 1.4.2 → 1.19.0

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

@@ -1,43 +0,0 @@
-# typed: true
-
-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

@@ -1,15 +0,0 @@
-# typed: true
-
-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

@@ -1,82 +0,0 @@
-# typed: true
-
-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

data/lib/datadog/profiling/old_ext.rb

@@ -1,42 +0,0 @@
-# typed: true
-
-module Datadog
-  module Profiling
-    # NOTE: This OldExt file is temporary and expected to be removed once the migration to the new `HttpTransport` class
-    # is complete
-    module OldExt
-      module Transport
-        module HTTP
-          URI_TEMPLATE_DD_API = 'https://intake.profile.%s/'.freeze
-
-          FORM_FIELD_RECORDING_START = 'start'.freeze
-          FORM_FIELD_RECORDING_END = 'end'.freeze
-          FORM_FIELD_FAMILY = 'family'.freeze
-          FORM_FIELD_TAG_ENV = 'env'.freeze
-          FORM_FIELD_TAG_HOST = 'host'.freeze
-          FORM_FIELD_TAG_LANGUAGE = 'language'.freeze
-          FORM_FIELD_TAG_PID = 'process_id'.freeze
-          FORM_FIELD_TAG_PROFILER_VERSION = 'profiler_version'.freeze
-          FORM_FIELD_TAG_RUNTIME = 'runtime'.freeze
-          FORM_FIELD_TAG_RUNTIME_ENGINE = 'runtime_engine'.freeze
-          FORM_FIELD_TAG_RUNTIME_ID = 'runtime-id'.freeze
-          FORM_FIELD_TAG_RUNTIME_PLATFORM = 'runtime_platform'.freeze
-          FORM_FIELD_TAG_RUNTIME_VERSION = 'runtime_version'.freeze
-          FORM_FIELD_TAG_SERVICE = 'service'.freeze
-          FORM_FIELD_TAG_VERSION = 'version'.freeze
-          FORM_FIELD_TAGS = 'tags'.freeze
-          FORM_FIELD_INTAKE_VERSION = 'version'.freeze
-
-          HEADER_CONTENT_TYPE = 'Content-Type'.freeze
-          HEADER_CONTENT_TYPE_OCTET_STREAM = 'application/octet-stream'.freeze
-
-          FORM_FIELD_PPROF_DATA = 'data[rubyprofile.pprof]'.freeze
-          PPROF_DEFAULT_FILENAME = 'rubyprofile.pprof.gz'.freeze
-
-          FORM_FIELD_CODE_PROVENANCE_DATA = 'data[code-provenance.json]'.freeze
-          CODE_PROVENANCE_FILENAME = 'code-provenance.json.gz'.freeze
-        end
-      end
-    end
-  end
-end

data/lib/datadog/profiling/old_recorder.rb

@@ -1,101 +0,0 @@
-# typed: true
-
-require_relative 'buffer'
-require_relative 'encoding/profile'
-
-module Datadog
-  module Profiling
-    # Stores profiling events gathered by the `Stack` collector
-    class OldRecorder
-      attr_reader :max_size
-
-      def initialize(
-        event_classes,
-        max_size,
-        last_flush_time: Time.now.utc
-      )
-        @buffers = {}
-        @last_flush_time = last_flush_time
-        @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 serialize
-        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
-
-        return if event_count.zero? # We don't want to report empty profiles
-
-        encoded_pprof =
-          Datadog::Profiling::Encoding::Profile::Protobuf.encode(
-            event_count: event_count,
-            event_groups: event_groups,
-            start: start,
-            finish: finish,
-          )
-
-        [start, finish, encoded_pprof]
-      end
-
-      # Error when event of an unknown type is used with the OldRecorder
-      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/datadog/profiling/pprof/builder.rb

@@ -1,127 +0,0 @@
-# frozen_string_literal: true
-
-# typed: true
-
-require_relative '../flush'
-require_relative 'message_set'
-require_relative 'string_table'
-require_relative '../../core/utils/time'
-
-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 = Core::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(start:, finish:)
-          start_ns = Core::Utils::Time.as_utc_epoch_ns(start)
-          finish_ns = Core::Utils::Time.as_utc_epoch_ns(finish)
-
-          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,
-            time_nanos: start_ns,
-            duration_nanos: finish_ns - start_ns,
-          )
-        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/datadog/profiling/pprof/converter.rb

@@ -1,104 +0,0 @@
-# typed: true
-
-require_relative '../ext'
-
-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, Profiling::Ext::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/datadog/profiling/pprof/message_set.rb

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

data/lib/datadog/profiling/pprof/payload.rb

@@ -1,20 +0,0 @@
-# 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(data, types)
-          super
-          self.types = types || []
-        end
-
-        def to_s
-          data
-        end
-      end
-    end
-  end
-end