@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

Important Changes since v8.0.0-alpha.9

• feat(browser): Create spans as children of root span by default (#10986)

Because execution context isolation in browser environments does not work reliably, we deciced to keep a flat span hierarchy by default in v8.

• feat(core): Deprecate addTracingExtensions (#11579)

Instead of calling Sentry.addTracingExtensions() if you want to use performance in a browser SDK without using browserTracingIntegration(), you should now call Sentry.registerSpanErrorInstrumentation().

• feat(core): Implement suppressTracing (#11468)

You can use the new suppressTracing API to ensure a given callback will not generate any spans:

return Sentry.suppressTracing(() => {
  // Ensure this fetch call does not generate a span
  return fetch('/my-url');
});

• feat: Rename ESM loader hooks to import and loader (#11498)

We renamed the loader hooks for better clarity: