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

Instrumenter interface

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

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

Методы

createRequestHeaders(TracingContext)

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

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

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

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

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

createRequestHeaders(TracingContext)

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

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): undefined | TracingContext

Параметры

traceparentHeader

string

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

undefined | TracingContext

startSpan(string, InstrumenterSpanOptions)

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

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

Параметры

name

string

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

spanOptions
InstrumenterSpanOptions

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

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

{ span: TracingSpan, tracingContext: TracingContext }

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

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

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

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

Параметры

context
TracingContext

ТрассировкаContext использовать в качестве активного контекста в области обратного вызова.

callback

Callback

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

callbackArgs

CallbackArgs

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

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

ReturnType<Callback>