A365Configuration class

Package:
@microsoft/opentelemetry

Resolved A365 configuration.

Merges values from three sources (lowest to highest precedence):

  1. Defaults
  2. Programmatic options (A365Options)
  3. Environment variables (see A365_ENV_VARS)

Constructors

A365Configuration(A365Options)

Properties

authScopes

OAuth scopes for A365 service authentication.
clusterCategory

Cluster category.
domainOverride

Domain override for the A365 observability service.
enabled

Whether A365 observability is enabled.
enableObservabilityExporter

Whether the A365 HTTP exporter (Agent365Exporter) should be added to the pipeline. The A365SpanProcessor is still registered when enabled is true, regardless of this flag.

Resolved from enableObservabilityExporter (programmatic) or the ENABLE_A365_OBSERVABILITY_EXPORTER environment variable; defaults to false.
exporterTimeoutMilliseconds

Maximum time (ms) for the entire export() call.
httpRequestTimeoutMilliseconds

Timeout (ms) per individual HTTP request.
logLevel

Resolved log level for A365 observability components.

undefined when neither the logLevel option nor the A365_OBSERVABILITY_LOG_LEVEL environment variable is set; in that case the A365 logger keeps its default ("none").
maxExportBatchSize

Maximum number of spans per export batch.
maxPayloadBytes

Maximum estimated payload size (bytes) per HTTP chunk.
maxQueueSize

Maximum span queue size before drops occur.
scheduledDelayMilliseconds

Delay (ms) between automatic batch flush attempts.
tokenResolver

Token resolver callback for A365 service authentication.
useS2SEndpoint

When true, use the S2S endpoint path for export.

Constructor Details

A365Configuration(A365Options) 

new A365Configuration(options?: A365Options)

Parameters

options
A365Options

Property Details

authScopes

OAuth scopes for A365 service authentication.

authScopes: string[]

Property Value

string[]

clusterCategory

Cluster category.

clusterCategory: ClusterCategory

Property Value

ClusterCategory

domainOverride

Domain override for the A365 observability service.

domainOverride?: string

Property Value

string

enabled

Whether A365 observability is enabled.

enabled: boolean

Property Value

boolean

enableObservabilityExporter

Whether the A365 HTTP exporter (Agent365Exporter) should be added to the pipeline. The A365SpanProcessor is still registered when enabled is true, regardless of this flag.

Resolved from enableObservabilityExporter (programmatic) or the ENABLE_A365_OBSERVABILITY_EXPORTER environment variable; defaults to false.

enableObservabilityExporter: boolean

Property Value

boolean

exporterTimeoutMilliseconds

Maximum time (ms) for the entire export() call.

exporterTimeoutMilliseconds?: number

Property Value

number

httpRequestTimeoutMilliseconds

Timeout (ms) per individual HTTP request.

httpRequestTimeoutMilliseconds?: number

Property Value

number

logLevel

Resolved log level for A365 observability components.

undefined when neither the logLevel option nor the A365_OBSERVABILITY_LOG_LEVEL environment variable is set; in that case the A365 logger keeps its default ("none").

logLevel?: string

Property Value

string

maxExportBatchSize

Maximum number of spans per export batch.

maxExportBatchSize?: number

Property Value

number

maxPayloadBytes

Maximum estimated payload size (bytes) per HTTP chunk.

maxPayloadBytes?: number

Property Value

number

maxQueueSize

Maximum span queue size before drops occur.

maxQueueSize?: number

Property Value

number

scheduledDelayMilliseconds

Delay (ms) between automatic batch flush attempts.

scheduledDelayMilliseconds?: number

Property Value

number

tokenResolver

Token resolver callback for A365 service authentication.

tokenResolver?: (agentId: string, tenantId: string, authScopes?: string[]) => string | Promise<string>

Property Value

(agentId: string, tenantId: string, authScopes?: string[]) => string | Promise<string>

useS2SEndpoint

When true, use the S2S endpoint path for export.

useS2SEndpoint: boolean

Property Value

boolean