microsoft.opentelemetry.a365.core.middleware.baggage_builder module

class microsoft.opentelemetry.a365.core.middleware.baggage_builder.BaggageBuilder[source]

Bases: object

Per request baggage builder.

This class provides a fluent API for setting baggage values that will be propagated in the OpenTelemetry context.

Example

builder = (BaggageBuilder()
           .tenant_id("tenant-123")
           .agent_id("agent-456"))

with builder.build():
    # Baggage is set in this context
    pass
# Baggage is restored after exiting the context

operation_source(value)[source]

Set the operation source baggage value.

This captures the name of the service using the SDK.

Parameters:: value (str | None) – The service name (e.g., “my-agent-service”, “weather-bot”)
Return type:: BaggageBuilder
Returns:: Self for method chaining

tenant_id(value)[source]

Set the tenant ID baggage value.

Parameters:: value (str | None) – The tenant ID
Return type:: BaggageBuilder
Returns:: Self for method chaining

agent_id(value)[source]

Set the agent ID baggage value.

Parameters:: value (str | None) – The agent ID
Return type:: BaggageBuilder
Returns:: Self for method chaining

agentic_user_id(value)[source]

Set the agentic user ID baggage value.

Parameters:: value (str | None) – The agentic user ID
Return type:: BaggageBuilder
Returns:: Self for method chaining

agentic_user_email(value)[source]

Set the agentic user email baggage value.

Parameters:: value (str | None) – The agentic user email
Return type:: BaggageBuilder
Returns:: Self for method chaining

agent_blueprint_id(value)[source]

Set the agent blueprint ID baggage value.

Parameters:: value (str | None) – The agent blueprint ID
Return type:: BaggageBuilder
Returns:: Self for method chaining

user_id(value)[source]

Set the user ID baggage value.

Parameters:: value (str | None) – The user ID
Return type:: BaggageBuilder
Returns:: Self for method chaining

agent_name(value)[source]

Set the agent name baggage value.

Return type:: BaggageBuilder

agent_description(value)[source]

Set the agent description baggage value.

Return type:: BaggageBuilder

agent_version(value)[source]

Set the agent version baggage value.

Return type:: BaggageBuilder

user_name(value)[source]

Set the user name baggage value.

Return type:: BaggageBuilder

user_email(value)[source]

Set the user email baggage value.

Return type:: BaggageBuilder

user_client_ip(value)[source]

Set the user client IP baggage value.

Return type:: BaggageBuilder

invoke_agent_server(address, port=None)[source]

Set the invoke agent server address and port baggage values.

Parameters:

address (str | None) – The server address (hostname) of the target agent service.
port (int | None) – Optional server port. Only recorded when different from 443.

Return type: