RUM JavaScript API - 1.345.1
    Preparing search index...

    Interface SnapshotOptions

    Options for configuring snapshot comparison behavior.

    interface SnapshotOptions {
        ignoredFields?: string[];
        ignoreEvents?: EventIgnorePattern[];
        name?: string;
        removedFields?: string[];
    }
    Index

    Properties

    ignoredFields? ignoreEvents? name? removedFields?

    Properties

    ignoredFields?: string[]

    Properties to ignore before comparison. Values are replaced with "[IGNORED]" placeholder. Supports exact field names and wildcard patterns (prefix.*).

    Examples:

    • "start_time" → value replaced with "[IGNORED]"
    • "dt.rum.*" → all fields starting with dt.rum. have values replaced with "[IGNORED]"

    Default: DEFAULT_IGNORED_FIELDS (includes timestamps, session IDs, trace IDs, etc.)

    ignoreEvents?: EventIgnorePattern[]

    Event patterns to completely ignore during snapshot comparison. Events matching any of these patterns will be filtered out before comparison.

    Default: DEFAULT_IGNORED_EVENTS (filters long task and self-monitoring events)

    name?: string

    Custom snapshot name. If not provided, defaults to "events".

    removedFields?: string[]

    Properties to remove entirely before comparison. Supports exact field names and wildcard patterns (prefix.*).

    Examples:

    • "performance.time_origin" → field is removed from the event
    • "inp.*" → all fields starting with inp. are removed

    Default: DEFAULT_REMOVED_FIELDS (includes web vitals, performance metrics, viewport dimensions)

    Settings

    Member Visibility

    On This Page

    Properties