BaggageBuilder class
Construtor de bagagem por solicitação para propagação de contexto OpenTelemetry.
Essa classe fornece uma API fluente para definir valores de bagagem 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 |
Defina o valor da bagagem AUID do agente. |
| agent |
Defina o valor da bagagem da ID do blueprint do agente. |
| agent |
Defina o valor da bagagem de descrição do agente. |
| agent |
Defina o valor da bagagem de email do agente. |
| agent |
Defina o valor da bagagem da ID do agente. |
| agent |
Defina o valor da bagagem do nome do agente. |
| agent |
Defina o valor da bagagem da ID da plataforma do agente. |
| agent |
Defina o valor da bagagem de versão do agente. |
| build() | Aplique a bagagem coletada ao contexto atual. |
| caller |
Defina o valor da bagagem da ID da plataforma do agente de chamada. |
| caller |
Defina o valor da bagagem de IP do cliente chamador. Usado para capturar o IP do cliente de origem para a solicitação para que ele possa ser propagado por meio da bagagem OpenTelemetry. |
| channel |
Defina o link/URL do canal. |
| channel |
Defina o nome do canal (por exemplo, Teams, Slack). |
| conversation |
Defina o valor da bagagem da ID da conversa. |
| conversation |
Defina o valor da bagagem do link do item de conversa. |
| invoke |
Define os valores de bagagem de porta e endereço do servidor do agente de invocação. |
| operation |
Defina o valor da bagagem de origem da operação. Usado para intervalos de servidor para identificar o serviço (por exemplo, ATG, ACF). |
| session |
Defina o valor da bagagem da descrição da sessão. |
| session |
Defina o valor da bagagem da ID da sessão. |
| set |
Defina vários pares de bagagem de um dicionário ou iterável. |
| set |
Método de conveniência para iniciar um escopo de bagagem de solicitação com campos comuns. |
| tenant |
Defina o valor da bagagem da ID do locatário. |
| user |
Defina o valor da bagagem de email do usuário. |
| user |
Defina o valor da bagagem de ID do usuário. |
| user |
Defina o valor da bagagem do nome de usuário. |
Detalhes do método
agentAuid(undefined | null | string)
Defina o valor da bagagem AUID do agente.
function agentAuid(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A AUID do agente
Retornos
Auto para encadeamento de métodos
agentBlueprintId(undefined | null | string)
Defina o valor da bagagem da ID do blueprint do agente.
function agentBlueprintId(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A ID do blueprint do agente
Retornos
Auto para encadeamento de métodos
agentDescription(undefined | null | string)
Defina o valor da bagagem de descrição do agente.
function agentDescription(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A descrição do agente
Retornos
Auto para encadeamento de métodos
agentEmail(undefined | null | string)
Defina o valor da bagagem de email do agente.
function agentEmail(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O email do agente
Retornos
Auto para encadeamento de métodos
agentId(undefined | null | string)
Defina o valor da bagagem da ID do agente.
function agentId(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A ID do agente
Retornos
Auto para encadeamento de métodos
agentName(undefined | null | string)
Defina o valor da bagagem do nome do agente.
function agentName(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O nome do agente
Retornos
Auto para encadeamento de métodos
agentPlatformId(undefined | null | string)
Defina o valor da bagagem da ID da plataforma do agente.
function agentPlatformId(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A ID da plataforma do agente
Retornos
Auto para encadeamento de métodos
agentVersion(undefined | null | string)
Defina o valor da bagagem de versão do agente.
function agentVersion(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A versão do agente (por exemplo, '1.0.0', '2025-05-01')
Retornos
Auto para encadeamento de métodos
build()
Aplique a bagagem coletada ao contexto atual.
function build(): BaggageScopeRetornos
Um gerenciador de contexto que restaura a bagagem anterior na saída
callerAgentPlatformId(undefined | null | string)
Defina o valor da bagagem da ID da plataforma do agente de chamada.
function callerAgentPlatformId(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O identificador da plataforma do agente de chamador
Retornos
Auto para encadeamento de métodos
callerClientIp(undefined | null | string)
Defina o valor da bagagem de IP do cliente chamador. Usado para capturar o IP do cliente de origem para a solicitação para que ele possa ser propagado por meio da bagagem OpenTelemetry.
function callerClientIp(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O endereço IP do cliente do chamador
Retornos
Auto para encadeamento de métodos
channelLink(undefined | null | string)
Defina o link/URL do canal.
function channelLink(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O link do canal
Retornos
Auto para encadeamento de métodos
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
Retornos
Auto para encadeamento de métodos
conversationId(undefined | null | string)
Defina o valor da bagagem da ID da conversa.
function conversationId(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A ID da conversa
Retornos
Auto para encadeamento de métodos
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
Retornos
Auto para encadeamento de métodos
invokeAgentServer(undefined | null | string, number)
Define os valores de bagagem de porta e endereço do servidor do agente de invocação.
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 do agente de destino.
- port
-
number
Porta do servidor opcional. Registrado somente quando diferente de 443.
Retornos
A instância atual do construtor para encadeamento de métodos.
operationSource(undefined | null | string)
Defina o valor da bagagem de origem da operação. Usado para intervalos de servidor para identificar o serviço (por exemplo, ATG, ACF).
function operationSource(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A origem da operação
Retornos
Auto para encadeamento de métodos
sessionDescription(undefined | null | string)
Defina o valor da bagagem da descrição da sessão.
function sessionDescription(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A descrição da sessão
Retornos
Auto para encadeamento de métodos
sessionId(string)
Defina o valor da bagagem da ID da sessão.
function sessionId(value: string): BaggageBuilderParâmetros
- value
-
string
O ID da sessão
Retornos
Auto para encadeamento de métodos
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)
Defina vários pares de bagagem 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
Retornos
Auto para encadeamento de métodos
setRequestContext(null | string, null | string)
Método de conveniência para iniciar um escopo de bagagem de solicitação com campos comuns.
static function setRequestContext(tenantId?: null | string, agentId?: null | string): BaggageScopeParâmetros
- tenantId
-
null | string
A ID do locatário
- agentId
-
null | string
A ID do agente
Retornos
Um gerenciador de contexto que restaura a bagagem anterior na saída
tenantId(undefined | null | string)
Defina o valor da bagagem da ID do locatário.
function tenantId(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A ID do locatário
Retornos
Auto para encadeamento de métodos
userEmail(undefined | null | string)
Defina o valor da bagagem de email do usuário.
function userEmail(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O email do usuário
Retornos
Auto para encadeamento de métodos
userId(undefined | null | string)
Defina o valor da bagagem de ID do usuário.
function userId(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A ID do usuário
Retornos
Auto para encadeamento de métodos
userName(undefined | null | string)
Defina o valor da bagagem do nome de usuário.
function userName(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O nome de usuário
Retornos
Auto para encadeamento de métodos