Поделиться через

Instrumenter interface

  • Ссылка
Пакет:
@azure/core-tracing

Представляет инструментатор, не зависящий от реализации.

Методы

createRequestHeaders(TracingContext)

Предоставляет зависящий от реализации метод для сериализации в TracingSpan набор заголовков.
parseTraceparentHeader(string)

Предоставляет метод, зависящий от реализации, для анализа https://www.w3.org/TR/trace-context/#traceparent-header<xref:TracingSpanContext> в , который можно использовать для связывания несемеченных диапазонов.
startSpan(string, InstrumenterSpanOptions)

Создает объект TracingSpan с заданным именем и параметрами и задает его в новом контексте.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)

Заключает обратный вызов в активный контекст и вызывает обратный вызов. В зависимости от реализации это может задать глобально доступный активный контекст.

Сведения о методе

createRequestHeaders(TracingContext)

Предоставляет зависящий от реализации метод для сериализации в TracingSpan набор заголовков.

function createRequestHeaders(tracingContext?: TracingContext): Record<string, string>

Параметры

tracingContext
TracingContext

Контекст, содержащий диапазон для сериализации.

Возвращаемое значение

Record<string, string>

parseTraceparentHeader(string)

Предоставляет метод, зависящий от реализации, для анализа https://www.w3.org/TR/trace-context/#traceparent-header<xref:TracingSpanContext> в , который можно использовать для связывания несемеченных диапазонов.

function parseTraceparentHeader(traceparentHeader: string): TracingContext | undefined

Параметры

traceparentHeader

string

Возвращаемое значение

TracingContext | undefined

startSpan(string, InstrumenterSpanOptions)

Создает объект TracingSpan с заданным именем и параметрами и задает его в новом контексте.

function startSpan(name: string, spanOptions: InstrumenterSpanOptions): { span: TracingSpan, tracingContext: TracingContext }

Параметры

name

string

Имя диапазона. По соглашению это должно быть ${className}.${methodName}.

spanOptions
InstrumenterSpanOptions

Параметры, используемые при создании диапазона.

Возвращаемое значение

{ span: TracingSpan, tracingContext: TracingContext }

Объект TracingSpan , который можно использовать для завершения диапазона и контекста, для которого задан этот диапазон.

withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)

Заключает обратный вызов в активный контекст и вызывает обратный вызов. В зависимости от реализации это может задать глобально доступный активный контекст.

function withContext<CallbackArgs, Callback>(context: TracingContext, callback: Callback, callbackArgs: CallbackArgs): ReturnType<Callback>

Параметры

context
TracingContext

Объект TracingContext , используемый в качестве активного контекста в области обратного вызова.

callback

Callback

Обратный вызов, вызываемый с заданным контекстом, заданным в качестве глобально активного контекста.

callbackArgs

CallbackArgs

Аргументы обратного вызова.

Возвращаемое значение

ReturnType<Callback>