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

Important Changes

• feat(browser): Add CLS sources to span attributes (#16710)

Enhances CLS (Cumulative Layout Shift) spans by adding attributes detailing the elements that caused layout shifts.

• feat(cloudflare): Add instrumentWorkflowWithSentry to instrument workflows (#16672)

We've added support for Cloudflare Workflows, enabling comprehensive tracing for your workflow runs. This integration uses the workflow's instanceId as the Sentry trace_id and for sampling, linking all steps together. You'll now be able to see full traces, including retries with exponential backoff.

• feat(pino-transport): Add functionality to send logs to sentry (#16667)

Adds the ability to send logs to Sentry via a pino transport.

Other Changes

• feat(nextjs): Expose top level buildTime errorHandler option (#16718)
• feat(node): update pipeline spans to use agent naming (#16712)
• feat(deps): bump @prisma/instrumentation from 6.9.0 to 6.10.1 (#16698)
• fix(sveltekit): Export logger from sveltekit worker (#16716)
• fix(google-cloud-serverless): Make CloudEventsContext compatible with CloudEvent (#16705)
• fix(nextjs): Stop injecting release value when create release options is set to false (#16695)
• fix(node): account for Object. syntax with local variables matching (#16702)
• fix(nuxt): Add alias for @opentelemetry/resources (#16727)

Work in this release was contributed by @flaeppe. Thank you for your contribution!