BaggageBuilder class
Per aanvraag bagagebouwer voor doorgifte van openTelemetry-context.
Deze klasse biedt een fluent-API voor het instellen van bagagewaarden die worden doorgegeven in de OpenTelemetry-context.
Voorbeeld
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
Methoden
| agent |
Stel de AUID-bagagewaarde van de agent in. |
| agent |
Stel de waarde voor de blauwdruk-id van de agent in. |
| agent |
Stel de waarde voor bagage van de agent in. |
| agent |
Stel de waarde voor e-mailbagage van de agent in. |
| agent |
Stel de waarde voor bagage van de agent-id in. |
| agent |
Stel de waarde voor bagage van de agent in. |
| agent |
Stel de waarde voor bagage voor het platform-id van de agent in. |
| agent |
Stel de bagagewaarde van de agentversie in. |
| build() | Pas de verzamelde bagage toe op de huidige context. |
| caller |
Stel de waarde voor het platform-id van de belleragent in. |
| caller |
Stel de waarde van de client-IP-bagage van de beller in. Wordt gebruikt om het IP-adres van de oorspronkelijke client voor de aanvraag vast te leggen, zodat deze kan worden doorgegeven via OpenTelemetry-bagage. |
| channel |
Stel de kanaalkoppeling/-URL in. |
| channel |
Stel de naam van het kanaal in (bijvoorbeeld Teams, Slack). |
| conversation |
Stel de bagagewaarde van de gespreks-id in. |
| conversation |
Stel de waarde voor het koppelen van bagage voor het gespreksitem in. |
| invoke |
Hiermee stelt u het adres van de agentserver en de poortbagagewaarden in. |
| operation |
Stel de waarde van de bronbagage van de bewerking in. Wordt gebruikt voor serverbereiken om de service te identificeren (bijvoorbeeld ATG, ACF). |
| session |
Stel de waarde voor bagage voor de sessiebeschrijving in. |
| session |
Stel de bagagewaarde van de sessie-id in. |
| set |
Stel meerdere bagageparen in vanuit een woordenlijst of iterable. |
| set |
Gemaksmethode voor het starten van een aanvraagbagagebereik met algemene velden. |
| tenant |
Stel de bagagewaarde van de tenant-id in. |
| user |
Stel de waarde voor e-mailbagage van de gebruiker in. |
| user |
Stel de bagagewaarde van de gebruikers-id in. |
| user |
Stel de waarde voor bagage van de gebruikersnaam in. |
Methodedetails
agentAuid(undefined | null | string)
Stel de AUID-bagagewaarde van de agent in.
function agentAuid(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
De AUID van de agent
Retouren
Zelf voor methodekoppeling
agentBlueprintId(undefined | null | string)
Stel de waarde voor de blauwdruk-id van de agent in.
function agentBlueprintId(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
De blauwdruk-id van de agent
Retouren
Zelf voor methodekoppeling
agentDescription(undefined | null | string)
Stel de waarde voor bagage van de agent in.
function agentDescription(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
De beschrijving van de agent
Retouren
Zelf voor methodekoppeling
agentEmail(undefined | null | string)
Stel de waarde voor e-mailbagage van de agent in.
function agentEmail(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
Het e-mailadres van de agent
Retouren
Zelf voor methodekoppeling
agentId(undefined | null | string)
Stel de waarde voor bagage van de agent-id in.
function agentId(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
De agent-ID
Retouren
Zelf voor methodekoppeling
agentName(undefined | null | string)
Stel de waarde voor bagage van de agent in.
function agentName(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
De naam van de agent
Retouren
Zelf voor methodekoppeling
agentPlatformId(undefined | null | string)
Stel de waarde voor bagage voor het platform-id van de agent in.
function agentPlatformId(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
De platform-id van de agent
Retouren
Zelf voor methodekoppeling
agentVersion(undefined | null | string)
Stel de bagagewaarde van de agentversie in.
function agentVersion(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
De agentversie (bijvoorbeeld '1.0.0', '2025-05-01')
Retouren
Zelf voor methodekoppeling
build()
Pas de verzamelde bagage toe op de huidige context.
function build(): BaggageScopeRetouren
Een contextmanager die de vorige bagage herstelt bij het verlaten
callerAgentPlatformId(undefined | null | string)
Stel de waarde voor het platform-id van de belleragent in.
function callerAgentPlatformId(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
De platform-id van de belleragent
Retouren
Zelf voor methodekoppeling
callerClientIp(undefined | null | string)
Stel de waarde van de client-IP-bagage van de beller in. Wordt gebruikt om het IP-adres van de oorspronkelijke client voor de aanvraag vast te leggen, zodat deze kan worden doorgegeven via OpenTelemetry-bagage.
function callerClientIp(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
Het IP-adres van de bellerclient
Retouren
Zelf voor methodekoppeling
channelLink(undefined | null | string)
Stel de kanaalkoppeling/-URL in.
function channelLink(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
De kanaalkoppeling
Retouren
Zelf voor methodekoppeling
channelName(undefined | null | string)
Stel de naam van het kanaal in (bijvoorbeeld Teams, Slack).
function channelName(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
De kanaalnaam
Retouren
Zelf voor methodekoppeling
conversationId(undefined | null | string)
Stel de bagagewaarde van de gespreks-id in.
function conversationId(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
De gespreks-id
Retouren
Zelf voor methodekoppeling
conversationItemLink(undefined | null | string)
Stel de waarde voor het koppelen van bagage voor het gespreksitem in.
function conversationItemLink(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
De koppeling naar het gespreksitem
Retouren
Zelf voor methodekoppeling
invokeAgentServer(undefined | null | string, number)
Hiermee stelt u het adres van de agentserver en de poortbagagewaarden in.
function invokeAgentServer(address: undefined | null | string, port?: number): BaggageBuilderParameters
- address
-
undefined | null | string
Het serveradres (hostnaam) van de doelagentservice.
- port
-
number
Optionele serverpoort. Alleen opgenomen wanneer anders dan 443.
Retouren
Het huidige builder-exemplaar voor methodekoppeling.
operationSource(undefined | null | string)
Stel de waarde van de bronbagage van de bewerking in. Wordt gebruikt voor serverbereiken om de service te identificeren (bijvoorbeeld ATG, ACF).
function operationSource(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
De bewerkingsbron
Retouren
Zelf voor methodekoppeling
sessionDescription(undefined | null | string)
Stel de waarde voor bagage voor de sessiebeschrijving in.
function sessionDescription(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
De beschrijving van de sessie
Retouren
Zelf voor methodekoppeling
sessionId(string)
Stel de bagagewaarde van de sessie-id in.
function sessionId(value: string): BaggageBuilderParameters
- value
-
string
De sessie-ID
Retouren
Zelf voor methodekoppeling
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)
Stel meerdere bagageparen in vanuit een woordenlijst of iterable.
function setPairs(pairs: undefined | null | Record<string, any> | Iterable<[string, any]>): BaggageBuilderParameters
- pairs
-
undefined | null | Record<string, any> | Iterable<[string, any]>
Woordenlijst of itereerbaar van sleutel-waardeparen
Retouren
Zelf voor methodekoppeling
setRequestContext(null | string, null | string)
Gemaksmethode voor het starten van een aanvraagbagagebereik met algemene velden.
static function setRequestContext(tenantId?: null | string, agentId?: null | string): BaggageScopeParameters
- tenantId
-
null | string
De tenant-id
- agentId
-
null | string
De agent-ID
Retouren
Een contextmanager die de vorige bagage herstelt bij het verlaten
tenantId(undefined | null | string)
Stel de bagagewaarde van de tenant-id in.
function tenantId(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
De tenant-id
Retouren
Zelf voor methodekoppeling
userEmail(undefined | null | string)
Stel de waarde voor e-mailbagage van de gebruiker in.
function userEmail(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
De e-mail van de gebruiker
Retouren
Zelf voor methodekoppeling
userId(undefined | null | string)
Stel de bagagewaarde van de gebruikers-id in.
function userId(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
De gebruikers-id
Retouren
Zelf voor methodekoppeling
userName(undefined | null | string)
Stel de waarde voor bagage van de gebruikersnaam in.
function userName(value: undefined | null | string): BaggageBuilderParameters
- value
-
undefined | null | string
De gebruikersnaam
Retouren
Zelf voor methodekoppeling