Instrumenter interface

Paquet:

@azure/core-tracing

Représente un instrumenteur indépendant de l’implémentation.

Méthodes

createRequestHeaders(TracingContext)	Fournit une méthode spécifique à l’implémentation pour sérialiser un TracingSpan à un ensemble d’en-têtes.
parseTraceparentHeader(string)	Fournit une méthode spécifique à l’implémentation pour analyser un https://www.w3.org/TR/trace-context/#traceparent-header dans un <xref:TracingSpanContext> qui peut être utilisé pour lier des étendues non parentées ensemble.
startSpan(string, InstrumenterSpanOptions)	Crée un TracingSpan avec le nom et les options donnés et les définit sur un nouveau contexte.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)	Encapsule un rappel avec un contexte actif et appelle le rappel. Selon l’implémentation, cela peut définir le contexte actif globalement disponible.

Détails de la méthode

createRequestHeaders(TracingContext)

Fournit une méthode spécifique à l’implémentation pour sérialiser un TracingSpan à un ensemble d’en-têtes.

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

Paramètres

tracingContext

TracingContext

Contexte contenant l’étendue à sérialiser.

Retours

Record<string, string>

parseTraceparentHeader(string)

Fournit une méthode spécifique à l’implémentation pour analyser un https://www.w3.org/TR/trace-context/#traceparent-header dans un <xref:TracingSpanContext> qui peut être utilisé pour lier des étendues non parentées ensemble.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Paramètres

traceparentHeader

string

Retours

undefined | TracingContext

startSpan(string, InstrumenterSpanOptions)

Crée un TracingSpan avec le nom et les options donnés et les définit sur un nouveau contexte.

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

Paramètres

name

string

Nom de l’étendue. Par convention, cela devrait être ${className}.${methodName}.

spanOptions

InstrumenterSpanOptions

Options à utiliser lors de la création de l’étendue.

Retours

{ span: TracingSpan, tracingContext: TracingContext }

Un TracingSpan qui peut être utilisé pour mettre fin à l’étendue, et le contexte sur lequel cette étendue a été définie.

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

Encapsule un rappel avec un contexte actif et appelle le rappel. Selon l’implémentation, cela peut définir le contexte actif globalement disponible.

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

Paramètres

context

TracingContext

Le TracingContext à utiliser comme contexte actif dans l’étendue du rappel.

callback

Callback

Rappel à appeler avec le contexte donné défini comme contexte global actif.

callbackArgs

CallbackArgs

Arguments de rappel.

Retours

ReturnType<Callback>