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({
      maskAllText:  true, // Will mask all text strings
      recordingConfig: {
        maskAllInputs: false, // Default is true
      },
    }),
  ],
  // ...
});

Stop Recording

Replay recording only starts automatically when it is included in the integrations key when calling Sentry.init. Otherwise you can initialize the plugin and manually call the start() method on the integration instance. To stop recording you can call the stop().

const replay = new SentryReplay(); // This will *NOT* begin recording replays

replay.start(); // Start recording

replay.stop(); // Stop recording

Configuration