BaggageBuilder class
Par générateur de bagages de demande pour la propagation du contexte OpenTelemetry.
Cette classe fournit une API Fluent pour définir les valeurs de bagages qui seront propagées dans le contexte OpenTelemetry.
Exemple
const scope = new BaggageBuilder()
.tenantId("tenant-123")
.agentId("agent-456")
.build();
scope.enter();
// Baggage is set in this context
// ... do work ...
scope.exit();
// Baggage is restored after exiting the context
Méthodes
| agent |
Définissez la valeur des bagages AUID de l’agent. |
| agent |
Définissez la valeur de bagage de l’ID de blueprint de l’agent. |
| agent |
Définissez la valeur des bagages de description de l’agent. |
| agent |
Définissez la valeur des bagages par e-mail de l’agent. |
| agent |
Définissez la valeur de bagage de l’ID d’agent. |
| agent |
Définissez la valeur des bagages du nom de l’agent. |
| agent |
Définissez la valeur des bagages d’ID de plateforme de l’agent. |
| agent |
Définissez la valeur des bagages de version de l’agent. |
| build() | Appliquez les bagages collectés au contexte actuel. |
| caller |
Définissez la valeur des bagages d’ID de plateforme de l’agent appelant. |
| caller |
Définissez la valeur des bagages IP du client de l’appelant. Permet de capturer l’adresse IP du client d’origine pour la requête afin qu’elle puisse être propagée via les bagages OpenTelemetry. |
| channel |
Définissez le lien/l’URL du canal. |
| channel |
Définissez le nom du canal (par exemple, Teams, Slack). |
| conversation |
Définissez la valeur des bagages d’ID de conversation. |
| conversation |
Définissez la valeur des bagages du lien d’élément de conversation. |
| invoke |
Définit l’adresse du serveur de l’agent invoke et les valeurs des bagages de port. |
| operation |
Définissez la valeur du bagage source de l’opération. Utilisé pour les étendues de serveur pour identifier le service (par exemple, ATG, ACF). |
| session |
Définissez la valeur des bagages de description de session. |
| session |
Définissez la valeur de bagage de l’ID de session. |
| set |
Définissez plusieurs paires de bagages à partir d’un dictionnaire ou itérable. |
| set |
Méthode pratique pour commencer une étendue de bagages de requête avec des champs communs. |
| tenant |
Définissez la valeur des bagages d’ID de locataire. |
| user |
Définissez la valeur des bagages par e-mail de l’utilisateur. |
| user |
Définissez la valeur des bagages d’ID utilisateur. |
| user |
Définissez la valeur des bagages du nom d’utilisateur. |
Détails de la méthode
agentAuid(undefined | null | string)
Définissez la valeur des bagages AUID de l’agent.
function agentAuid(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
AUID de l’agent
Retours
Auto-chaînage de méthodes
agentBlueprintId(undefined | null | string)
Définissez la valeur de bagage de l’ID de blueprint de l’agent.
function agentBlueprintId(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
ID de blueprint de l’agent
Retours
Auto-chaînage de méthodes
agentDescription(undefined | null | string)
Définissez la valeur des bagages de description de l’agent.
function agentDescription(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
Description de l’agent
Retours
Auto-chaînage de méthodes
agentEmail(undefined | null | string)
Définissez la valeur des bagages par e-mail de l’agent.
function agentEmail(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
E-mail de l’agent
Retours
Auto-chaînage de méthodes
agentId(undefined | null | string)
Définissez la valeur de bagage de l’ID d’agent.
function agentId(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
ID de l’agent
Retours
Auto-chaînage de méthodes
agentName(undefined | null | string)
Définissez la valeur des bagages du nom de l’agent.
function agentName(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
Nom de l’agent
Retours
Auto-chaînage de méthodes
agentPlatformId(undefined | null | string)
Définissez la valeur des bagages d’ID de plateforme de l’agent.
function agentPlatformId(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
ID de la plateforme de l’agent
Retours
Auto-chaînage de méthodes
agentVersion(undefined | null | string)
Définissez la valeur des bagages de version de l’agent.
function agentVersion(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
Version de l’agent (par exemple, « 1.0.0 », « 2025-05-01 »)
Retours
Auto-chaînage de méthodes
build()
Appliquez les bagages collectés au contexte actuel.
function build(): BaggageScopeRetours
Gestionnaire de contexte qui restaure les bagages précédents à la sortie
callerAgentPlatformId(undefined | null | string)
Définissez la valeur des bagages d’ID de plateforme de l’agent appelant.
function callerAgentPlatformId(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
Identificateur de la plateforme de l’agent appelant
Retours
Auto-chaînage de méthodes
callerClientIp(undefined | null | string)
Définissez la valeur des bagages IP du client de l’appelant. Permet de capturer l’adresse IP du client d’origine pour la requête afin qu’elle puisse être propagée via les bagages OpenTelemetry.
function callerClientIp(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
Adresse IP du client de l’appelant
Retours
Auto-chaînage de méthodes
channelLink(undefined | null | string)
Définissez le lien/l’URL du canal.
function channelLink(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
Lien de canal
Retours
Auto-chaînage de méthodes
channelName(undefined | null | string)
Définissez le nom du canal (par exemple, Teams, Slack).
function channelName(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
Nom du canal
Retours
Auto-chaînage de méthodes
conversationId(undefined | null | string)
Définissez la valeur des bagages d’ID de conversation.
function conversationId(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
ID de conversation
Retours
Auto-chaînage de méthodes
conversationItemLink(undefined | null | string)
Définissez la valeur des bagages du lien d’élément de conversation.
function conversationItemLink(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
Lien de l’élément de conversation
Retours
Auto-chaînage de méthodes
invokeAgentServer(undefined | null | string, number)
Définit l’adresse du serveur de l’agent invoke et les valeurs des bagages de port.
function invokeAgentServer(address: undefined | null | string, port?: number): BaggageBuilderParamètres
- address
-
undefined | null | string
Adresse du serveur (nom d’hôte) du service d’agent cible.
- port
-
number
Port de serveur facultatif. Enregistré uniquement lorsqu’il est différent de 443.
Retours
Instance du générateur actuel pour le chaînage de méthodes.
operationSource(undefined | null | string)
Définissez la valeur du bagage source de l’opération. Utilisé pour les étendues de serveur pour identifier le service (par exemple, ATG, ACF).
function operationSource(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
Source de l’opération
Retours
Auto-chaînage de méthodes
sessionDescription(undefined | null | string)
Définissez la valeur des bagages de description de session.
function sessionDescription(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
Description de la session
Retours
Auto-chaînage de méthodes
sessionId(string)
Définissez la valeur de bagage de l’ID de session.
function sessionId(value: string): BaggageBuilderParamètres
- value
-
string
L’ID de session
Retours
Auto-chaînage de méthodes
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)
Définissez plusieurs paires de bagages à partir d’un dictionnaire ou itérable.
function setPairs(pairs: undefined | null | Record<string, any> | Iterable<[string, any]>): BaggageBuilderParamètres
- pairs
-
undefined | null | Record<string, any> | Iterable<[string, any]>
Dictionnaire ou itérable de paires clé-valeur
Retours
Auto-chaînage de méthodes
setRequestContext(null | string, null | string)
Méthode pratique pour commencer une étendue de bagages de requête avec des champs communs.
static function setRequestContext(tenantId?: null | string, agentId?: null | string): BaggageScopeParamètres
- tenantId
-
null | string
ID de locataire
- agentId
-
null | string
ID de l’agent
Retours
Gestionnaire de contexte qui restaure les bagages précédents à la sortie
tenantId(undefined | null | string)
Définissez la valeur des bagages d’ID de locataire.
function tenantId(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
ID de locataire
Retours
Auto-chaînage de méthodes
userEmail(undefined | null | string)
Définissez la valeur des bagages par e-mail de l’utilisateur.
function userEmail(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
E-mail de l’utilisateur
Retours
Auto-chaînage de méthodes
userId(undefined | null | string)
Définissez la valeur des bagages d’ID utilisateur.
function userId(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
ID d’utilisateur
Retours
Auto-chaînage de méthodes
userName(undefined | null | string)
Définissez la valeur des bagages du nom d’utilisateur.
function userName(value: undefined | null | string): BaggageBuilderParamètres
- value
-
undefined | null | string
Nom de l’utilisateur
Retours
Auto-chaînage de méthodes