Class BaggageBuilder

Fluent builder for setting OpenTelemetry baggage values.

Example

const scope = new BaggageBuilder()
  .tenantId("tenant-123")
  .agentId("agent-456")
  .build();

scope.run(() => {
  // Baggage is active in this context
});

Constructors

constructor

new BaggageBuilder(): BaggageBuilder
Returns BaggageBuilder

Methods

agentAuid

agentAuid(value: string | null | undefined): BaggageBuilder
Set the agent AUID baggage value.
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:54

agentBlueprintId

agentBlueprintId(value: string | null | undefined): BaggageBuilder
Set the agent blueprint ID baggage value.
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:66

agentDescription

agentDescription(value: string | null | undefined): BaggageBuilder
Set the agent description baggage value.
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:90

agentEmail

agentEmail(value: string | null | undefined): BaggageBuilder
Set the agent email baggage value.
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:60

agentId

agentId(value: string | null | undefined): BaggageBuilder
Set the agent ID baggage value.
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:48

agentName

agentName(value: string | null | undefined): BaggageBuilder
Set the agent name baggage value.
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:84

agentPlatformId

agentPlatformId(value: string | null | undefined): BaggageBuilder
Set the agent platform ID baggage value.
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:96

agentVersion

agentVersion(value: string | null | undefined): BaggageBuilder
Set the agent version baggage value.
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:102

build

build(): BaggageScope
Apply the collected baggage to the current context.

Returns BaggageScope
A BaggageScope that can run callbacks under the baggage context
- Defined in a365/middleware/BaggageBuilder.ts:210

callerAgentPlatformId

callerAgentPlatformId(value: string | null | undefined): BaggageBuilder
Set the caller agent platform ID baggage value.
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:132

callerClientIp

callerClientIp(value: string | null | undefined): BaggageBuilder
Set the caller client IP baggage value.
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:126

channelLink

channelLink(value: string | null | undefined): BaggageBuilder
Set the channel link/URL.
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:156

channelName

channelName(value: string | null | undefined): BaggageBuilder
Set the channel name (e.g., Teams, Slack).
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:150

conversationId

conversationId(value: string | null | undefined): BaggageBuilder
Set the conversation ID baggage value.
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:138

conversationItemLink

conversationItemLink(value: string | null | undefined): BaggageBuilder
Set the conversation item link baggage value.
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:144

invokeAgentServer

invokeAgentServer(
address: string | null | undefined,
port?: number,
): BaggageBuilder
Sets the invoke agent server address and port baggage values.
Parameters
- address: string | null | undefined
  The server address (hostname) of the target agent service.
- Optionalport: number
  Optional server port. Only recorded when different from 443.
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:166

operationSource

operationSource(value: string | null | undefined): BaggageBuilder
Set the operation source baggage value (e.g., ATG, ACF).
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:36

sessionDescription

sessionDescription(value: string | null | undefined): BaggageBuilder
Set the session description baggage value.
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:108

sessionId

sessionId(value: string): BaggageBuilder
Set the session ID baggage value.
Parameters
- value: string
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:72

setPairs

setPairs(
    pairs:
        | Record<string, any>
        | Iterable<[string, any], any, any>
        | null
        | undefined,
): BaggageBuilder
Set multiple baggage pairs from a dictionary or iterable.
Parameters
- pairs: Record<string, any> | Iterable<[string, any], any, any> | null | undefined
  Dictionary or iterable of key-value pairs
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:181

tenantId

tenantId(value: string | null | undefined): BaggageBuilder
Set the tenant ID baggage value.
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:42

userEmail

userEmail(value: string | null | undefined): BaggageBuilder
Set the user email baggage value.
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:120

userId

userId(value: string | null | undefined): BaggageBuilder
Set the user ID baggage value.
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:78

userName

userName(value: string | null | undefined): BaggageBuilder
Set the user name baggage value.
Parameters
- value: string | null | undefined
Returns BaggageBuilder
- Defined in a365/middleware/BaggageBuilder.ts:114

`Static`setRequestContext

setRequestContext(
tenantId?: string | null,
agentId?: string | null,
): BaggageScope
Convenience method to begin a request baggage scope with common fields.
Parameters
- OptionaltenantId: string | null
  The tenant ID
- OptionalagentId: string | null
  The agent ID
Returns BaggageScope
A BaggageScope with tenant and agent ID set
- Defined in a365/middleware/BaggageBuilder.ts:232

Class BaggageBuilder

Example

Index

Constructors

Methods

Constructors

constructor

Returns BaggageBuilder

Methods

agentAuid

Parameters

Returns BaggageBuilder

agentBlueprintId

Parameters

Returns BaggageBuilder

agentDescription

Parameters

Returns BaggageBuilder

agentEmail

Parameters

Returns BaggageBuilder

agentId

Parameters

Returns BaggageBuilder

agentName

Parameters

Returns BaggageBuilder

agentPlatformId

Parameters

Returns BaggageBuilder

agentVersion

Parameters

Returns BaggageBuilder

build

Returns BaggageScope

callerAgentPlatformId

Parameters

Returns BaggageBuilder

callerClientIp

Parameters

Returns BaggageBuilder

channelLink

Parameters

Returns BaggageBuilder

channelName

Parameters

Returns BaggageBuilder

conversationId

Parameters

Returns BaggageBuilder

conversationItemLink

Parameters

Returns BaggageBuilder

invokeAgentServer

Parameters

Returns BaggageBuilder

operationSource

Parameters

Returns BaggageBuilder

sessionDescription

Parameters

Returns BaggageBuilder

sessionId

Parameters

Returns BaggageBuilder

setPairs

Parameters

Returns BaggageBuilder

tenantId

Parameters

Returns BaggageBuilder

userEmail

Parameters

Returns BaggageBuilder

userId

Parameters

Returns BaggageBuilder

userName

Parameters

Returns BaggageBuilder

`Static`setRequestContext