TracingClient interface

Csomag:

@azure/core-tracing

Olyan ügyfelet jelöl, amely integrálható a jelenleg konfigurált Instrumenterrel.

Hozzon létre egy példányt a createTracingClient használatával.

Metódusok

createRequestHeaders(TracingContext)	Létrehoz egy kérelemfejléckészletet a nyomkövetési információk háttérrendszerbe való propagálásához.
parseTraceparentHeader(string)	Egy nyomkövetési fejléc értékét elemzi egy <xref:TracingSpanContext>.
startSpan<Options>(string, Options, TracingSpanOptions)	Elindít egy adott spant, de nem állítja be aktív spanként. Véget kell vetnie a span-nak a vége használatával. A legtöbb esetben inkább a withSpant szeretné használni.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)	Egy visszahívást aktív környezettel burkol, és meghívja a visszahívást. A megvalósítástól függően ez beállíthatja a globálisan elérhető aktív környezetet. Akkor hasznos, ha el szeretné hagyni az SDK határait (kérést szeretne küldeni vagy visszahívni a felhasználói kódra), és nem tudja használni a withSpan API-t.
withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)	Körbefuttat egy visszahívást egy nyomkövetési tartományba, meghívja a visszahívást, és bezárja a tartományt. Ez a nyomkövetés használatának elsődleges felülete, amely kezeli a hibafelvételt, valamint beállítja az állapotot a tartományon. A szinkronizálási és az aszinkron függvények is várnak, hogy tükrözzék a visszahívás eredményét a spanon. Példa: const myOperationResult = await tracingClient.withSpan("myClassName.myOperationName", options, (updatedOptions) => myOperation(updatedOptions));

Metódus adatai

createRequestHeaders(TracingContext)

Létrehoz egy kérelemfejléckészletet a nyomkövetési információk háttérrendszerbe való propagálásához.

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

Paraméterek

tracingContext

TracingContext

A propagálási spant tartalmazó környezet.

Válaszok

Record<string, string>

A kéréshez hozzáadni kívánt fejlécek halmaza.

parseTraceparentHeader(string)

Egy nyomkövetési fejléc értékét elemzi egy <xref:TracingSpanContext>.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Paraméterek

traceparentHeader

string

Az elemezni kívánt nyomkövetési fejléc.

Válaszok

undefined | TracingContext

A span implementációspecifikus azonosítója.

startSpan<Options>(string, Options, TracingSpanOptions)

Elindít egy adott spant, de nem állítja be aktív spanként.

Véget kell vetnie a span-nak a vége használatával.

A legtöbb esetben inkább a withSpant szeretné használni.

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

Paraméterek

name

string

A span neve. Konvenció szerint ennek a következőnek kell lennie ${className}.${methodName}: .

operationOptions

Options

Az eredeti műveletbeállítások.

spanOptions

TracingSpanOptions

A span létrehozásakor használni kívánt lehetőségek.

Válaszok

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

A TracingSpan és a frissített műveleti beállítások.

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

Egy visszahívást aktív környezettel burkol, és meghívja a visszahívást. A megvalósítástól függően ez beállíthatja a globálisan elérhető aktív környezetet.

Akkor hasznos, ha el szeretné hagyni az SDK határait (kérést szeretne küldeni vagy visszahívni a felhasználói kódra), és nem tudja használni a withSpan API-t.

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

Paraméterek

context

TracingContext

A visszahívás hatókörében aktív környezetként használni kívánt TracingContext .

callback

Callback

A meghívandó visszahívás az adott környezettel globálisan aktív környezetként van beállítva.

callbackArgs

CallbackArgs

A visszahívási argumentumok.

Válaszok

ReturnType<Callback>

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

Körbefuttat egy visszahívást egy nyomkövetési tartományba, meghívja a visszahívást, és bezárja a tartományt.

Ez a nyomkövetés használatának elsődleges felülete, amely kezeli a hibafelvételt, valamint beállítja az állapotot a tartományon.

A szinkronizálási és az aszinkron függvények is várnak, hogy tükrözzék a visszahívás eredményét a spanon.

Példa:

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>>>

Paraméterek

name

string

A span neve. Konvenció szerint ennek a következőnek kell lennie ${className}.${methodName}: .

operationOptions

Options

A metódusnak átadott eredeti beállítások. A visszahívás ezeket a beállításokat az újonnan létrehozott TracingContext szöveggel kapja meg.

callback

Callback

A visszahívás a frissített beállításokkal és az újonnan létrehozott TracingSpan beállításokkal hívható meg.

spanOptions

TracingSpanOptions

Válaszok

Promise<Resolved<ReturnType<Callback>>>