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

Important Changes

• feat(node): Allow to pass registerEsmLoaderHooks to preload (#12998)

You can write your own custom preload script and configure this in the preload options. registerEsmLoaderHooks can be passed as an option to preloadOpenTelemetry, which allows to exclude/include packages in the preload.

• fix(node): Do not emit fetch spans when tracing is disabled (#13003)

Sentry will not emit "fetch" spans if tracing is disabled. This is relevant for user who use their own sampler.

Other Changes

• feat(feedback): Trigger button aria label configuration (#13008)
• feat(nestjs): Change nest sdk setup (#12920)
• feat(node): Extend ESM hooks options for iitm v1.10.0 (#13016)
• feat(node): Send client reports (#12951)
• feat(nuxt): Automatically add BrowserTracing (#13005)
• feat(nuxt): Setup source maps with vite config (#13018)
• feat(replay): Improve public Replay APIs (#13000)