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

Important Changes

• feat(nuxt): Add Cloudflare Nitro plugin (#15597)

  A Nitro plugin for @sentry/nuxt which initializes Sentry when deployed to Cloudflare (cloudflare-pages preset).

  • Remove the previous server config file: sentry.server.config.ts

  • Add a plugin in server/plugins (e.g. server/plugins/sentry-cloudflare-setup.ts)

  • Add this code in your plugin file

    // server/plugins/sentry-cloudflare-setup.ts (filename does not matter)
    import { sentryCloudflareNitroPlugin } from '@sentry/nuxt/module/plugins';
    
    export default defineNitroPlugin(
      sentryCloudflareNitroPlugin({
        dsn: 'https://dsn',
        tracesSampleRate: 1.0,
      }),
    );
    

    or with access to nitroApp:

    // server/plugins/sentry-cloudflare-setup.ts (filename does not matter)
    import { sentryCloudflareNitroPlugin } from '@sentry/nuxt/module/plugins';
    
    export default defineNitroPlugin(sentryCloudflareNitroPlugin((nitroApp: NitroApp) => {
      // You can access nitroApp here if needed
      return  ({
        dsn: 'https://dsn',
        tracesSampleRate: 1.0,
      })
    }))
    

Other Changes

• feat(browser): Record standalone LCP spans (#16591)
• fix(nuxt): Only add OTel alias in dev mode (#16756)