Instrumenter interface

Balíček:

@azure/core-tracing

Představuje nástroj nezávislý na implementaci.

Metody

createRequestHeaders(TracingContext)	Poskytuje metodu specifickou pro implementaci serializace TracingSpan do sady hlaviček.
parseTraceparentHeader(string)	Poskytuje metodu specifickou pro implementaci, která parsuje https://www.w3.org/TR/trace-context/#traceparent-header do <xref:TracingSpanContext>, která se dá použít k propojení nesouvisených rozsahů.
startSpan(string, InstrumenterSpanOptions)	Vytvoří nový TracingSpan s daným názvem a možnostmi a nastaví ho na nový kontext.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)	Zabalí zpětné volání pomocí aktivního kontextu a zavolá zpětné volání. V závislosti na implementaci to může nastavit globálně dostupný aktivní kontext.

Podrobnosti metody

createRequestHeaders(TracingContext)

Poskytuje metodu specifickou pro implementaci serializace TracingSpan do sady hlaviček.

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

Parametry

tracingContext

TracingContext

Kontext obsahující rozsah pro serializaci.

Návraty

Record<string, string>

parseTraceparentHeader(string)

Poskytuje metodu specifickou pro implementaci, která parsuje https://www.w3.org/TR/trace-context/#traceparent-header do <xref:TracingSpanContext>, která se dá použít k propojení nesouvisených rozsahů.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Parametry

traceparentHeader

string

Návraty

undefined | TracingContext

startSpan(string, InstrumenterSpanOptions)

Vytvoří nový TracingSpan s daným názvem a možnostmi a nastaví ho na nový kontext.

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

Parametry

name

string

Název rozsahu. Podle konvence by to mělo být ${className}.${methodName}.

spanOptions

InstrumenterSpanOptions

Možnosti, které se mají použít při vytváření rozsahu.

Návraty

{ span: TracingSpan, tracingContext: TracingContext }

TracingSpan, který lze použít k ukončení rozsahu a kontext, na který je toto rozpětí nastavené.

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

Zabalí zpětné volání pomocí aktivního kontextu a zavolá zpětné volání. V závislosti na implementaci to může nastavit globálně dostupný aktivní kontext.

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

Parametry

context

TracingContext

TracingContext použít jako aktivní kontext v oboru zpětného volání.

callback

Callback

Zpětné volání, které se má vyvolat s danou kontextovou sadou jako globálně aktivní kontext.

callbackArgs

CallbackArgs

Argumenty zpětného volání.

Návraty

ReturnType<Callback>