Instrumenter interface

  • Reference
Balíček:
@azure/core-tracing

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

Metody

createRequestHeaders(TracingContext)

Poskytuje metodu specifickou pro implementaci serializace TracingSpan na sadu hlaviček.
parseTraceparentHeader(string)

Poskytuje metodu specifickou pro implementaci, která parsuje https://www.w3.org/TR/trace-context/#traceparent-header objekt do objektu <xref:TracingSpanContext> , který lze použít k propojení ne nadřazených rozsahů dohromady.
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)

Zalomí zpětné volání s aktivním kontextem 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 na sadu 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 objekt do objektu <xref:TracingSpanContext> , který lze použít k propojení ne nadřazených rozsahů dohromady.

function parseTraceparentHeader(traceparentHeader: string): TracingContext | undefined

Parametry

traceparentHeader

string

Návraty

TracingContext | undefined

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 }

Objekt TracingSpan , který lze použít k ukončení rozsahu, a kontext, na který byl tento rozsah nastaven.

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

Zalomí zpětné volání s aktivním kontextem 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

Použije TracingContext se jako aktivní kontext v oboru zpětného volání.

callback

Callback

Zpětné volání, které se má vyvolat s daným kontextem nastaveným jako globálně aktivní kontext.

callbackArgs

CallbackArgs

Argumenty zpětného volání

Návraty

ReturnType<Callback>