TracingClient interface

Paquet:

@azure/core-tracing

Représente un client qui peut s’intégrer à l’Instrumenter actuellement configuré.

Créez une instance à l’aide de createTracingClient.

Méthodes

createRequestHeaders(TracingContext)	Crée un ensemble d’en-têtes de requête pour propager les informations de suivi à un serveur principal.
parseTraceparentHeader(string)	Analyse une valeur d’en-tête traceparent dans un <xref:TracingSpanContext>.
startSpan<Options>(string, Options, TracingSpanOptions)	Démarre une étendue donnée, mais ne la définit pas comme étendue active. Vous devez terminer l’étendue à l’aide de end. La plupart du temps, vous souhaiterez utiliser withSpan à la place.
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 disponible dans le monde entier. Utile lorsque vous souhaitez quitter les limites du SDK (effectuer une demande ou un rappel au code utilisateur) et que vous ne pouvez pas utiliser l’API withSpan .
withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)	Encapsule un rappel dans une étendue de suivi, appelle le rappel et ferme l’étendue. Il s’agit de l’interface principale pour l’utilisation du suivi et gère l’enregistrement des erreurs ainsi que la définition de l’état sur l’étendue. Les fonctions synchrones et asynchrones sont attendues afin de refléter le résultat du rappel sur l’étendue. Exemple : const myOperationResult = await tracingClient.withSpan("myClassName.myOperationName", options, (updatedOptions) => myOperation(updatedOptions));

Détails de la méthode

createRequestHeaders(TracingContext)

Crée un ensemble d’en-têtes de requête pour propager les informations de suivi à un serveur principal.

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

Paramètres

tracingContext

TracingContext

Contexte contenant l’étendue à propager.

Retours

Record<string, string>

Ensemble d’en-têtes à ajouter à une demande.

parseTraceparentHeader(string)

Analyse une valeur d’en-tête traceparent dans un <xref:TracingSpanContext>.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Paramètres

traceparentHeader

string

En-tête traceparent à analyser.

Retours

undefined | TracingContext

Identificateur spécifique à l’implémentation pour l’étendue.

startSpan<Options>(string, Options, TracingSpanOptions)

Démarre une étendue donnée, mais ne la définit pas comme étendue active.

Vous devez terminer l’étendue à l’aide de end.

La plupart du temps, vous souhaiterez utiliser withSpan à la place.

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

Paramètres

name

string

Nom de l’étendue. Par convention, il doit s’agir de ${className}.${methodName}.

operationOptions

Options

Options d’opération d’origine.

spanOptions

TracingSpanOptions

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

Retours

{ span: TracingSpan, updatedOptions: OptionsWithTracingContext<Options> }

Un tracingSpan et les options d’opération mises à jour.

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 disponible dans le monde entier.

Utile lorsque vous souhaitez quitter les limites du SDK (effectuer une demande ou un rappel au code utilisateur) et que vous ne pouvez pas utiliser l’API withSpan .

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

Paramètres

context

TracingContext

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>

withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)

Encapsule un rappel dans une étendue de suivi, appelle le rappel et ferme l’étendue.

Il s’agit de l’interface principale pour l’utilisation du suivi et gère l’enregistrement des erreurs ainsi que la définition de l’état sur l’étendue.

Les fonctions synchrones et asynchrones sont attendues afin de refléter le résultat du rappel sur l’étendue.

Exemple :

const myOperationResult = await tracingClient.withSpan("myClassName.myOperationName", options, (updatedOptions) => myOperation(updatedOptions));

function withSpan<Options, Callback>(name: string, operationOptions: Options, callback: Callback, spanOptions?: TracingSpanOptions): Promise<Resolved<ReturnType<Callback>>>

Paramètres

name

string

Nom de l’étendue. Par convention, il doit s’agir de ${className}.${methodName}.

operationOptions

Options

Options d’origine passées à la méthode . Le rappel recevra ces options avec le TracingContext nouvellement créé.

callback

Callback

Rappel à appeler avec les options mises à jour et tracingSpan nouvellement créés.

spanOptions

TracingSpanOptions

Retours

Promise<Resolved<ReturnType<Callback>>>