TracingClient interface

Paket:

@azure/core-tracing

Representerar en klient som kan integreras med den för närvarande konfigurerade Instrumenter.

Skapa en instans med createTracingClient.

Metoder

createRequestHeaders(TracingContext)	Skapar en uppsättning begärandehuvuden för att sprida spårningsinformation till en serverdel.
parseTraceparentHeader(string)	Parsar ett traceparent-huvudvärde till en <xref:TracingSpanContext>.
startSpan<Options>(string, Options, TracingSpanOptions)	Startar ett angivet spann men anger det inte som det aktiva intervallet. Du måste avsluta intervallet med hjälp av slutet. För det mesta vill du använda medSpan i stället.
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. Användbart när du vill lämna SDK:ns gränser (skicka en begäran eller återanrop till användarkoden) och inte kan använda withSpan-API :et.
withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)	Omsluter ett återanrop i ett spårningsintervall, anropar återanropet och stänger spannet. Det här är det primära gränssnittet för att använda spårning och hanterar felregistrering samt anger status för spannet. Både synkrona och asynkrona funktioner väntar för att återspegla resultatet av återanropet i spannet. Exempel: const myOperationResult = await tracingClient.withSpan("myClassName.myOperationName", options, (updatedOptions) => myOperation(updatedOptions));

Metodinformation

createRequestHeaders(TracingContext)

Skapar en uppsättning begärandehuvuden för att sprida spårningsinformation till en serverdel.

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

Parametrar

tracingContext

TracingContext

Kontexten som innehåller det span som ska spridas.

Returer

Record<string, string>

Uppsättningen rubriker som ska läggas till i en begäran.

parseTraceparentHeader(string)

Parsar ett traceparent-huvudvärde till en <xref:TracingSpanContext>.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Parametrar

traceparentHeader

string

Den traceparent-rubrik som ska parsas.

Returer

undefined | TracingContext

En implementeringsspecifik identifierare för spannet.

startSpan<Options>(string, Options, TracingSpanOptions)

Startar ett angivet spann men anger det inte som det aktiva intervallet.

Du måste avsluta intervallet med hjälp av slutet.

För det mesta vill du använda medSpan i stället.

function startSpan<Options>(name: string, operationOptions?: Options, spanOptions?: TracingSpanOptions): { span: TracingSpan, updatedOptions: OptionsWithTracingContext<Options> }

Parametrar

name

string

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

operationOptions

Options

De ursprungliga åtgärdsalternativen.

spanOptions

TracingSpanOptions

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

Returer

{ span: TracingSpan, updatedOptions: OptionsWithTracingContext<Options> }

En TracingSpan och de uppdaterade åtgärdsalternativen.

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.

Användbart när du vill lämna SDK:ns gränser (skicka en begäran eller återanrop till användarkoden) och inte kan använda withSpan-API :et.

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

Parametrar

context

TracingContext

Den TracingContext som ska användas 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>

withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)

Omsluter ett återanrop i ett spårningsintervall, anropar återanropet och stänger spannet.

Det här är det primära gränssnittet för att använda spårning och hanterar felregistrering samt anger status för spannet.

Både synkrona och asynkrona funktioner väntar för att återspegla resultatet av återanropet i spannet.

Exempel:

const myOperationResult = await tracingClient.withSpan("myClassName.myOperationName", options, (updatedOptions) => myOperation(updatedOptions));

function withSpan<Options, Callback>(name: string, operationOptions: Options, callback: Callback, spanOptions?: TracingSpanOptions): Promise<Resolved<ReturnType<Callback>>>

Parametrar

name

string

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

operationOptions

Options

De ursprungliga alternativen skickades till metoden. Återanropet får dessa alternativ med den nyligen skapade TracingContext.

callback

Callback

Återanropet som ska anropas med de uppdaterade alternativen och det nyligen skapade TracingSpan.

spanOptions

TracingSpanOptions

Returer

Promise<Resolved<ReturnType<Callback>>>