Package Exports

@sentry/replay
@sentry/replay/dist/index.es.js
@sentry/replay/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@sentry/replay) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

sentry-replay

This integration is a WIP.

Pre-Requisites

For the sentry-replay integration to work, you must have the Sentry browser SDK package installed.

Installation

To install the stable version:

with npm:

npm install --save @sentry/browser @sentry/replay

with yarn:

yarn add @sentry/browser @sentry/replay

Setup

To set up the integration add the following to your Sentry initialization. Several options are supported and passable via the integration constructor. See the rrweb documentation for advice on configuring these values.

import * as Sentry from '@sentry/browser';
import { SentryReplay } from '@sentry/replay';

Sentry.init({
  dsn: '__DSN__',
  integrations: [
    new SentryReplay({
      stickySession: true, // Default is false
      recordingConfig: {
        maskAllInputs: false, // Default is true
      },
    }),
  ],
  // ...
});

Configuration

key	type	default	description
`flushMinDelay`	`number`	`5000`	The minimum time to wait (in ms) before sending the recording payload. The payload is sent if `flushMinDelay` ms have elapsed between two events.
`flushMaxDelay`	`number`	`15000`	The maximum time to wait (in ms) when sending the recording payload. The payload is sent if events occur at an interval less than `flushMinDelay` and `flushMaxDelay` ms have elapsed since the last time a payload was sent.
`initialFlushDelay`	`number`	`5000`	The amount of time to wait (in ms) before sending the initial recording payload. This helps drop recordings where users visit and close the page quickly.
`stickySession`	`boolean`	`false`	Keep track of the user across page loads. Note a single user using multiple tabs will result in multiple sessions. Closing a tab will result in the session being closed as well.
`useCompression`	`boolean`	`true`	Uses `WebWorkers` (if available) to compress the recording payload before uploading to Sentry.
`captureOnlyOnError`	`boolean`	`false`	Only capture the recording when an error happens.
`replaysSamplingRate`	`number`	`1.0`	The rate at which to sample replays. (1.0 will collect all replays, 0 will collect no replays).
`recordingConfig.maskAllInputs`	`boolean`	`true`	Mask all `<input>` elements
`recordingConfig.blockClass`	`string`	`'sr-block'`	Redact all elements with the class name `sr-block`
`recordingConfig.ignoreClass`	`string`	`'sr-ignore'`	Ignores all elements with the class name `sr-ignore`
`recordingConfig.maskTextClass`	`string`	`'sr-mask'`	Mask all elements with the class name `sr-ignore`