SessionRecordingOptions

Properties

NameType
__mutationThrottlerBucketSizenumber

ADVANCED: alters the bucket size for the token bucket mutation throttling Normally only altered alongside posthog support guidance. Accepts values between 0 and 100 100

__mutationThrottlerRefillRatenumber

ADVANCED: alters the refill rate for the token bucket mutation throttling Normally only altered alongside posthog support guidance. Accepts values between 0 and 100 10

blockClassstring | RegExp

Derived from rrweb.record options

blockSelectorstring | null

Derived from rrweb.record options

captureCanvasSessionRecordingCanvasOptions

Allows local config to override remote canvas recording settings from the flags response

collectFontsboolean

Derived from rrweb.record options

compress_eventsboolean

ADVANCED: whether to partially compress rrweb events before sending them to the server, defaults to true, can be set to false to disable partial compression NB requests are still compressed when sent to the server regardless of this setting true

full_snapshot_interval_millisnumber

ADVANCED: while a user is active we take a full snapshot of the browser every interval. For very few sites playback performance might be better with different interval. Set to 0 to disable 1000 * 60 * 5 (5 minutes)

ignoreClassstring | RegExp

Derived from rrweb.record options

inlineStylesheetboolean

Derived from rrweb.record options

maskAllInputsboolean

Derived from rrweb.record options

maskCapturedNetworkRequestFn((data: CapturedNetworkRequest) => CapturedNetworkRequest | null | undefined) | null

Modify the network request before it is captured. Returning null or undefined stops it being captured

maskInputFn((text: string, element?: HTMLElement) => string) | null

Derived from rrweb.record options

maskInputOptionsrecordOptions['maskInputOptions']

Derived from rrweb.record options

maskNetworkRequestFn((data: NetworkRequest) => NetworkRequest | null | undefined) | null
maskTextClassstring | RegExp

Derived from rrweb.record options

maskTextFn((text: string, element?: HTMLElement) => string) | null

Derived from rrweb.record options

maskTextSelectorstring | null

Derived from rrweb.record options

recordBodyboolean

Derived from rrweb.record options

recordCrossOriginIframesboolean

Derived from rrweb.record options

recordHeadersboolean

Derived from rrweb.record options

session_idle_threshold_msnumber

ADVANCED: alters the threshold before a recording considers a user has become idle. Normally only altered alongside changes to session_idle_timeout_ms. 1000 * 60 * 5 (5 minutes)

slimDOMOptionsrecordOptions['slimDOMOptions']

Derived from rrweb.record options

Community questions

Was this page useful?