Condividi tramite

Instrumenter interface

  • Riferimento
Pacchetto:
@azure/core-tracing

Rappresenta uno strumento indipendente dall'implementazione.

Metodi

createRequestHeaders(TracingContext)

Fornisce un metodo specifico dell'implementazione per serializzare un oggetto TracingSpan in un set di intestazioni.
parseTraceparentHeader(string)

Fornisce un metodo specifico dell'implementazione per analizzare un https://www.w3.org/TR/trace-context/#traceparent-header oggetto in un <xref:TracingSpanContext> oggetto che può essere usato per collegare gli intervalli non padre tra loro.
startSpan(string, InstrumenterSpanOptions)

Crea un nuovo oggetto TracingSpan con il nome e le opzioni specificati e lo imposta in un nuovo contesto.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)

Esegue il wrapping di un callback con un contesto attivo e chiama il callback. A seconda dell'implementazione, questo può impostare il contesto attivo disponibile a livello globale.

Dettagli metodo

createRequestHeaders(TracingContext)

Fornisce un metodo specifico dell'implementazione per serializzare un oggetto TracingSpan in un set di intestazioni.

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

Parametri

tracingContext
TracingContext

Contesto contenente l'intervallo da serializzare.

Restituisce

Record<string, string>

parseTraceparentHeader(string)

Fornisce un metodo specifico dell'implementazione per analizzare un https://www.w3.org/TR/trace-context/#traceparent-header oggetto in un <xref:TracingSpanContext> oggetto che può essere usato per collegare gli intervalli non padre tra loro.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Parametri

traceparentHeader

string

Restituisce

undefined | TracingContext

startSpan(string, InstrumenterSpanOptions)

Crea un nuovo oggetto TracingSpan con il nome e le opzioni specificati e lo imposta in un nuovo contesto.

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

Parametri

name

string

Nome dell'intervallo. Per convenzione, deve essere ${className}.${methodName}.

spanOptions
InstrumenterSpanOptions

Opzioni da utilizzare durante la creazione dell'intervallo.

Restituisce

{ span: TracingSpan, tracingContext: TracingContext }

Oggetto TracingSpan che può essere usato per terminare l'intervallo e il contesto su cui è stato impostato l'intervallo.

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

Esegue il wrapping di un callback con un contesto attivo e chiama il callback. A seconda dell'implementazione, questo può impostare il contesto attivo disponibile a livello globale.

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

Parametri

context
TracingContext

TracingContext da usare come contesto attivo nell'ambito del callback.

callback

Callback

Callback da richiamare con il contesto specificato impostato come contesto attivo a livello globale.

callbackArgs

CallbackArgs

Argomenti di callback.

Restituisce

ReturnType<Callback>