TracingClient interface

Paket:

@azure/core-tracing

Stellt einen Client dar, der in den aktuell konfigurierten Instrumenter integriert werden kann.

Erstellen Sie mithilfe von createTracingClient eine Instanz.

Methoden

createRequestHeaders(TracingContext)	Erstellt eine Reihe von Anforderungsheadern, um Ablaufverfolgungsinformationen an ein Back-End zu verteilen.
parseTraceparentHeader(string)	Analysiert einen Traceparent-Headerwert in einen <xref:TracingSpanContext>.
startSpan<Options>(string, Options, TracingSpanOptions)	Startet eine bestimmte Spanne, legt sie aber nicht als aktive Spanne fest. Sie müssen die Spanne mit ende beenden. Die meiste Zeit sollten Sie stattdessen mitSpan verwenden.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)	Umschließt einen Rückruf mit einem aktiven Kontext und ruft den Rückruf auf. Je nach Implementierung kann dadurch der global verfügbare aktive Kontext festgelegt werden. Nützlich, wenn Sie die Grenzen des SDK verlassen möchten (stellen Sie eine Anforderung oder ein Rückruf an Benutzercode) und die withSpan-API nicht verwenden können.
withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)	Umschließt einen Rückruf in einer Ablaufverfolgungsspanne, ruft den Rückruf auf und schließt die Spanne. Dies ist die primäre Schnittstelle für die Verwendung der Ablaufverfolgung und verarbeitet die Fehleraufzeichnung sowie das Festlegen des Status für die Spanne. Sowohl synchrone als auch asynchrone Funktionen werden erwartet, um das Ergebnis des Rückrufs in der Spanne widerzuspiegeln. Beispiel: const myOperationResult = await tracingClient.withSpan("myClassName.myOperationName", options, (updatedOptions) => myOperation(updatedOptions));

Details zur Methode

createRequestHeaders(TracingContext)

Erstellt eine Reihe von Anforderungsheadern, um Ablaufverfolgungsinformationen an ein Back-End zu verteilen.

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

Parameter

tracingContext

TracingContext

Der Kontext, der die zu verteilende Spanne enthält.

Gibt zurück

Record<string, string>

Der Satz von Headern, die einer Anforderung hinzugefügt werden sollen.

parseTraceparentHeader(string)

Analysiert einen Traceparent-Headerwert in einen <xref:TracingSpanContext>.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Parameter

traceparentHeader

string

Der zu analysierende Traceparent-Header.

Gibt zurück

undefined | TracingContext

Ein implementierungsspezifischer Bezeichner für die Spanne.

startSpan<Options>(string, Options, TracingSpanOptions)

Startet eine bestimmte Spanne, legt sie aber nicht als aktive Spanne fest.

Sie müssen die Spanne mit ende beenden.

Die meiste Zeit sollten Sie stattdessen mitSpan verwenden.

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

Parameter

name

string

Der Name der Spanne. Gemäß der Konvention sollte dies sein ${className}.${methodName}.

operationOptions

Options

Die ursprünglichen Vorgangsoptionen.

spanOptions

TracingSpanOptions

Die Optionen, die beim Erstellen der Spanne verwendet werden sollen.

Gibt zurück

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

Eine TracingSpan und die aktualisierten Vorgangsoptionen.

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

Umschließt einen Rückruf mit einem aktiven Kontext und ruft den Rückruf auf. Je nach Implementierung kann dadurch der global verfügbare aktive Kontext festgelegt werden.

Nützlich, wenn Sie die Grenzen des SDK verlassen möchten (stellen Sie eine Anforderung oder ein Rückruf an Benutzercode) und die withSpan-API nicht verwenden können.

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

Parameter

context

TracingContext

Der TracingContext , der als aktiver Kontext im Bereich des Rückrufs verwendet werden soll.

callback

Callback

Der Rückruf, der aufgerufen werden soll, wobei der angegebene Kontext als global aktiver Kontext festgelegt ist.

callbackArgs

CallbackArgs

Die Rückrufargumente.

Gibt zurück

ReturnType<Callback>

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

Umschließt einen Rückruf in einer Ablaufverfolgungsspanne, ruft den Rückruf auf und schließt die Spanne.

Dies ist die primäre Schnittstelle für die Verwendung der Ablaufverfolgung und verarbeitet die Fehleraufzeichnung sowie das Festlegen des Status für die Spanne.

Sowohl synchrone als auch asynchrone Funktionen werden erwartet, um das Ergebnis des Rückrufs in der Spanne widerzuspiegeln.

Beispiel:

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

Parameter

name

string

Der Name der Spanne. Gemäß der Konvention sollte dies sein ${className}.${methodName}.

operationOptions

Options

Die ursprünglichen Optionen, die an die -Methode übergeben wurden. Der Rückruf empfängt diese Optionen mit dem neu erstellten TracingContext.

callback

Callback

Der Rückruf, der mit den aktualisierten Optionen und der neu erstellten TracingSpan aufgerufen werden soll.

spanOptions

TracingSpanOptions

Gibt zurück

Promise<Resolved<ReturnType<Callback>>>