TracingClient interface

Csomag:: @azure/core-tracing

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

Hozzon létre egy példányt createTracingClienthasználatával.

Metódusok

createRequestHeaders(TracingContext)	Kérésfejlécek készletét hozza létre 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)	Egy adott időtartamot indít el, de nem állítja be aktív spanként. A TracingSpan.end segítségével kell lezárni a szakaszt. A legtöbb esetben inkább a és a Span használatát szeretné használni.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)	Aktív környezettel burkolja a visszahívást, é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 a Span API-val.
withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)	Körbefuttat egy visszahívást egy nyomkövetési időtartamban, 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 skálán. A szinkronizálási és az aszinkron függvények egyaránt várnak, hogy tükrözzék a visszahívás eredményét a spanon. Példa: `import { createTracingClient } from "@azure/core-tracing"; const tracingClient = createTracingClient({ namespace: "test.namespace", packageName: "test-package", packageVersion: "1.0.0", }); const options = {}; const myOperationResult = await tracingClient.withSpan( "myClassName.myOperationName", options, (updatedOptions) => { // Do something with the updated options. return "myOperationResult"; }, );`

Metódus adatai

createRequestHeaders(TracingContext)

Kérésfejlécek készletét hozza létre 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 időtartamot tartalmazó környezet.

Válaszok

Record<string, string>

A kérelemhez hozzáadni kívánt fejlécek készlete.

parseTraceparentHeader(string)

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

function parseTraceparentHeader(traceparentHeader: string): TracingContext | undefined

Paraméterek

traceparentHeader: string

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

Válaszok

TracingContext | undefined

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

startSpan<Options>(string, Options, TracingSpanOptions)

Egy adott időtartamot indít el, de nem állítja be aktív spanként.

A TracingSpan.end segítségével kell lezárni a szakaszt.

A legtöbb esetben inkább a és a Span használatát 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 ${className}.${methodName}kell lennie.

operationOptions: Options

Az eredeti műveleti beállítások.

spanOptions: TracingSpanOptions

A hatókör létrehozásakor használandó 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)

Aktív környezettel burkolja a visszahívást, é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 a Span API-val.

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

Paraméterek

context: TracingContext

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

callback: Callback

Az adott környezettel meghívandó visszahívás 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 időtartamban, 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 skálán.

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

Példa:

import { createTracingClient } from "@azure/core-tracing";

const tracingClient = createTracingClient({
  namespace: "test.namespace",
  packageName: "test-package",
  packageVersion: "1.0.0",
});

const options = {};

const myOperationResult = await tracingClient.withSpan(
  "myClassName.myOperationName",
  options,
  (updatedOptions) => {
    // Do something with the updated options.
    return "myOperationResult";
  },
);

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

Paraméterek

name: string

A span neve. Konvenció szerint ennek ${className}.${methodName}kell lennie.

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 TracingContextfogja megkapni.

callback: Callback

A frissített beállításokkal meghívandó visszahívás és az újonnan létrehozott TracingSpan.

spanOptions: TracingSpanOptions

Válaszok

Promise<Awaited<ReturnType<Callback>>>