Dela via

Instrumenter interface

Paket:
@azure/core-tracing

Representerar en implementeringsagnostisk instrumenterare.

Metoder

createRequestHeaders(TracingContext)

Tillhandahåller en implementeringsspecifik metod för att serialisera en TracingSpan- till en uppsättning rubriker.
parseTraceparentHeader(string)

Tillhandahåller en implementeringsspecifik metod för att parsa en https://www.w3.org/TR/trace-context/#traceparent-header till en <xref:TracingSpanContext> som kan användas för att länka samman icke-överordnade intervall.
startSpan(string, InstrumenterSpanOptions)

Skapar en ny TracingSpan- med förnamn och alternativ och anger den i en ny kontext.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)

Omsluter ett återanrop med en aktiv kontext och anropar återanropet. Beroende på implementeringen kan detta ange den globalt tillgängliga aktiva kontexten.

Metodinformation

createRequestHeaders(TracingContext)

Tillhandahåller en implementeringsspecifik metod för att serialisera en TracingSpan- till en uppsättning rubriker.

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

Parametrar

tracingContext
TracingContext

Kontexten som innehåller intervallet som ska serialiseras.

Returer

Record<string, string>

parseTraceparentHeader(string)

Tillhandahåller en implementeringsspecifik metod för att parsa en https://www.w3.org/TR/trace-context/#traceparent-header till en <xref:TracingSpanContext> som kan användas för att länka samman icke-överordnade intervall.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Parametrar

traceparentHeader

string

Returer

undefined | TracingContext

startSpan(string, InstrumenterSpanOptions)

Skapar en ny TracingSpan- med förnamn och alternativ och anger den i en ny kontext.

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

Parametrar

name

string

Namnet på spannet. Enligt konvention bör detta vara ${className}.${methodName}.

spanOptions
InstrumenterSpanOptions

De alternativ som ska användas när du skapar intervallet.

Returer

{ span: TracingSpan, tracingContext: TracingContext }

En TracingSpan- som kan användas för att avsluta intervallet och kontexten som det här intervallet har angetts för.

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

Omsluter ett återanrop med en aktiv kontext och anropar återanropet. Beroende på implementeringen kan detta ange den globalt tillgängliga aktiva kontexten.

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

Parametrar

context
TracingContext

TracingContext att använda som aktiv kontext i återanropets omfång.

callback

Callback

Återanropet som ska anropas med den angivna kontexten inställd som den globalt aktiva kontexten.

callbackArgs

CallbackArgs

Motringningsargumenten.

Returer

ReturnType<Callback>