BaggageBuilder class
Construtor de bagagens por pedido para propagação de contexto OpenTelemetry.
Esta classe fornece uma API fluente para definir valores de bagage que serão propagados no contexto OpenTelemetry.
Exemplo
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étodos
| agent |
Define o valor da bagagem AUID do agente. |
| agent |
Define o valor da bagagem do ID do blueprint do agente. |
| agent |
Defina a descrição do valor da bagagem do agente. |
| agent |
Defina o valor da bagagem do email do agente. |
| agent |
Defina o valor da bagagem do identificador do agente. |
| agent |
Defina o nome do agente como valor de bagagem. |
| agent |
Defina o valor da bagagem do ID da plataforma do agente. |
| agent |
Defina o valor da bagagem da versão do agente. |
| build() | Aplique a bagagem recolhida ao contexto atual. |
| caller |
Defina o valor da bagagem do identificador do agente de chamadas. |
| caller |
Defina o valor de bagagem do IP do cliente do chamador. Usado para capturar o IP do cliente de origem para o pedido, para que possa ser propagado através do OpenTelemetry bagone. |
| channel |
Define o link/URL do canal. |
| channel |
Defina o nome do canal (por exemplo, Teams, Slack). |
| conversation |
Defina o valor da bagagem do ID da conversa. |
| conversation |
Defina o valor da bagagem do link do item de conversa. |
| invoke |
Define o endereço do servidor do agente invocar e os valores de bagagem da porta. |
| operation |
Defina o valor de bagagem da fonte da operação. Usado para spans de servidor para identificar o serviço (por exemplo, ATG, ACF). |
| session |
Define o valor de bagagem da descrição da sessão. |
| session |
Defina o valor da bagagem do ID da sessão. |
| set |
Defina múltiplos pares de bagagem a partir de um dicionário ou iterável. |
| set |
Método prático para iniciar um escopo de bagagem de pedido com campos comuns. |
| tenant |
Defina o valor da bagagem do ID do inquilino. |
| user |
Defina o valor de bagagem do email do utilizador. |
| user |
Defina o valor da bagagem do ID de utilizador. |
| user |
Defina o valor de bagagem do nome de utilizador. |
Detalhes de Método
agentAuid(undefined | null | string)
Define o valor da bagagem AUID do agente.
function agentAuid(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O agente AUID
Devoluções
Auto para encadeamento de método
agentBlueprintId(undefined | null | string)
Define o valor da bagagem do ID do blueprint do agente.
function agentBlueprintId(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O ID do plano do agente
Devoluções
Auto para encadeamento de método
agentDescription(undefined | null | string)
Defina a descrição do valor da bagagem do agente.
function agentDescription(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A descrição do agente
Devoluções
Auto para encadeamento de método
agentEmail(undefined | null | string)
Defina o valor da bagagem do email do agente.
function agentEmail(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O email do agente
Devoluções
Auto para encadeamento de método
agentId(undefined | null | string)
Defina o valor da bagagem do identificador do agente.
function agentId(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O ID do agente
Devoluções
Auto para encadeamento de método
agentName(undefined | null | string)
Defina o nome do agente como valor de bagagem.
function agentName(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O nome do agente
Devoluções
Auto para encadeamento de método
agentPlatformId(undefined | null | string)
Defina o valor da bagagem do ID da plataforma do agente.
function agentPlatformId(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O ID da plataforma do agente
Devoluções
Auto para encadeamento de método
agentVersion(undefined | null | string)
Defina o valor da bagagem da versão do agente.
function agentVersion(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A versão agente (por exemplo, '1.0.0', '2025-05-01')
Devoluções
Auto para encadeamento de método
build()
Aplique a bagagem recolhida ao contexto atual.
function build(): BaggageScopeDevoluções
Um gestor de contexto que restaura a bagagem anterior na saída
callerAgentPlatformId(undefined | null | string)
Defina o valor da bagagem do identificador do agente de chamadas.
function callerAgentPlatformId(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O identificador da plataforma do agente de chamadas
Devoluções
Auto para encadeamento de método
callerClientIp(undefined | null | string)
Defina o valor de bagagem do IP do cliente do chamador. Usado para capturar o IP do cliente de origem para o pedido, para que possa ser propagado através do OpenTelemetry bagone.
function callerClientIp(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O endereço IP do cliente do chamador
Devoluções
Auto para encadeamento de método
channelLink(undefined | null | string)
Define o link/URL do canal.
function channelLink(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A ligação ao canal
Devoluções
Auto para encadeamento de método
channelName(undefined | null | string)
Defina o nome do canal (por exemplo, Teams, Slack).
function channelName(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O nome do canal
Devoluções
Auto para encadeamento de método
conversationId(undefined | null | string)
Defina o valor da bagagem do ID da conversa.
function conversationId(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O ID da conversa
Devoluções
Auto para encadeamento de método
conversationItemLink(undefined | null | string)
Defina o valor da bagagem do link do item de conversa.
function conversationItemLink(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O link do item de conversa
Devoluções
Auto para encadeamento de método
invokeAgentServer(undefined | null | string, number)
Define o endereço do servidor do agente invocar e os valores de bagagem da porta.
function invokeAgentServer(address: undefined | null | string, port?: number): BaggageBuilderParâmetros
- address
-
undefined | null | string
O endereço do servidor (nome do host) do serviço agente de destino.
- port
-
number
Porta opcional para servidores. Só gravado quando diferente do 443.
Devoluções
A instância atual do construtor para cadeia de métodos.
operationSource(undefined | null | string)
Defina o valor de bagagem da fonte da operação. Usado para spans de servidor para identificar o serviço (por exemplo, ATG, ACF).
function operationSource(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A fonte da operação
Devoluções
Auto para encadeamento de método
sessionDescription(undefined | null | string)
Define o valor de bagagem da descrição da sessão.
function sessionDescription(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
Descrição da sessão
Devoluções
Auto para encadeamento de método
sessionId(string)
Defina o valor da bagagem do ID da sessão.
function sessionId(value: string): BaggageBuilderParâmetros
- value
-
string
O ID da sessão
Devoluções
Auto para encadeamento de método
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)
Defina múltiplos pares de bagagem a partir de um dicionário ou iterável.
function setPairs(pairs: undefined | null | Record<string, any> | Iterable<[string, any]>): BaggageBuilderParâmetros
- pairs
-
undefined | null | Record<string, any> | Iterable<[string, any]>
Dicionário ou iterável de pares-chave-valor
Devoluções
Auto para encadeamento de método
setRequestContext(null | string, null | string)
Método prático para iniciar um escopo de bagagem de pedido com campos comuns.
static function setRequestContext(tenantId?: null | string, agentId?: null | string): BaggageScopeParâmetros
- tenantId
-
null | string
O ID do inquilino
- agentId
-
null | string
O ID do agente
Devoluções
Um gestor de contexto que restaura a bagagem anterior na saída
tenantId(undefined | null | string)
Defina o valor da bagagem do ID do inquilino.
function tenantId(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O ID do inquilino
Devoluções
Auto para encadeamento de método
userEmail(undefined | null | string)
Defina o valor de bagagem do email do utilizador.
function userEmail(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O email do utilizador
Devoluções
Auto para encadeamento de método
userId(undefined | null | string)
Defina o valor da bagagem do ID de utilizador.
function userId(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O ID de utilizador
Devoluções
Auto para encadeamento de método
userName(undefined | null | string)
Defina o valor de bagagem do nome de utilizador.
function userName(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O nome de utilizador
Devoluções
Auto para encadeamento de método