@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

9.5.0

Important Changes

We found some issues with the new feedback screenshot annotation where screenshots are not being generated properly. Due to this issue, we are reverting the feature.

• Revert "feat(feedback) Allowing annotation via highlighting & masking (#15484)" (#15609)

Other Changes

• Add cloudflare adapter detection and path generation (#15603)
• deps(nextjs): Bump rollup to 4.34.9 (#15589)
• feat(bun): Automatically add performance integrations (#15586)
• feat(replay): Bump rrweb to 2.34.0 (#15580)
• fix(browser): Call original function on early return from patched history API (#15576)
• fix(nestjs): Copy metadata in custom decorators (#15598)
• fix(react-router): Fix config type import (#15583)
• fix(remix): Use correct types export for @sentry/remix/cloudflare (#15599)
• fix(vue): Attach Pinia state only once per event (#15588)

Work in this release was contributed by @msurdi-a8c, @namoscato, and @rileyg98. Thank you for your contributions!