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

Important Changes

• feat(cloudflare): Add plugin for cloudflare pages (#13123)

This release adds support for Cloudflare Pages to @sentry/cloudflare, our SDK for the Cloudflare Workers JavaScript Runtime! For details on how to use it, please see the README. Any feedback/bug reports are greatly appreciated, please reach out on GitHub.

// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
  dsn: __PUBLIC_DSN__,
  // Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
  tracesSampleRate: 1.0,
});

Other Changes

• feat(meta-sdks): Remove runtime tags (#13105)
• feat(nestjs): Automatic instrumentation of nestjs guards (#13129)
• feat(nestjs): Filter all HttpExceptions (#13120)
• feat(replay): Capture exception when internal_sdk_error client report happens (#13072)
• fix: Use globalThis for code injection (#13132)