@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

10.17.0

Important Changes

• feat(nuxt): Implement server middleware instrumentation (#17796)

  This release introduces instrumentation for Nuxt middleware, ensuring that all middleware handlers are automatically wrapped with tracing and error reporting functionality.

• fix(aws-serverless): Take http_proxy into account when choosing useLayerExtension default (#17817)

  The default setting for useLayerExtension now considers the http_proxy environment variable. When http_proxy is set, useLayerExtension will be off by default. If you use a http_proxy but would still like to make use of the Sentry Lambda extension, exempt localhost in a no_proxy environment variable.

Other Changes

• feat(node): Split up http integration into composable parts (#17524)
• fix(core): Remove check and always respect ai.telemetry.functionId for Vercel AI gen spans (#17811)
• doc(core): Fix outdated JSDoc in beforeSendSpan (#17815)

<details> <summary> <strong>Internal Changes</strong> </summary>

• ci: Do not run dependabot on e2e test applications (#17813)
• docs: Reword changelog for google gen ai integration (#17805)

</details>