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

Important Changes

• feat(solidstart): Add withSentry wrapper for SolidStart config (#15135)

To enable the SolidStart SDK, wrap your SolidStart Config with withSentry. The sentrySolidStartVite plugin is now automatically added by withSentry and you can pass the Sentry build-time options like this:

import { defineConfig } from '@solidjs/start/config';
import { withSentry } from '@sentry/solidstart';

export default defineConfig(
  withSentry(
    {
      /* Your SolidStart config options... */
    },
    {
      // Options for setting up source maps
      org: process.env.SENTRY_ORG,
      project: process.env.SENTRY_PROJECT,
      authToken: process.env.SENTRY_AUTH_TOKEN,
    },
  ),
);

With the withSentry wrapper, the Sentry server config should not be added to the public directory anymore. Add the Sentry server config in src/instrument.server.ts. Then, the server config will be placed inside the server build output as instrument.server.mjs.

Now, there are two options to set up the SDK:

1. (recommended) Provide an --import CLI flag to the start command like this (path depends on your server setup): node --import ./.output/server/instrument.server.mjs .output/server/index.mjs
2. Add autoInjectServerSentry: 'top-level-import' and the Sentry config will be imported at the top of the server entry (comes with tracing limitations)

   withSentry(
     {
       /* Your SolidStart config options... */
     },
     {
       // Optional: Install Sentry with a top-level import
       autoInjectServerSentry: 'top-level-import',
     },
   );
   

Other Changes

• feat(v8/core): Add client outcomes for breadcrumbs buffer (#15149)
• feat(v8/core): Improve error formatting in ZodErrors integration (#15155)
• fix(v8/bun): Ensure instrumentation of Bun.serve survives a server reload (#15157)
• fix(v8/core): Pass module into loadModule (#15139) (#15166)

Work in this release was contributed by @jahands, @jrandolf, and @nathankleyn. Thank you for your contributions!