Instrumenter interface

Pakiet:

@azure/core-tracing

Reprezentuje niezależny instrumentator implementacji.

Metody

createRequestHeaders(TracingContext)	Udostępnia metodę specyficzną dla implementacji, aby serializować TracingSpan do zestawu nagłówków.
parseTraceparentHeader(string)	Udostępnia metodę specyficzną dla implementacji, aby przeanalizować https://www.w3.org/TR/trace-context/#traceparent-header w <xref:TracingSpanContext>, które mogą służyć do łączenia nieupowiązanych zakresów.
startSpan(string, InstrumenterSpanOptions)	Tworzy nowy TracingSpan o podanej nazwie i opcjach i ustawia go w nowym kontekście.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)	Opakowuje wywołanie zwrotne z aktywnym kontekstem i wywołuje wywołanie zwrotne. W zależności od implementacji może to spowodować ustawienie globalnego aktywnego kontekstu.

Szczegóły metody

createRequestHeaders(TracingContext)

Udostępnia metodę specyficzną dla implementacji, aby serializować TracingSpan do zestawu nagłówków.

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

Parametry

tracingContext

TracingContext

Kontekst zawierający zakres do serializacji.

Zwraca

Record<string, string>

parseTraceparentHeader(string)

Udostępnia metodę specyficzną dla implementacji, aby przeanalizować https://www.w3.org/TR/trace-context/#traceparent-header w <xref:TracingSpanContext>, które mogą służyć do łączenia nieupowiązanych zakresów.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Parametry

traceparentHeader

string

Zwraca

undefined | TracingContext

startSpan(string, InstrumenterSpanOptions)

Tworzy nowy TracingSpan o podanej nazwie i opcjach i ustawia go w nowym kontekście.

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

Parametry

name

string

Nazwa zakresu. Zgodnie z konwencją powinna to być ${className}.${methodName}.

spanOptions

InstrumenterSpanOptions

Opcje do użycia podczas tworzenia zakresu.

Zwraca

{ span: TracingSpan, tracingContext: TracingContext }

TracingSpan, których można użyć do zakończenia zakresu, a kontekst tego zakresu został ustawiony.

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

Opakowuje wywołanie zwrotne z aktywnym kontekstem i wywołuje wywołanie zwrotne. W zależności od implementacji może to spowodować ustawienie globalnego aktywnego kontekstu.

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

Parametry

context

TracingContext

TracingContext do użycia jako aktywny kontekst w zakresie wywołania zwrotnego.

callback

Callback

Wywołanie zwrotne, które ma być wywoływane z podanym kontekstem ustawionym jako kontekst globalnie aktywny.

callbackArgs

CallbackArgs

Argumenty wywołania zwrotnego.

Zwraca

ReturnType<Callback>