Agent365ExporterOptions class
Options controlling the behavior of the Agent365 OpenTelemetry span exporter.
These values tune batching, timeouts, token acquisition and endpoint shape. All properties have sensible defaults so callers can usually construct without arguments and override selectively.
Properties
| cluster |
Environment / cluster category (e.g. ClusterCategory.preprod, ClusterCategory.prod, default to ClusterCategory.prod). |
| exporter |
Maximum time (ms) the BatchSpanProcessor waits for the entire export() call to complete before giving up. Covers partitioning, token resolution, and all HTTP retries. |
| http |
Timeout (ms) for each individual HTTP request to the observability backend. Applies per fetch() call inside the retry loop; each retry gets a fresh timeout. |
| max |
Maximum number of spans per export batch. |
| max |
Upper bound on HTTP request body size in bytes. 100 KB headroom under the 1 MB server limit for estimator error and JSON/envelope overhead (for example, resource attributes and scope wrappers). |
| max |
Maximum span queue size before drops occur (passed to BatchSpanProcessor). |
| scheduled |
Delay between automatic batch flush attempts. |
| token |
App-only OBS token resolver required when constructing Agent365Exporter. There is no implicit cache lookup or request-context token fallback. |
| useS2SEndpoint | Deprecated compatibility option. Export always uses the S2S path, even when false. |
Property Details
clusterCategory
Environment / cluster category (e.g. ClusterCategory.preprod, ClusterCategory.prod, default to ClusterCategory.prod).
clusterCategory: stringProperty Value
string
exporterTimeoutMilliseconds
Maximum time (ms) the BatchSpanProcessor waits for the entire export() call to complete before giving up. Covers partitioning, token resolution, and all HTTP retries.
exporterTimeoutMilliseconds: numberProperty Value
number
httpRequestTimeoutMilliseconds
Timeout (ms) for each individual HTTP request to the observability backend. Applies per fetch() call inside the retry loop; each retry gets a fresh timeout.
httpRequestTimeoutMilliseconds: numberProperty Value
number
maxExportBatchSize
Maximum number of spans per export batch.
maxExportBatchSize: numberProperty Value
number
maxPayloadBytes
Upper bound on HTTP request body size in bytes. 100 KB headroom under the 1 MB server limit for estimator error and JSON/envelope overhead (for example, resource attributes and scope wrappers).
maxPayloadBytes: numberProperty Value
number
maxQueueSize
Maximum span queue size before drops occur (passed to BatchSpanProcessor).
maxQueueSize: numberProperty Value
number
scheduledDelayMilliseconds
Delay between automatic batch flush attempts.
scheduledDelayMilliseconds: numberProperty Value
number
tokenResolver
App-only OBS token resolver required when constructing Agent365Exporter. There is no implicit cache lookup or request-context token fallback.
tokenResolver?: TokenResolverProperty Value
useS2SEndpoint
Deprecated compatibility option. Export always uses the S2S path, even when false.
useS2SEndpoint: booleanProperty Value
boolean