Instrumenter interface

Paket:

@azure/core-tracing

Stellt einen implementierungsunabhängigen Instrumentierer dar.

Methoden

createRequestHeaders(TracingContext)	Stellt eine implementierungsspezifische Methode zum Serialisieren eines TracingSpan in einen Satz von Headern bereit.
parseTraceparentHeader(string)	Stellt eine implementierungsspezifische Methode zum Analysieren eines in https://www.w3.org/TR/trace-context/#traceparent-header eine bereit <xref:TracingSpanContext> , die verwendet werden kann, um nicht übergeordnete Spannen miteinander zu verknüpfen.
startSpan(string, InstrumenterSpanOptions)	Erstellt eine neue TracingSpan mit dem angegebenen Namen und den angegebenen Optionen und legt sie 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 dadurch der global verfügbare aktive Kontext festgelegt werden.

Details zur Methode

createRequestHeaders(TracingContext)

Stellt eine implementierungsspezifische Methode zum Serialisieren eines TracingSpan in einen Satz 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 zum Analysieren eines in https://www.w3.org/TR/trace-context/#traceparent-header eine bereit <xref:TracingSpanContext> , die verwendet werden kann, um nicht übergeordnete Spannen miteinander zu verknüpfen.

function parseTraceparentHeader(traceparentHeader: string): TracingContext | undefined

Parameter

traceparentHeader

string

Gibt zurück

TracingContext | undefined

startSpan(string, InstrumenterSpanOptions)

Erstellt eine neue TracingSpan mit dem angegebenen Namen und den angegebenen Optionen und legt sie in einem neuen Kontext fest.

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

Parameter

name

string

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

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 den 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 dadurch der global verfügbare aktive Kontext festgelegt werden.

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>