BaggageBuilder class
OpenTelemetry 上下文传播的每个请求行李生成器。
此类提供了一个 Fluent API,用于设置将在 OpenTelemetry 上下文中传播的行李值。
示例
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(string | null | undefined)
设置代理 AUID 行李值。
function agentAuid(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
代理 AUID
返回
自链接方法
agentBlueprintId(string | null | undefined)
设置代理蓝图 ID 行李值。
function agentBlueprintId(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
代理蓝图 ID
返回
自链接方法
agentDescription(string | null | undefined)
设置代理说明行李值。
function agentDescription(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
代理说明
返回
自链接方法
agentEmail(string | null | undefined)
设置代理电子邮件行李值。
function agentEmail(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
代理电子邮件
返回
自链接方法
agentId(string | null | undefined)
设置代理 ID 行李值。
function agentId(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
代理 ID
返回
自链接方法
agentName(string | null | undefined)
设置代理名称行李值。
function agentName(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
代理名称
返回
自链接方法
agentPlatformId(string | null | undefined)
设置代理平台 ID 行李值。
function agentPlatformId(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
代理平台 ID
返回
自链接方法
agentVersion(string | null | undefined)
设置代理版本行李值。
function agentVersion(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
代理版本(例如,“1.0.0”、“2025-05-01”)
返回
自链接方法
build()
callerAgentPlatformId(string | null | undefined)
设置调用方代理平台 ID 行李值。
function callerAgentPlatformId(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
调用方代理平台标识符
返回
自链接方法
callerClientIp(string | null | undefined)
设置调用方客户端 IP 行李值。 用于捕获请求的发起客户端 IP,以便可以通过 OpenTelemetry 行李传播它。
function callerClientIp(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
调用方客户端 IP 地址
返回
自链接方法
channelLink(string | null | undefined)
设置通道链接/URL。
function channelLink(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
通道链接
返回
自链接方法
channelName(string | null | undefined)
设置频道名称(例如 Teams、Slack)。
function channelName(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
通道名称
返回
自链接方法
conversationId(string | null | undefined)
设置对话 ID 行李值。
function conversationId(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
会话 ID
返回
自链接方法
conversationItemLink(string | null | undefined)
设置对话项目链接行李值。
function conversationItemLink(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
对话项链接
返回
自链接方法
invokeAgentServer(string | null | undefined, number)
设置调用代理服务器地址和端口行李值。
function invokeAgentServer(address: string | null | undefined, port?: number): BaggageBuilder
参数
- address
-
string | null | undefined
目标代理服务的服务器地址(主机名)。
- port
-
number
可选服务器端口。 仅当与 443 不同时才会记录。
返回
方法链接的当前生成器实例。
operationSource(string | null | undefined)
设置作源行李值。 用于服务器范围来标识服务(例如 ATG、ACF)。
function operationSource(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
操作源
返回
自链接方法
sessionDescription(string | null | undefined)
设置会话说明行李值。
function sessionDescription(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
会话说明
返回
自链接方法
sessionId(string)
设置会话 ID 行李值。
function sessionId(value: string): BaggageBuilder
参数
- value
-
string
会话 ID
返回
自链接方法
setPairs(Record<string, any> | Iterable<[string, any], any, any> | null | undefined)
从字典或可迭代设置多个行李对。
function setPairs(pairs: Record<string, any> | Iterable<[string, any], any, any> | null | undefined): BaggageBuilder
参数
- pairs
-
Record<string, any> | Iterable<[string, any], any, any> | null | undefined
键值对的字典或可迭代
返回
自链接方法
setRequestContext(string | null, string | null)
使用常用字段开始请求行李范围的便利方法。
static function setRequestContext(tenantId?: string | null, agentId?: string | null): BaggageScope
参数
- tenantId
-
string | null
租户 ID
- agentId
-
string | null
代理 ID
返回
在退出时还原上一个行李的上下文管理器
tenantId(string | null | undefined)
设置租户 ID 行李值。
function tenantId(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
租户 ID
返回
自链接方法
userEmail(string | null | undefined)
设置用户电子邮件行李值。
function userEmail(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
用户电子邮件
返回
自链接方法
userId(string | null | undefined)
设置用户 ID 行李值。
function userId(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
用户 ID
返回
自链接方法
userName(string | null | undefined)
设置用户名行李值。
function userName(value: string | null | undefined): BaggageBuilder
参数
- value
-
string | null | undefined
用户名
返回
自链接方法