Share via

BuilderOptions interface

Package:
@microsoft/agents-a365-observability

Configuration options for Agent 365 Observability Builder

Properties

clusterCategory

Environment / cluster category (e.g., "preprod", "prod").
configProvider

Optional configuration provider for ObservabilityConfiguration. When provided, this is used by the builder and its internal components (exporter, span processors, logger)
customLogger

Optional custom logger implementation for the observability SDK. If not provided, the SDK uses the default console logger. Implement ILogger to integrate with other logging services
exporterOptions

Optional partial set of exporter options allowing agent developers to customize. Any values omitted will fall back to the defaults defined in Agent365ExporterOptions. Values provided here will be overridden by explicitly configured tokenResolver or clusterCategory from dedicated builder methods.
serviceName

Custom service name for telemetry
serviceNamespace

Optional service namespace for the OTel resource (service.namespace attribute)
serviceVersion

Custom service version for telemetry
tokenResolver

Property Details

clusterCategory

Environment / cluster category (e.g., "preprod", "prod").

clusterCategory?: ClusterCategory

Property Value

ClusterCategory

configProvider

Optional configuration provider for ObservabilityConfiguration. When provided, this is used by the builder and its internal components (exporter, span processors, logger)

configProvider?: IConfigurationProvider<ObservabilityConfiguration>

Property Value

IConfigurationProvider<ObservabilityConfiguration>

customLogger

Optional custom logger implementation for the observability SDK. If not provided, the SDK uses the default console logger. Implement ILogger to integrate with other logging services

customLogger?: ILogger

Property Value

ILogger

exporterOptions

Optional partial set of exporter options allowing agent developers to customize. Any values omitted will fall back to the defaults defined in Agent365ExporterOptions. Values provided here will be overridden by explicitly configured tokenResolver or clusterCategory from dedicated builder methods.

exporterOptions?: Partial<Agent365ExporterOptions>

Property Value

Partial<Agent365ExporterOptions>

serviceName

Custom service name for telemetry

serviceName?: string

Property Value

string

serviceNamespace

Optional service namespace for the OTel resource (service.namespace attribute)

serviceNamespace?: string

Property Value

string

serviceVersion

Custom service version for telemetry

serviceVersion?: string

Property Value

string

tokenResolver 

tokenResolver?: TokenResolver

Property Value

TokenResolver