Builder class

Package:

@microsoft/agents-a365-observability

Builder for configuring Agent 365 with OpenTelemetry tracing

Methods

build()	Builds and initializes the Agent 365 configuration
shutdown()	Shuts down the OpenTelemetry SDK
start()	Starts the OpenTelemetry SDK
withClusterCategory(ClusterCategory)	Configures the cluster category for Agent 365 exporter
withService(string, string)	Configures the service name and version for telemetry
withTokenResolver(TokenResolver)	Configures the token resolver for Agent 365 exporter

Method Details

build()

Builds and initializes the Agent 365 configuration

function build(): boolean

Returns

boolean

The configured NodeSDK instance

shutdown()

Shuts down the OpenTelemetry SDK

function shutdown(): Promise<void>

Returns

Promise<void>

start()

Starts the OpenTelemetry SDK

function start()

withClusterCategory(ClusterCategory)

Configures the cluster category for Agent 365 exporter

function withClusterCategory(clusterCategory: ClusterCategory): ObservabilityBuilder

Parameters

clusterCategory

ClusterCategory

The cluster category (e.g., "preprod", "prod")

Returns

Builder

The builder instance for method chaining

withService(string, string)

Configures the service name and version for telemetry

function withService(serviceName: string, serviceVersion?: string): ObservabilityBuilder

Parameters

serviceName

string

The service name

serviceVersion

string

The service version

Returns

Builder

The builder instance for method chaining

withTokenResolver(TokenResolver)

Configures the token resolver for Agent 365 exporter

function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder

Parameters

tokenResolver

TokenResolver

Function to resolve authentication tokens

Returns

Builder

The builder instance for method chaining