@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-rc.0

This is the first release candidate of Sentry JavaScript SDK v8.

We recommend to read the detailed migration guide in the docs.

Important Changes

• feat(node): Support hapi v21 & fix E2E test (#11906)

We now support hapi v21 and added tests for it.

• feat(node): Warn if ESM mode is detected (#11914)

When running Sentry in ESM mode, we will now warn you that this is not supported as of now. We are working on ensuring support with ESM builds.

Other Changes

• feat(feedback): Iterate on css for better scrolling & resizing when browser is small (#11893)
• fix(node): Ensure prisma integration creates valid DB spans (#11908)
• fix(node): Include loader hook files in package.json (#11911)