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

Important Changes

• Beta releases of official Solid and SolidStart Sentry SDKs

This release marks the beta releases of the @sentry/solid and @sentry/solidstart Sentry SDKs. For details on how to use them, check out the Sentry Solid SDK README and the Sentry SolidStart SDK README respectively. Please reach out on GitHub if you have any feedback or concerns.

• feat(node): Option to only wrap instrumented modules (#13139)

Adds the SDK option to only wrap ES modules with import-in-the-middle that specifically need to be instrumented.

import * as Sentry from '@sentry/node';

Sentry.init({
  dsn: '__PUBLIC_DSN__',
  registerEsmLoaderHooks: { onlyIncludeInstrumentedModules: true },
});

• feat(node): Update OpenTelemetry packages to instrumentation v0.53.0 (#13587)

All internal OpenTelemetry instrumentation was updated to their latest version. This adds support for Mongoose v7 and v8 and fixes various bugs related to ESM mode.

Other Changes

• feat(nextjs): Emit warning when using turbopack (#13566)
• feat(nextjs): Future-proof Next.js config options overriding (#13586)
• feat(node): Add generic-pool integration (#13465)
• feat(nuxt): Upload sourcemaps generated by Nitro (#13382)
• feat(solidstart): Add browserTracingIntegration by default (#13561)
• feat(solidstart): Add sentrySolidStartVite plugin to simplify source maps upload (#13493)
• feat(vue): Only start UI spans if parent is available (#13568)
• fix(cloudflare): Guard context.waitUntil call in request handler (#13549)
• fix(gatsby): Fix assets path for sourcemaps upload (#13592)
• fix(nextjs): Use posix paths for sourcemap uploads (#13603)
• fix(node-fetch): Use stringified origin url (#13581)
• fix(node): Replace dashes in generic-pool span origins with underscores (#13579)
• fix(replay): Fix types in WebVitalData (#13573)
• fix(replay): Improve replay web vital types (#13602)
• fix(utils): Keep logger on carrier (#13570)

Work in this release was contributed by @Zen-cronic. Thank you for your contribution!