@microsoft/opentelemetry
    Preparing search index...

    Interface A365Options

    A365 observability configuration options.

    These are the public-facing options passed via the a365 scope of MicrosoftOpenTelemetryOptions.

    interface A365Options {
        authScopes?: string[];
        clusterCategory?: ClusterCategory;
        domainOverride?: string;
        enabled?: boolean;
        enableObservabilityExporter?: boolean;
        exporterTimeoutMilliseconds?: number;
        httpRequestTimeoutMilliseconds?: number;
        logLevel?: string;
        maxExportBatchSize?: number;
        maxPayloadBytes?: number;
        maxQueueSize?: number;
        observabilityScopeOverride?: string;
        scheduledDelayMilliseconds?: number;
        tokenResolver?: (
            agentId: string,
            tenantId: string,
            authScopes?: string[],
        ) => string | Promise<string>;
        useS2SEndpoint?: boolean;
    }
    Index

    Properties

    authScopes? clusterCategory? domainOverride? enabled? enableObservabilityExporter? exporterTimeoutMilliseconds? httpRequestTimeoutMilliseconds? logLevel? maxExportBatchSize? maxPayloadBytes? maxQueueSize? observabilityScopeOverride? scheduledDelayMilliseconds? tokenResolver? useS2SEndpoint?

    Properties

    authScopes?: string[]

    OAuth scopes for A365 service authentication.

    clusterCategory?: ClusterCategory

    Cluster category for the A365 service endpoint.

    domainOverride?: string

    Override the A365 observability service domain.

    enabled?: boolean

    Enable A365 observability. When false, no A365 components are created.

    enableObservabilityExporter?: boolean

    Enable the A365 HTTP observability exporter (Agent365Exporter).

    Defaults to false. When false (and enabled is true), the A365SpanProcessor is still registered for baggage/attribute enrichment of downstream exporters (Azure Monitor, OTLP, console, …) but no data is sent to the A365 observability service.

    Equivalent to the ENABLE_A365_OBSERVABILITY_EXPORTER environment variable. The programmatic value wins when both are set.

    Has no effect when enabled is false.

    exporterTimeoutMilliseconds?: number

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

    httpRequestTimeoutMilliseconds?: number

    Timeout (ms) per individual HTTP request. Each retry gets a fresh timeout.

    logLevel?: string

    Log level for A365 observability components.

    Accepts none, info, warn, error, or a |-separated combination (e.g. "warn|error"). Defaults to none when neither this option nor the A365_OBSERVABILITY_LOG_LEVEL environment variable is set. When set, this option overrides the environment variable.

    maxExportBatchSize?: number

    Maximum number of spans per export batch.

    maxPayloadBytes?: number

    Maximum estimated payload size (bytes) per HTTP chunk.

    maxQueueSize?: number

    Maximum span queue size before drops occur.

    observabilityScopeOverride?: string

    Single-string override for the A365 observability authentication scope.

    Equivalent to the A365_OBSERVABILITY_SCOPES_OVERRIDE environment variable; when supplied, it becomes the sole entry of the resolved authScopes array. Mirrors the Python distro's a365_observability_scope_override kwarg (microsoft/opentelemetry-distro-python#87).

    Precedence (highest to lowest): this option > env var > authScopes.

    scheduledDelayMilliseconds?: number

    Delay (ms) between automatic batch flush attempts.

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

    Token resolver for authenticating with the A365 observability service. Called with (agentId, tenantId, authScopes) extracted from span attributes/config. Must return a bearer token string or a promise resolving to one.

    useS2SEndpoint?: boolean

    When true, use the S2S endpoint path for export.

    false

    Settings

    Member Visibility

    On This Page

    Properties