BaggageBuilder class
Gepäck-Generator pro Anforderung für die OpenTelemetry-Kontextverteilung.
Diese Klasse bietet eine Fluent-API zum Festlegen von Gepäckwerten, die im OpenTelemetry-Kontext weitergegeben werden.
Beispiel
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 |
Legen Sie den AuID-Gepäckwert des Agenten fest. |
| agent |
Legen Sie den Gepäckwert für die Agent-Blueprint-ID fest. |
| agent |
Legen Sie den Gepäckwert für die Agentbeschreibung fest. |
| agent |
Legen Sie den Wert des Agent-E-Mail-Gepäcks fest. |
| agent |
Legen Sie den Gepäckwert für die Agent-ID fest. |
| agent |
Legen Sie den Gepäckwert für den Agentennamen fest. |
| agent |
Legen Sie den Gepäckwert der Agentplattform-ID fest. |
| agent |
Legen Sie den Gepäckwert für die Agentversion fest. |
| build() | Wenden Sie das gesammelte Gepäck auf den aktuellen Kontext an. |
| caller |
Legen Sie den Gepäckwert der Anrufer-Agent-Plattform-ID fest. |
| caller |
Legen Sie den IP-Gepäckwert des Anrufers fest. Wird verwendet, um die ursprüngliche Client-IP für die Anforderung zu erfassen, damit sie über OpenTelemetry-Gepäck weitergegeben werden kann. |
| channel |
Legen Sie den Kanallink/die URL fest. |
| channel |
Legen Sie den Kanalnamen fest (z. B. Teams, Slack). |
| conversation |
Legen Sie den Gepäckwert der Unterhaltungs-ID fest. |
| conversation |
Legen Sie den Link-Gepäckwert für Unterhaltungsartikel fest. |
| invoke |
Legt die Aufruf-Agent-Serveradresse und portieren Gepäckwerte fest. |
| operation |
Legen Sie den Gepäckwert für den Betrieb fest. Wird für Serverspannen verwendet, um den Dienst zu identifizieren (z. B. ATG, ACF). |
| session |
Legen Sie den Gepäckwert der Sitzungsbeschreibung fest. |
| session |
Legen Sie den Sitzungs-ID-Gepäckwert fest. |
| set |
Legen Sie mehrere Gepäckpaare aus einem Wörterbuch oder iterierbar fest. |
| set |
Convenience-Methode, um einen Anforderungsgepäckbereich mit gemeinsamen Feldern zu beginnen. |
| tenant |
Legen Sie den Gepäckwert der Mandanten-ID fest. |
| user |
Legen Sie den E-Mail-Gepäckwert des Benutzers fest. |
| user |
Legen Sie den Gepäckwert der Benutzer-ID fest. |
| user |
Legen Sie den Gepäckwert für den Benutzernamen fest. |
Details zur Methode
agentAuid(undefined | null | string)
Legen Sie den AuID-Gepäckwert des Agenten fest.
function agentAuid(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Der Agent AUID
Gibt zurück
Self for method chaining
agentBlueprintId(undefined | null | string)
Legen Sie den Gepäckwert für die Agent-Blueprint-ID fest.
function agentBlueprintId(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Die Agent-Blueprint-ID
Gibt zurück
Self for method chaining
agentDescription(undefined | null | string)
Legen Sie den Gepäckwert für die Agentbeschreibung fest.
function agentDescription(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Die Agentbeschreibung
Gibt zurück
Self for method chaining
agentEmail(undefined | null | string)
Legen Sie den Wert des Agent-E-Mail-Gepäcks fest.
function agentEmail(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Die Agent-E-Mail
Gibt zurück
Self for method chaining
agentId(undefined | null | string)
Legen Sie den Gepäckwert für die Agent-ID fest.
function agentId(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Die Agenten-ID
Gibt zurück
Self for method chaining
agentName(undefined | null | string)
Legen Sie den Gepäckwert für den Agentennamen fest.
function agentName(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Der Agentname
Gibt zurück
Self for method chaining
agentPlatformId(undefined | null | string)
Legen Sie den Gepäckwert der Agentplattform-ID fest.
function agentPlatformId(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Die Agentplattform-ID
Gibt zurück
Self for method chaining
agentVersion(undefined | null | string)
Legen Sie den Gepäckwert für die Agentversion fest.
function agentVersion(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Die Agentversion (z. B. "1.0.0", "2025-05-01").
Gibt zurück
Self for method chaining
build()
Wenden Sie das gesammelte Gepäck auf den aktuellen Kontext an.
function build(): BaggageScopeGibt zurück
Ein Kontextmanager, der das vorherige Gepäck beim Verlassen wiederhergestellt
callerAgentPlatformId(undefined | null | string)
Legen Sie den Gepäckwert der Anrufer-Agent-Plattform-ID fest.
function callerAgentPlatformId(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Der Anrufer-Agent-Plattformbezeichner
Gibt zurück
Self for method chaining
callerClientIp(undefined | null | string)
Legen Sie den IP-Gepäckwert des Anrufers fest. Wird verwendet, um die ursprüngliche Client-IP für die Anforderung zu erfassen, damit sie über OpenTelemetry-Gepäck weitergegeben werden kann.
function callerClientIp(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Die IP-Adresse des Anrufers
Gibt zurück
Self for method chaining
channelLink(undefined | null | string)
Legen Sie den Kanallink/die URL fest.
function channelLink(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Der Kanallink
Gibt zurück
Self for method chaining
channelName(undefined | null | string)
Legen Sie den Kanalnamen fest (z. B. Teams, Slack).
function channelName(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Der Kanalname
Gibt zurück
Self for method chaining
conversationId(undefined | null | string)
Legen Sie den Gepäckwert der Unterhaltungs-ID fest.
function conversationId(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Die Unterhaltungs-ID
Gibt zurück
Self for method chaining
conversationItemLink(undefined | null | string)
Legen Sie den Link-Gepäckwert für Unterhaltungsartikel fest.
function conversationItemLink(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Der Link "Unterhaltungselement"
Gibt zurück
Self for method chaining
invokeAgentServer(undefined | null | string, number)
Legt die Aufruf-Agent-Serveradresse und portieren Gepäckwerte fest.
function invokeAgentServer(address: undefined | null | string, port?: number): BaggageBuilderParameter
- address
-
undefined | null | string
Die Serveradresse (Hostname) des Ziel-Agent-Diensts.
- port
-
number
Optionaler Serverport. Wird nur aufgezeichnet, wenn es sich von 443 unterscheidet.
Gibt zurück
Die aktuelle Generatorinstanz für die Methodenkette.
operationSource(undefined | null | string)
Legen Sie den Gepäckwert für den Betrieb fest. Wird für Serverspannen verwendet, um den Dienst zu identifizieren (z. B. ATG, ACF).
function operationSource(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Die Vorgangsquelle
Gibt zurück
Self for method chaining
sessionDescription(undefined | null | string)
Legen Sie den Gepäckwert der Sitzungsbeschreibung fest.
function sessionDescription(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Die Sitzungsbeschreibung
Gibt zurück
Self for method chaining
sessionId(string)
Legen Sie den Sitzungs-ID-Gepäckwert fest.
function sessionId(value: string): BaggageBuilderParameter
- value
-
string
Die Sitzungs-ID
Gibt zurück
Self for method chaining
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)
Legen Sie mehrere Gepäckpaare aus einem Wörterbuch oder iterierbar fest.
function setPairs(pairs: undefined | null | Record<string, any> | Iterable<[string, any]>): BaggageBuilderParameter
- pairs
-
undefined | null | Record<string, any> | Iterable<[string, any]>
Wörterbuch oder iterierbare Schlüsselwertpaare
Gibt zurück
Self for method chaining
setRequestContext(null | string, null | string)
Convenience-Methode, um einen Anforderungsgepäckbereich mit gemeinsamen Feldern zu beginnen.
static function setRequestContext(tenantId?: null | string, agentId?: null | string): BaggageScopeParameter
- tenantId
-
null | string
Die Mandanten-ID
- agentId
-
null | string
Die Agenten-ID
Gibt zurück
Ein Kontextmanager, der das vorherige Gepäck beim Verlassen wiederhergestellt
tenantId(undefined | null | string)
Legen Sie den Gepäckwert der Mandanten-ID fest.
function tenantId(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Die Mandanten-ID
Gibt zurück
Self for method chaining
userEmail(undefined | null | string)
Legen Sie den E-Mail-Gepäckwert des Benutzers fest.
function userEmail(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Die E-Mail-Adresse des Benutzers
Gibt zurück
Self for method chaining
userId(undefined | null | string)
Legen Sie den Gepäckwert der Benutzer-ID fest.
function userId(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Die Benutzer-ID
Gibt zurück
Self for method chaining
userName(undefined | null | string)
Legen Sie den Gepäckwert für den Benutzernamen fest.
function userName(value: undefined | null | string): BaggageBuilderParameter
- value
-
undefined | null | string
Benutzername
Gibt zurück
Self for method chaining