Instrumenter interface

Paket:

@azure/core-tracing

Stellt einen implementierungsagnostischen Instrumentierer dar.

Methoden

createRequestHeaders(TracingContext)	Stellt eine implementierungsspezifische Methode zum Serialisieren eines TracingSpan- zu einer Reihe von Headern bereit.
parseTraceparentHeader(string)	Stellt eine implementierungsspezifische Methode bereit, um eine https://www.w3.org/TR/trace-context/#traceparent-header in eine <xref:TracingSpanContext> zu analysieren, die zum Verknüpfen nicht übergeordneter Bereiche verwendet werden kann.
startSpan(string, InstrumenterSpanOptions)	Erstellt einen neuen TracingSpan- mit dem angegebenen Namen und den Optionen und legt ihn in einem neuen Kontext fest.
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.

Details zur Methode

createRequestHeaders(TracingContext)

Stellt eine implementierungsspezifische Methode zum Serialisieren eines TracingSpan- zu einer Reihe von Headern bereit.

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

Parameter

tracingContext

TracingContext

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

Gibt zurück

Record<string, string>

parseTraceparentHeader(string)

Stellt eine implementierungsspezifische Methode bereit, um eine https://www.w3.org/TR/trace-context/#traceparent-header in eine <xref:TracingSpanContext> zu analysieren, die zum Verknüpfen nicht übergeordneter Bereiche verwendet werden kann.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Parameter

traceparentHeader

string

Gibt zurück

undefined | TracingContext

startSpan(string, InstrumenterSpanOptions)

Erstellt einen neuen TracingSpan- mit dem angegebenen Namen und den Optionen und legt ihn in einem neuen Kontext fest.

function startSpan(name: string, spanOptions: InstrumenterSpanOptions): { span: TracingSpan, tracingContext: TracingContext }

Parameter

name

string

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

spanOptions

InstrumenterSpanOptions

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

Gibt zurück

{ span: TracingSpan, tracingContext: TracingContext }

Eine TracingSpan-, die verwendet werden kann, um die Spanne zu beenden, und der Kontext, für den diese Spanne festgelegt wurde.

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.

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>