BaggageBuilder class
OpenTelemetry コンテキスト伝達の要求手荷物ビルダーごと。
このクラスは、OpenTelemetry コンテキストで伝達される手荷物の値を設定するための fluent API を提供します。
例
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
メソッド
メソッドの詳細
agentAuid(undefined | null | string)
エージェント AUID 手荷物の値を設定します。
function agentAuid(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
エージェント AUID
返品
メソッド チェーン用の自己
agentBlueprintId(undefined | null | string)
エージェントのブループリント ID 手荷物の値を設定します。
function agentBlueprintId(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
エージェントブループリント ID
返品
メソッド チェーン用の自己
agentDescription(undefined | null | string)
エージェントの説明の手荷物の値を設定します。
function agentDescription(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
エージェントの説明
返品
メソッド チェーン用の自己
agentEmail(undefined | null | string)
エージェントのメール手荷物の値を設定します。
function agentEmail(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
エージェントの電子メール
返品
メソッド チェーン用の自己
agentId(undefined | null | string)
エージェント ID の手荷物の値を設定します。
function agentId(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
エージェントの ID
返品
メソッド チェーン用の自己
agentName(undefined | null | string)
エージェント名の手荷物の値を設定します。
function agentName(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
エージェント名
返品
メソッド チェーン用の自己
agentPlatformId(undefined | null | string)
エージェント プラットフォーム ID の手荷物の値を設定します。
function agentPlatformId(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
エージェント プラットフォーム ID
返品
メソッド チェーン用の自己
agentVersion(undefined | null | string)
エージェントバージョンの手荷物の値を設定します。
function agentVersion(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
エージェントのバージョン (例: '1.0.0'、'2025-05-01')
返品
メソッド チェーン用の自己
build()
callerAgentPlatformId(undefined | null | string)
発信者エージェントのプラットフォーム ID 手荷物の値を設定します。
function callerAgentPlatformId(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
呼び出し元エージェント のプラットフォーム識別子
返品
メソッド チェーン用の自己
callerClientIp(undefined | null | string)
呼び出し元クライアントの IP 手荷物の値を設定します。 OpenTelemetry 手荷物を介して伝達できるように、要求の送信元クライアント IP をキャプチャするために使用されます。
function callerClientIp(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
呼び出し元クライアントの IP アドレス
返品
メソッド チェーン用の自己
channelLink(undefined | null | string)
チャネル リンク/URL を設定します。
function channelLink(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
チャネル リンク
返品
メソッド チェーン用の自己
channelName(undefined | null | string)
チャネル名 (Teams、Slack など) を設定します。
function channelName(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
チャネル名
返品
メソッド チェーン用の自己
conversationId(undefined | null | string)
会話 ID の手荷物の値を設定します。
function conversationId(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
会話 ID
返品
メソッド チェーン用の自己
conversationItemLink(undefined | null | string)
会話項目リンク手荷物の値を設定します。
function conversationItemLink(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
会話アイテムのリンク
返品
メソッド チェーン用の自己
invokeAgentServer(undefined | null | string, number)
呼び出しエージェント のサーバー アドレスとポート手荷物の値を設定します。
function invokeAgentServer(address: undefined | null | string, port?: number): BaggageBuilderパラメーター
- address
-
undefined | null | string
ターゲット エージェント サービスのサーバー アドレス (ホスト名)。
- port
-
number
オプションのサーバー ポート。 443 と異なる場合にのみ記録されます。
返品
メソッドチェーンの現在のビルダー インスタンス。
operationSource(undefined | null | string)
操作ソースの手荷物の値を設定します。 サービスを識別するためにサーバー スパン (ATG、ACF など) に使用されます。
function operationSource(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
操作ソース
返品
メソッド チェーン用の自己
sessionDescription(undefined | null | string)
セッションの説明の手荷物の値を設定します。
function sessionDescription(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
セッションの説明
返品
メソッド チェーン用の自己
sessionId(string)
セッション ID の手荷物の値を設定します。
function sessionId(value: string): BaggageBuilderパラメーター
- value
-
string
セッション ID
返品
メソッド チェーン用の自己
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)
辞書または iterable から複数の手荷物ペアを設定します。
function setPairs(pairs: undefined | null | Record<string, any> | Iterable<[string, any]>): BaggageBuilderパラメーター
- pairs
-
undefined | null | Record<string, any> | Iterable<[string, any]>
キーと値のペアのディクショナリまたはイターブル
返品
メソッド チェーン用の自己
setRequestContext(null | string, null | string)
共通フィールドを使用して手荷物の範囲を要求する便利な方法。
static function setRequestContext(tenantId?: null | string, agentId?: null | string): BaggageScopeパラメーター
- tenantId
-
null | string
テナント ID
- agentId
-
null | string
エージェントの ID
返品
出口で前の手荷物を復元するコンテキスト マネージャー
tenantId(undefined | null | string)
テナント ID の手荷物の値を設定します。
function tenantId(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
テナント ID
返品
メソッド チェーン用の自己
userEmail(undefined | null | string)
ユーザーのメール手荷物の値を設定します。
function userEmail(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
ユーザーの電子メール
返品
メソッド チェーン用の自己
userId(undefined | null | string)
ユーザー ID の手荷物の値を設定します。
function userId(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
ユーザー ID
返品
メソッド チェーン用の自己
userName(undefined | null | string)
ユーザー名の手荷物の値を設定します。
function userName(value: undefined | null | string): BaggageBuilderパラメーター
- value
-
undefined | null | string
ユーザー名
返品
メソッド チェーン用の自己