@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.14.0

Important Changes

• feat(nestjs): Filter 4xx errors (#12695)

The @sentry/nestjs SDK no longer captures 4xx errors automatically.

Other Changes

• chore(react): Remove private namespace JSX (#12691)
• feat(deps): bump @opentelemetry/propagator-aws-xray from 1.25.0 to 1.25.1 (#12719)
• feat(deps): bump @prisma/instrumentation from 5.16.0 to 5.16.1 (#12718)
• feat(node): Add registerEsmLoaderHooks option (#12684)
• feat(opentelemetry): Expose sampling helper (#12674)
• fix(browser): Make sure measure spans have valid start timestamps (#12648)
• fix(hapi): Widen type definitions (#12710)
• fix(nextjs): Attempt to ignore critical dependency warnings (#12694)
• fix(react): Fix React jsx runtime import for esm (#12740)
• fix(replay): Start replay in afterAllSetup instead of next tick (#12709)

Work in this release was contributed by @quisido. Thank you for your contribution!