Contents

# frozen_string_literal: true

# typed: true

require 'datadog/profiling/trace_identifiers/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

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
ddtrace-1.2.0	lib/datadog/profiling/trace_identifiers/helper.rb
ddtrace-1.1.0	lib/datadog/profiling/trace_identifiers/helper.rb
ddtrace-1.0.0	lib/datadog/profiling/trace_identifiers/helper.rb
ddtrace-1.0.0.beta2	lib/datadog/profiling/trace_identifiers/helper.rb