ddtrace 1.4.2 → 1.19.0

data/lib/datadog/profiling/pprof/pprof.proto

@@ -1,212 +0,0 @@
-// Copyright 2016 Google Inc. All Rights Reserved.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-// Profile is a common stacktrace profile format.
-//
-// Measurements represented with this format should follow the
-// following conventions:
-//
-// - Consumers should treat unset optional fields as if they had been
-//   set with their default value.
-//
-// - When possible, measurements should be stored in "unsampled" form
-//   that is most useful to humans.  There should be enough
-//   information present to determine the original sampled values.
-//
-// - On-disk, the serialized proto must be gzip-compressed.
-//
-// - The profile is represented as a set of samples, where each sample
-//   references a sequence of locations, and where each location belongs
-//   to a mapping.
-// - There is a N->1 relationship from sample.location_id entries to
-//   locations. For every sample.location_id entry there must be a
-//   unique Location with that id.
-// - There is an optional N->1 relationship from locations to
-//   mappings. For every nonzero Location.mapping_id there must be a
-//   unique Mapping with that id.
-
-syntax = "proto3";
-
-package perftools.profiles;
-
-option java_package = "com.google.perftools.profiles";
-option java_outer_classname = "ProfileProto";
-
-message Profile {
-  // A description of the samples associated with each Sample.value.
-  // For a cpu profile this might be:
-  //   [["cpu","nanoseconds"]] or [["wall","seconds"]] or [["syscall","count"]]
-  // For a heap profile, this might be:
-  //   [["allocations","count"], ["space","bytes"]],
-  // If one of the values represents the number of events represented
-  // by the sample, by convention it should be at index 0 and use
-  // sample_type.unit == "count".
-  repeated ValueType sample_type = 1;
-  // The set of samples recorded in this profile.
-  repeated Sample sample = 2;
-  // Mapping from address ranges to the image/binary/library mapped
-  // into that address range.  mapping[0] will be the main binary.
-  repeated Mapping mapping = 3;
-  // Useful program location
-  repeated Location location = 4;
-  // Functions referenced by locations
-  repeated Function function = 5;
-  // A common table for strings referenced by various messages.
-  // string_table[0] must always be "".
-  repeated string string_table = 6;
-  // frames with Function.function_name fully matching the following
-  // regexp will be dropped from the samples, along with their successors.
-  int64 drop_frames = 7;   // Index into string table.
-  // frames with Function.function_name fully matching the following
-  // regexp will be kept, even if it matches drop_functions.
-  int64 keep_frames = 8;  // Index into string table.
-
-  // The following fields are informational, do not affect
-  // interpretation of results.
-
-  // Time of collection (UTC) represented as nanoseconds past the epoch.
-  int64 time_nanos = 9;
-  // Duration of the profile, if a duration makes sense.
-  int64 duration_nanos = 10;
-  // The kind of events between sampled ocurrences.
-  // e.g [ "cpu","cycles" ] or [ "heap","bytes" ]
-  ValueType period_type = 11;
-  // The number of events between sampled occurrences.
-  int64 period = 12;
-  // Freeform text associated to the profile.
-  repeated int64 comment = 13; // Indices into string table.
-  // Index into the string table of the type of the preferred sample
-  // value. If unset, clients should default to the last sample value.
-  int64 default_sample_type = 14;
-}
-
-// ValueType describes the semantics and measurement units of a value.
-message ValueType {
-  int64 type = 1; // Index into string table.
-  int64 unit = 2; // Index into string table.
-}
-
-// Each Sample records values encountered in some program
-// context. The program context is typically a stack trace, perhaps
-// augmented with auxiliary information like the thread-id, some
-// indicator of a higher level request being handled etc.
-message Sample {
-  // The ids recorded here correspond to a Profile.location.id.
-  // The leaf is at location_id[0].
-  repeated uint64 location_id = 1;
-  // The type and unit of each value is defined by the corresponding
-  // entry in Profile.sample_type. All samples must have the same
-  // number of values, the same as the length of Profile.sample_type.
-  // When aggregating multiple samples into a single sample, the
-  // result has a list of values that is the elemntwise sum of the
-  // lists of the originals.
-  repeated int64 value = 2;
-  // label includes additional context for this sample. It can include
-  // things like a thread id, allocation size, etc
-  repeated Label label = 3;
-}
-
-message Label {
-  int64 key = 1;   // Index into string table
-
-  // At most one of the following must be present
-  int64 str = 2;   // Index into string table
-  int64 num = 3;
-
-  // Should only be present when num is present.
-  // Specifies the units of num.
-  // Use arbitrary string (for example, "requests") as a custom count unit.
-  // If no unit is specified, consumer may apply heuristic to deduce the unit.
-  // Consumers may also  interpret units like "bytes" and "kilobytes" as memory
-  // units and units like "seconds" and "nanoseconds" as time units,
-  // and apply appropriate unit conversions to these.
-  int64 num_unit = 4;  // Index into string table
-}
-
-message Mapping {
-  // Unique nonzero id for the mapping.
-  uint64 id = 1;
-  // Address at which the binary (or DLL) is loaded into memory.
-  uint64 memory_start = 2;
-  // The limit of the address range occupied by this mapping.
-  uint64 memory_limit = 3;
-  // Offset in the binary that corresponds to the first mapped address.
-  uint64 file_offset = 4;
-  // The object this entry is loaded from.  This can be a filename on
-  // disk for the main binary and shared libraries, or virtual
-  // abstractions like "[vdso]".
-  int64 filename = 5;  // Index into string table
-  // A string that uniquely identifies a particular program version
-  // with high probability. E.g., for binaries generated by GNU tools,
-  // it could be the contents of the .note.gnu.build-id field.
-  int64 build_id = 6;  // Index into string table
-
-  // The following fields indicate the resolution of symbolic info.
-  bool has_functions = 7;
-  bool has_filenames = 8;
-  bool has_line_numbers = 9;
-  bool has_inline_frames = 10;
-}
-
-// Describes function and line table debug information.
-message Location {
-  // Unique nonzero id for the location.  A profile could use
-  // instruction addresses or any integer sequence as ids.
-  uint64 id = 1;
-  // The id of the corresponding profile.Mapping for this location.
-  // It can be unset if the mapping is unknown or not applicable for
-  // this profile type.
-  uint64 mapping_id = 2;
-  // The instruction address for this location, if available.  It
-  // should be within [Mapping.memory_start...Mapping.memory_limit]
-  // for the corresponding mapping. A non-leaf address may be in the
-  // middle of a call instruction. It is up to display tools to find
-  // the beginning of the instruction if necessary.
-  uint64 address = 3;
-  // Multiple line indicates this location has inlined functions,
-  // where the last entry represents the caller into which the
-  // preceding entries were inlined.
-  //
-  // E.g., if memcpy() is inlined into printf:
-  //    line[0].function_name == "memcpy"
-  //    line[1].function_name == "printf"
-  repeated Line line = 4;
-  // Provides an indication that multiple symbols map to this location's
-  // address, for example due to identical code folding by the linker. In that
-  // case the line information above represents one of the multiple
-  // symbols. This field must be recomputed when the symbolization state of the
-  // profile changes.
-  bool is_folded = 5;
-}
-
-message Line {
-  // The id of the corresponding profile.Function for this line.
-  uint64 function_id = 1;
-  // Line number in source code.
-  int64 line = 2;
-}
-
-message Function {
-  // Unique nonzero id for the function.
-  uint64 id = 1;
-  // Name of the function, in human-readable form if available.
-  int64 name = 2; // Index into string table
-  // Name of the function, as identified by the system.
-  // For instance, it can be a C++ mangled name.
-  int64 system_name = 3; // Index into string table
-  // Source file containing the function.
-  int64 filename = 4; // Index into string table
-  // Line number in source file.
-  int64 start_line = 5;
-}

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

