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")
.correlationId("corr-789")
.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 da ID do agente. |
| agent |
Defina o valor da bagagem do nome do agente. |
| agent |
Defina o valor da bagagem UPN do agente. |
| build() | Aplique a bagagem coletada ao contexto atual. |
| caller |
Defina o valor da bagagem da ID do chamador. |
| caller |
Defina o valor da bagagem do nome do chamador. |
| caller |
Defina o valor da bagagem UPN do chamador. |
| conversation |
Defina o valor da bagagem da ID da conversa. |
| conversation |
Defina o valor da bagagem do link do item de conversa. |
| correlation |
Defina o valor da bagagem da ID de correlação. |
| hiring |
Defina o valor da bagagem da ID do gerente de contratação. |
| operation |
Defina o valor da bagagem de origem da operaçã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. |
| source |
Defina a descrição dos metadados de origem da execução (por exemplo, descrição do canal). |
| source |
Defina a ID de metadados de origem da execução (por exemplo, ID do canal). |
| source |
Defina o nome dos metadados de origem da execução (por exemplo, nome do canal). |
| tenant |
Defina o valor da bagagem da ID do locatá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
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
agentUpn(undefined | null | string)
Defina o valor da bagagem UPN do agente.
function agentUpn(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O UPN do agente
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
callerId(undefined | null | string)
Defina o valor da bagagem da ID do chamador.
function callerId(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A ID do chamador
Retornos
Auto para encadeamento de métodos
callerName(undefined | null | string)
Defina o valor da bagagem do nome do chamador.
function callerName(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O nome do chamador
Retornos
Auto para encadeamento de métodos
callerUpn(undefined | null | string)
Defina o valor da bagagem UPN do chamador.
function callerUpn(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O UPN do chamador
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
correlationId(undefined | null | string)
Defina o valor da bagagem da ID de correlação.
function correlationId(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A ID de correlação
Retornos
Auto para encadeamento de métodos
hiringManagerId(undefined | null | string)
Defina o valor da bagagem da ID do gerente de contratação.
function hiringManagerId(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A ID do gerente de contratação
Retornos
Auto para encadeamento de métodos
operationSource(undefined | null | string)
Defina o valor da bagagem de origem da operação.
function operationSource(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O valor de origem da operaçã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, 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, correlationId?: null | string): BaggageScopeParâmetros
- tenantId
-
null | string
A ID do locatário
- agentId
-
null | string
A ID do agente
- correlationId
-
null | string
A ID de correlação
Retornos
Um gerenciador de contexto que restaura a bagagem anterior na saída
sourceMetadataDescription(undefined | null | string)
Defina a descrição dos metadados de origem da execução (por exemplo, descrição do canal).
function sourceMetadataDescription(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A descrição dos metadados de origem
Retornos
Auto para encadeamento de métodos
sourceMetadataId(undefined | null | string)
Defina a ID de metadados de origem da execução (por exemplo, ID do canal).
function sourceMetadataId(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
A ID de metadados de origem
Retornos
Auto para encadeamento de métodos
sourceMetadataName(undefined | null | string)
Defina o nome dos metadados de origem da execução (por exemplo, nome do canal).
function sourceMetadataName(value: undefined | null | string): BaggageBuilderParâmetros
- value
-
undefined | null | string
O nome dos metadados de origem
Retornos
Auto para encadeamento de métodos
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