BaggageBuilder class
Per anmodning bagage builder for OpenTelemetry kontekstoverførsel.
Denne klasse indeholder en flydende API til angivelse af bagageværdier, der overføres i OpenTelemetry-konteksten.
Eksempel
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
Metoder
| agent |
Angiv agentens AUID-bagageværdi. |
| agent |
Angiv værdien for agentens blueprint-id for bagage. |
| agent |
Angiv bagageværdien for beskrivelsen af agenten. |
| agent |
Angiv værdien for agentens e-mailbagage. |
| agent |
Angiv bagageværdien for agent-id'et. |
| agent |
Angiv bagageværdien for agentnavnet. |
| agent |
Angiv bagageværdien for agentplatformens platform-id. |
| agent |
Angiv bagageværdien for agentversionen. |
| build() | Anvend den indsamlede bagage i den aktuelle kontekst. |
| caller |
Angiv bagageværdien for opkaldsagentens platform-id. |
| caller |
Angiv værdien for klient-IP-bagagen for den kaldende klient. Bruges til at registrere den oprindelige klient-IP for anmodningen, så den kan overføres via OpenTelemetry-bagage. |
| channel |
Angiv kanallinket/URL-adressen. |
| channel |
Angiv kanalnavnet (f.eks. Teams, Slack). |
| conversation |
Angiv bagageværdien for samtale-id'et. |
| conversation |
Angiv bagageværdien for samtaleelementets link. |
| invoke |
Angiver værdier for aktiv agentserveradresse og portbagage. |
| operation |
Angiv bagageværdien for operationskilden. Bruges til serverområder til at identificere tjenesten (f.eks. ATG, ACF). |
| session |
Angiv bagageværdien for sessionsbeskrivelsen. |
| session |
Angiv bagageværdien for sessions-id'et. |
| set |
Sæt flere bagagepar fra en ordbog eller iterable. |
| set |
Praktisk metode til at starte en anmodning om bagageomfang med fælles felter. |
| tenant |
Angiv bagageværdien for lejer-id'et. |
| user |
Angiv værdien for brugerens e-mail-bagage. |
| user |
Angiv værdien for bruger-id-bagagen. |
| user |
Angiv værdien for brugernavnets bagage. |
Oplysninger om metode
agentAuid(undefined | null | string)
Angiv agentens AUID-bagageværdi.
function agentAuid(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Agentens AUID
Returnerer
Selv for metodekæde
agentBlueprintId(undefined | null | string)
Angiv værdien for agentens blueprint-id for bagage.
function agentBlueprintId(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Agentens kursusplan-id
Returnerer
Selv for metodekæde
agentDescription(undefined | null | string)
Angiv bagageværdien for beskrivelsen af agenten.
function agentDescription(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Agentbeskrivelsen
Returnerer
Selv for metodekæde
agentEmail(undefined | null | string)
Angiv værdien for agentens e-mailbagage.
function agentEmail(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Agentens mail
Returnerer
Selv for metodekæde
agentId(undefined | null | string)
Angiv bagageværdien for agent-id'et.
function agentId(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Agent-id'et
Returnerer
Selv for metodekæde
agentName(undefined | null | string)
Angiv bagageværdien for agentnavnet.
function agentName(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Agentnavnet
Returnerer
Selv for metodekæde
agentPlatformId(undefined | null | string)
Angiv bagageværdien for agentplatformens platform-id.
function agentPlatformId(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Agentplatforms-id'et
Returnerer
Selv for metodekæde
agentVersion(undefined | null | string)
Angiv bagageværdien for agentversionen.
function agentVersion(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Agentversionen (f.eks. '1.0.0', '2025-05-01')
Returnerer
Selv for metodekæde
build()
Anvend den indsamlede bagage i den aktuelle kontekst.
function build(): BaggageScopeReturnerer
En kontekstadministrator, der gendanner den forrige bagage ved afslutning
callerAgentPlatformId(undefined | null | string)
Angiv bagageværdien for opkaldsagentens platform-id.
function callerAgentPlatformId(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Platform-id'et for kalderagenten
Returnerer
Selv for metodekæde
callerClientIp(undefined | null | string)
Angiv værdien for klient-IP-bagagen for den kaldende klient. Bruges til at registrere den oprindelige klient-IP for anmodningen, så den kan overføres via OpenTelemetry-bagage.
function callerClientIp(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Klientens IP-adresse til kalderen
Returnerer
Selv for metodekæde
channelLink(undefined | null | string)
Angiv kanallinket/URL-adressen.
function channelLink(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Kanallinket
Returnerer
Selv for metodekæde
channelName(undefined | null | string)
Angiv kanalnavnet (f.eks. Teams, Slack).
function channelName(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Kanalnavnet
Returnerer
Selv for metodekæde
conversationId(undefined | null | string)
Angiv bagageværdien for samtale-id'et.
function conversationId(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Samtale-id'et
Returnerer
Selv for metodekæde
conversationItemLink(undefined | null | string)
Angiv bagageværdien for samtaleelementets link.
function conversationItemLink(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Linket til samtaleelementet
Returnerer
Selv for metodekæde
invokeAgentServer(undefined | null | string, number)
Angiver værdier for aktiv agentserveradresse og portbagage.
function invokeAgentServer(address: undefined | null | string, port?: number): BaggageBuilderParametre
- address
-
undefined | null | string
Serveradressen (værtsnavn) for destinationsagenttjenesten.
- port
-
number
Valgfri serverport. Registreres kun, når den er forskellig fra 443.
Returnerer
Den aktuelle generatorforekomst for metodekæde.
operationSource(undefined | null | string)
Angiv bagageværdien for operationskilden. Bruges til serverområder til at identificere tjenesten (f.eks. ATG, ACF).
function operationSource(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Handlingskilden
Returnerer
Selv for metodekæde
sessionDescription(undefined | null | string)
Angiv bagageværdien for sessionsbeskrivelsen.
function sessionDescription(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Sessionsbeskrivelsen
Returnerer
Selv for metodekæde
sessionId(string)
Angiv bagageværdien for sessions-id'et.
function sessionId(value: string): BaggageBuilderParametre
- value
-
string
Sessions-id'et
Returnerer
Selv for metodekæde
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)
Sæt flere bagagepar fra en ordbog eller iterable.
function setPairs(pairs: undefined | null | Record<string, any> | Iterable<[string, any]>): BaggageBuilderParametre
- pairs
-
undefined | null | Record<string, any> | Iterable<[string, any]>
Ordbog eller gentagelse af nøgleværdipar
Returnerer
Selv for metodekæde
setRequestContext(null | string, null | string)
Praktisk metode til at starte en anmodning om bagageomfang med fælles felter.
static function setRequestContext(tenantId?: null | string, agentId?: null | string): BaggageScopeParametre
- tenantId
-
null | string
Lejer-id'et
- agentId
-
null | string
Agent-id'et
Returnerer
En kontekstadministrator, der gendanner den forrige bagage ved afslutning
tenantId(undefined | null | string)
Angiv bagageværdien for lejer-id'et.
function tenantId(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Lejer-id'et
Returnerer
Selv for metodekæde
userEmail(undefined | null | string)
Angiv værdien for brugerens e-mail-bagage.
function userEmail(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Brugermailen
Returnerer
Selv for metodekæde
userId(undefined | null | string)
Angiv værdien for bruger-id-bagagen.
function userId(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Bruger-id'et
Returnerer
Selv for metodekæde
userName(undefined | null | string)
Angiv værdien for brugernavnets bagage.
function userName(value: undefined | null | string): BaggageBuilderParametre
- value
-
undefined | null | string
Brugernavnet
Returnerer
Selv for metodekæde