@@ -1,83 +0,0 @@
-# typed: false
-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: lib/datadog/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/datadog/profiling/pprof/stack_sample.rb

@@ -1,141 +0,0 @@
-# typed: true
-
-require_relative '../ext'
-require_relative '../events/stack'
-require_relative 'builder'
-require_relative '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: [
-            Profiling::Ext::Pprof::VALUE_TYPE_CPU,
-            Profiling::Ext::Pprof::VALUE_UNIT_NANOSECONDS
-          ],
-          wall_time_ns: [
-            Profiling::Ext::Pprof::VALUE_TYPE_WALL,
-            Profiling::Ext::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 = 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 (identified by root span id)
-        def update_most_recent_trace_sample(stack_sample)
-          return unless stack_sample.root_span_id && stack_sample.trace_resource
-
-          # Update trace resource with most recent value
-          if (most_recent_trace_sample = @most_recent_trace_samples[stack_sample.root_span_id])
-            if most_recent_trace_sample.timestamp < stack_sample.timestamp
-              @most_recent_trace_samples[stack_sample.root_span_id] = stack_sample
-            end
-          else
-            # Add trace resource
-            @most_recent_trace_samples[stack_sample.root_span_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 = Profiling::Ext::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(Profiling::Ext::Pprof::LABEL_KEY_THREAD_ID),
-              str: builder.string_table.fetch(stack_sample.thread_id.to_s)
-            )
-          ]
-
-          root_span_id = stack_sample.root_span_id || 0
-          span_id = stack_sample.span_id || 0
-
-          if root_span_id != 0 && span_id != 0
-            @processed_with_trace += 1
-
-            labels << Perftools::Profiles::Label.new(
-              key: builder.string_table.fetch(Profiling::Ext::Pprof::LABEL_KEY_LOCAL_ROOT_SPAN_ID),
-              str: builder.string_table.fetch(root_span_id.to_s)
-            )
-
-            labels << Perftools::Profiles::Label.new(
-              key: builder.string_table.fetch(Profiling::Ext::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.fetch(stack_sample.root_span_id, stack_sample).trace_resource
-
-            if trace_resource && !trace_resource.empty?
-              labels << Perftools::Profiles::Label.new(
-                key: builder.string_table.fetch(Profiling::Ext::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}"
-        end
-      end
-    end
-  end
-end

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

@@ -1,12 +0,0 @@
-# typed: strict
-
-require_relative '../../core/utils/string_table'
-
-module Datadog
-  module Profiling
-    module Pprof
-      # Tracks strings and returns IDs
-      class StringTable < Core::Utils::StringTable; end
-    end
-  end
-end

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

@@ -1,120 +0,0 @@
-# typed: false
-
-require_relative 'payload'
-require_relative 'message_set'
-require_relative 'builder'
-
-require_relative '../events/stack'
-require_relative '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 debug_statistics
-          converters.values.map(&:debug_statistics).join(', ')
-        end
-
-        def to_pprof(start:, finish:)
-          profile = builder.build_profile(start: start, finish: finish)
-          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/datadog/profiling/trace_identifiers/ddtrace.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-# typed: true
-
-require_relative '../../tracing'
-require_relative '../../tracing/metadata/ext'
-
-module Datadog
-  module Profiling
-    module TraceIdentifiers
-      # Used by Datadog::Profiling::TraceIdentifiers::Helper to get the trace identifiers (root span id and span id)
-      # for a given thread, if there is an active trace for that thread in the supplied tracer object.
-      class Ddtrace
-        def initialize(tracer:)
-          @tracer = (tracer if tracer.respond_to?(:active_trace))
-        end
-
-        def trace_identifiers_for(thread)
-          return unless @tracer
-
-          trace = @tracer.active_trace(thread)
-          return unless trace
-
-          root_span = trace.send(:root_span)
-          span = trace.active_span
-          return unless span && root_span
-
-          root_span_id = root_span.id || 0
-          span_id = span.id || 0
-
-          [root_span_id, span_id, maybe_extract_resource(trace, root_span)] if root_span_id != 0 && span_id != 0
-        end
-
-        private
-
-        # NOTE: Currently we're only interested in HTTP service endpoints. Over time, this list may be expanded.
-        # Resources MUST NOT include personal identifiable information (PII); this should not be the case with
-        # ddtrace integrations, but worth mentioning just in case :)
-        def maybe_extract_resource(trace, root_span)
-          trace.resource if root_span.span_type == Tracing::Metadata::Ext::HTTP::TYPE_INBOUND
-        end
-      end
-    end
-  end
-end

data/lib/datadog/profiling/trace_identifiers/helper.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-# typed: true
-
-require_relative 'ddtrace'
-
-module Datadog
-  module Profiling
-    module TraceIdentifiers
-      # Helper used to retrieve the trace identifiers (root span id and span id) for a given thread,
-      # if there is an active trace for that thread for the supported tracing APIs.
-      #
-      # This data is used to connect profiles to the traces -- samples in a profile will be tagged with this data and
-      # the profile can be filtered down to look at only the samples for a given trace.
-      class Helper
-        DEFAULT_SUPPORTED_APIS = [
-          Profiling::TraceIdentifiers::Ddtrace
-        ].freeze
-        private_constant :DEFAULT_SUPPORTED_APIS
-
-        def initialize(
-          tracer:,
-          # If this is disabled, the helper will strip the optional trace_resource_container even if provided by the api
-          endpoint_collection_enabled:,
-          supported_apis: DEFAULT_SUPPORTED_APIS.map { |api| api.new(tracer: tracer) }
-        )
-          @endpoint_collection_enabled = endpoint_collection_enabled
-          @supported_apis = supported_apis
-        end
-
-        # Expected output of the #trace_identifiers_for
-        # duck type is [root_span_id, span_id, (optional trace_resource_container)]
-        def trace_identifiers_for(thread)
-          @supported_apis.each do |api|
-            trace_identifiers = api.trace_identifiers_for(thread)
-
-            if trace_identifiers
-              return @endpoint_collection_enabled ? trace_identifiers : trace_identifiers[0..1]
-            end
-          end
-
-          nil
-        end
-      end
-    end
-  end
-end