Interface BatchSpanProcessorOptionsExperimental

Common options for SDK span processors.

This interface is experimental and is subject to breaking changes in minor releases.

interface BatchSpanProcessorOptions {
    disableAutoFlushOnDocumentHide?: boolean;
    exportTimeoutMillis?: number;
    exporter: SpanExporter;
    maxExportBatchSize?: number;
    maxQueueSize?: number;
    scheduledDelayMillis?: number;
    selfObsMeterProvider?: MeterProvider;
}

Hierarchy (view full)

Properties

disableAutoFlushOnDocumentHide?: boolean

Browser only: disable flush when a user navigates to a new page, closes the tab or the browser, or, on mobile, switches to a different app. Auto flush is enabled by default.

exportTimeoutMillis?: number

How long the export can run before it is cancelled. The default value is 30000ms

exporter: SpanExporter
maxExportBatchSize?: number

The maximum batch size of every export. It must be smaller or equal to maxQueueSize. The default value is 512.

maxQueueSize?: number

The maximum queue size. After the size is reached spans are dropped. The default value is 2048.

scheduledDelayMillis?: number

The delay interval in milliseconds between two consecutive exports. The default value is 5000ms.

selfObsMeterProvider?: MeterProvider

A meter provider to which to record self-observability span processor metrics. This option is experimental and is subject to breaking changes in minor releases.