Udostępnij za pośrednictwem

Instrumenter interface

  • Odwołanie
Pakiet:
@azure/core-tracing

Reprezentuje niezależną od implementacji instrumentator.

Metody

createRequestHeaders(TracingContext)

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

Udostępnia metodę specyficzną dla implementacji, która umożliwia analizowanie https://www.w3.org/TR/trace-context/#traceparent-header elementu w obiekt <xref:TracingSpanContext> , który może służyć do łączenia zakresów niezwiązanych z elementami nadrzędnymi.
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 ustawić globalnie dostępny aktywny kontekst.

Szczegóły metody

createRequestHeaders(TracingContext)

Udostępnia metodę specyficzną dla implementacji, aby serializować TracingSpan element 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, która umożliwia analizowanie https://www.w3.org/TR/trace-context/#traceparent-header elementu w obiekt <xref:TracingSpanContext> , który może służyć do łączenia zakresów niezwiązanych z elementami nadrzędnymi.

function parseTraceparentHeader(traceparentHeader: string): TracingContext | undefined

Parametry

traceparentHeader

string

Zwraca

TracingContext | undefined

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 }

Element TracingSpan , którego można użyć do zakończenia zakresu, a kontekst, w ramach którego ustawiono ten zakres.

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 ustawić globalnie dostępny aktywny kontekst.

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

Parametry

context
TracingContext

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

callback

Callback

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

callbackArgs

CallbackArgs

Argumenty wywołania zwrotnego.

Zwraca

ReturnType<Callback>