monitor-api - v1.3.0
    Preparing search index...

    Interface MonitorConfig

    Options used when creating a monitor instance.

    interface MonitorConfig {
        collectors?:
            | {
                events?: boolean
                | Partial<EventCollectorConfig>;
                network?: boolean | Partial<NetworkCollectorConfig>;
                performance?: boolean | Partial<PerformanceCollectorConfig>;
                react?: boolean | Partial<ReactCollectorConfig>;
                webVitals?: boolean | Partial<WebVitalsCollectorConfig>;
            }
            | CollectorName[];
        env?: "development"
        | "production";
        maxHistory?: number;
        networkFilter?: (url: string) => boolean;
        report?: ProductionReportConfig;
        sampleRate?: number;
    }
    Index

    Properties

    collectors? env? maxHistory? networkFilter? report? sampleRate?

    Properties

    collectors?:
        | {
            events?: boolean
            | Partial<EventCollectorConfig>;
            network?: boolean | Partial<NetworkCollectorConfig>;
            performance?: boolean | Partial<PerformanceCollectorConfig>;
            react?: boolean | Partial<ReactCollectorConfig>;
            webVitals?: boolean | Partial<WebVitalsCollectorConfig>;
        }
        | CollectorName[]

    Controls which collectors are active.

    Use an array to enable only selected collectors, or an object to enable, disable, or override individual collector settings.

    env?: "development" | "production"

    Runtime environment. Production enables periodic reporting when report is configured.

    maxHistory?: number

    Maximum number of retained entries per collector history. Use 0 to disable history. Defaults to 120.

    networkFilter?: (url: string) => boolean

    Convenience filter applied to network request URLs.

    report?: ProductionReportConfig

    Optional production reporting configuration.

    sampleRate?: number

    Per-monitor sampling probability from 0 to 1. Defaults to 1.

    Settings

    Member Visibility

    On This Page

    Properties