BaggageBuilder class

Paquet:

@microsoft/agents-a365-observability

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")
  .correlationId("corr-789")
  .build();

scope.enter();
// Baggage is set in this context
// ... do work ...
scope.exit();
// Baggage is restored after exiting the context

Méthodes

agentAuid(undefined | null | string)	Définissez la valeur des bagages AUID de l’agent.
agentBlueprintId(undefined | null | string)	Définissez la valeur de bagage de l’ID de blueprint de l’agent.
agentDescription(undefined | null | string)	Définissez la valeur des bagages de description de l’agent.
agentId(undefined | null | string)	Définissez la valeur de bagage de l’ID d’agent.
agentName(undefined | null | string)	Définissez la valeur des bagages du nom de l’agent.
agentUpn(undefined | null | string)	Définissez la valeur des bagages UPN de l’agent.
build()	Appliquez les bagages collectés au contexte actuel.
callerId(undefined | null | string)	Définissez la valeur des bagages id de l’appelant.
callerName(undefined | null | string)	Définissez la valeur des bagages du nom de l’appelant.
callerUpn(undefined | null | string)	Définissez la valeur des bagages UPN de l’appelant.
conversationId(undefined | null | string)	Définissez la valeur des bagages d’ID de conversation.
conversationItemLink(undefined | null | string)	Définissez la valeur des bagages du lien d’élément de conversation.
correlationId(undefined | null | string)	Définissez la valeur de bagage d’ID de corrélation.
hiringManagerId(undefined | null | string)	Définissez la valeur des bagages id du gestionnaire d’embauche.
operationSource(undefined | null | string)	Définissez la valeur du bagage source de l’opération.
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)	Définissez plusieurs paires de bagages à partir d’un dictionnaire ou itérable.
setRequestContext(null | string, null | string, null | string)	Méthode pratique pour commencer une étendue de bagages de requête avec des champs communs.
sourceMetadataDescription(undefined | null | string)	Définissez la description des métadonnées de la source d’exécution (par exemple, description du canal).
sourceMetadataId(undefined | null | string)	Définissez l’ID de métadonnées source d’exécution (par exemple, l’ID de canal).
sourceMetadataName(undefined | null | string)	Définissez le nom des métadonnées de la source d’exécution (par exemple, le nom du canal).
tenantId(undefined | null | string)	Définissez la valeur des bagages d’ID de locataire.

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): BaggageBuilder

Paramètres

value

undefined | null | string

AUID de l’agent

Retours

BaggageBuilder

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): BaggageBuilder

Paramètres

value

undefined | null | string

ID de blueprint de l’agent

Retours

BaggageBuilder

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): BaggageBuilder

Paramètres

value

undefined | null | string

Description de l’agent

Retours

BaggageBuilder

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): BaggageBuilder

Paramètres

value

undefined | null | string

ID de l’agent

Retours

BaggageBuilder

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): BaggageBuilder

Paramètres

value

undefined | null | string

Nom de l’agent

Retours

BaggageBuilder

Auto-chaînage de méthodes

agentUpn(undefined | null | string)

Définissez la valeur des bagages UPN de l’agent.

function agentUpn(value: undefined | null | string): BaggageBuilder

Paramètres

value

undefined | null | string

UPN de l’agent

Retours

BaggageBuilder

Auto-chaînage de méthodes

build()

Appliquez les bagages collectés au contexte actuel.

function build(): BaggageScope

Retours

BaggageScope

Gestionnaire de contexte qui restaure les bagages précédents à la sortie

callerId(undefined | null | string)

Définissez la valeur des bagages id de l’appelant.

function callerId(value: undefined | null | string): BaggageBuilder

Paramètres

value

undefined | null | string

ID de l’appelant

Retours

BaggageBuilder

Auto-chaînage de méthodes

callerName(undefined | null | string)

Définissez la valeur des bagages du nom de l’appelant.

function callerName(value: undefined | null | string): BaggageBuilder

Paramètres

value

undefined | null | string

Nom de l’appelant

Retours

BaggageBuilder

Auto-chaînage de méthodes

callerUpn(undefined | null | string)

Définissez la valeur des bagages UPN de l’appelant.

function callerUpn(value: undefined | null | string): BaggageBuilder

Paramètres

value

undefined | null | string

UPN de l’appelant

Retours

BaggageBuilder

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): BaggageBuilder

Paramètres

value

undefined | null | string

ID de conversation

Retours

BaggageBuilder

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): BaggageBuilder

Paramètres

value

undefined | null | string

Lien de l’élément de conversation

Retours

BaggageBuilder

Auto-chaînage de méthodes

correlationId(undefined | null | string)

Définissez la valeur de bagage d’ID de corrélation.

function correlationId(value: undefined | null | string): BaggageBuilder

Paramètres

value

undefined | null | string

ID de corrélation

Retours

BaggageBuilder

Auto-chaînage de méthodes

hiringManagerId(undefined | null | string)

Définissez la valeur des bagages id du gestionnaire d’embauche.

function hiringManagerId(value: undefined | null | string): BaggageBuilder

Paramètres

value

undefined | null | string

ID du responsable d’embauche

Retours

BaggageBuilder

Auto-chaînage de méthodes

operationSource(undefined | null | string)

Définissez la valeur du bagage source de l’opération.

function operationSource(value: undefined | null | string): BaggageBuilder

Paramètres

value

undefined | null | string

Valeur de la source de l’opération

Retours

BaggageBuilder

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]>): BaggageBuilder

Paramètres

pairs

undefined | null | Record<string, any> | Iterable<[string, any]>

Dictionnaire ou itérable de paires clé-valeur

Retours

BaggageBuilder

Auto-chaînage de méthodes

setRequestContext(null | string, 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, correlationId?: null | string): BaggageScope

Paramètres

tenantId

null | string

ID de locataire

agentId

null | string

ID de l’agent

correlationId

null | string

ID de corrélation

Retours

BaggageScope

Gestionnaire de contexte qui restaure les bagages précédents à la sortie

sourceMetadataDescription(undefined | null | string)

Définissez la description des métadonnées de la source d’exécution (par exemple, description du canal).

function sourceMetadataDescription(value: undefined | null | string): BaggageBuilder

Paramètres

value

undefined | null | string

Description des métadonnées sources

Retours

BaggageBuilder

Auto-chaînage de méthodes

sourceMetadataId(undefined | null | string)

Définissez l’ID de métadonnées source d’exécution (par exemple, l’ID de canal).

function sourceMetadataId(value: undefined | null | string): BaggageBuilder

Paramètres

value

undefined | null | string

ID des métadonnées sources

Retours

BaggageBuilder

Auto-chaînage de méthodes

sourceMetadataName(undefined | null | string)

Définissez le nom des métadonnées de la source d’exécution (par exemple, le nom du canal).

function sourceMetadataName(value: undefined | null | string): BaggageBuilder

Paramètres

value

undefined | null | string

Nom des métadonnées sources

Retours

BaggageBuilder

Auto-chaînage de méthodes

tenantId(undefined | null | string)

Définissez la valeur des bagages d’ID de locataire.

function tenantId(value: undefined | null | string): BaggageBuilder

Paramètres

value

undefined | null | string

ID de locataire

Retours

BaggageBuilder

Auto-chaînage de méthodes