@sentry-internal/replay-canvas

Sentry Session Replay with Canvas

Pre-requisites

Replay with canvas requires Node 14+, and browsers newer than IE11.

Installation

Replay and ReplayCanvas can be imported from @sentry/browser, or a respective SDK package like @sentry/react or @sentry/vue. You don't need to install anything in order to use Session Replay. The minimum version that includes Replay is 7.27.0.

For details on using Replay when using Sentry via the CDN bundles, see CDN bundle.

Setup

To set up the canvas integration, add the following to your Sentry integrations:

Sentry.replayCanvasIntegration(),

Full Example

import * as Sentry from '@sentry/browser';
// or e.g. import * as Sentry from '@sentry/react';

Sentry.init({
  dsn: '__DSN__',

  // This sets the sample rate to be 10%. You may want this to be 100% while
  // in development and sample at a lower rate in production
  replaysSessionSampleRate: 0.1,

  // If the entire session is not sampled, use the below sample rate to sample
  // sessions when an error occurs.
  replaysOnErrorSampleRate: 1.0,

  integrations: [Sentry.replayIntegration(), Sentry.replayCanvasIntegration()],
  // ...
});

Changelog

8.0.0-beta.1

This is the first beta release of Sentry JavaScript SDK v8. With this release, there are no more planned breaking changes for the v8 cycle.

Read the in-depth migration guide to find out how to address any breaking changes in your code. All deprecations from the v7 cycle, with the exception of getCurrentHub(), have been removed and can no longer be used in v8.

Version Support

The Sentry JavaScript SDK v8 now supports Node.js 14.8.0 or higher. This applies to @sentry/node and all of our node-based server-side sdks (@sentry/nextjs, @sentry/remix, etc.).

The browser SDKs now require ES2018+ compatible browsers. New minimum browser versions:

• Chrome 63
• Edge 79
• Safari/iOS Safari 12
• Firefox 58
• Opera 50
• Samsung Internet 8.2

For more details, please see the version support section in migration guide.

Package removal

The following packages will no longer be published

• @sentry/hub
• @sentry/tracing
• @sentry/integrations
• @sentry/serverless
• @sentry/replay