TracingClient interface

Paket:

@azure/core-tracing

Stellt einen Client dar, der in den derzeit konfigurierten Instrumenterintegriert werden kann.

Erstellen Sie eine Instanz mit createTracingClient.

Methoden

createRequestHeaders(TracingContext)	Erstellt eine Reihe von Anforderungsheadern, um Ablaufverfolgungsinformationen an ein Back-End zu verteilen.
parseTraceparentHeader(string)	Analysiert einen Traceparent-Headerwert in eine <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 Endebeenden. Meistens möchten Sie stattdessen withSpan 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 dies den global verfügbaren aktiven Kontext festlegen. Nützlich, wenn Sie die Grenzen des SDK verlassen möchten (stellen Sie eine Anforderung oder einen Rückruf an Benutzercode vor) und können die mitSpan-API nicht verwenden.
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 behandelt die Fehleraufzeichnung sowie das Festlegen des Status auf der Spanne. Sowohl synchrone als auch asynchrone Funktionen werden erwartet, um das Ergebnis des Rückrufs auf der Spanne widerzuspiegeln. Beispiel: 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"; }, );

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 Kopfzeilen, die einer Anforderung hinzugefügt werden sollen.

parseTraceparentHeader(string)

Analysiert einen Traceparent-Headerwert in eine <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 Endebeenden.

Meistens möchten Sie stattdessen withSpan verwenden.

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

Parameter

name

string

Der Name der Spanne. In der Konvention sollte dies ${className}.${methodName}werden.

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

Ein 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 dies den global verfügbaren aktiven Kontext festlegen.

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

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 mit dem angegebenen Kontext aufgerufen werden soll, der 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 behandelt die Fehleraufzeichnung sowie das Festlegen des Status auf der Spanne.

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

Beispiel:

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<Resolved<ReturnType<Callback>>>

Parameter

name

string

Der Name der Spanne. In der Konvention sollte dies ${className}.${methodName}werden.

operationOptions

Options

Die ursprünglichen Optionen, die an die Methode übergeben werden. Der Rückruf erhält diese Optionen mit dem neu erstellten TracingContext-.

callback

Callback

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

spanOptions

TracingSpanOptions

Gibt zurück

Promise<Resolved<ReturnType<Callback>>>