@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.0.0-alpha.7

This is the seventh alpha release of Sentry JavaScript SDK v8, which includes a variety of breaking changes.

Read the in-depth migration guide to find out how to address any breaking changes in your code.

Important Changes

• feat(nextjs): Use OpenTelemetry for performance monitoring and tracing (#11016)

We now use OpenTelemetry under the hood to power performance monitoring and tracing in the Next.js SDK.

• feat(v8/gatsby): Update SDK initialization for gatsby (#11292)

In v8, you cannot initialize the SDK anymore via Gatsby plugin options. Instead, you have to configure the SDK in a sentry.config.js file.

We also removed the automatic initialization of browserTracingIntegration. You now have to add this integration yourself.

Removal/Refactoring of deprecated functionality

• feat(v8): Remove addGlobalEventProcessor (#11255)
• feat(v8): Remove deprecated span id fields (#11180)
• feat(v8): Remove makeMain export (#11278)
• feat(v8/core): Remove deprecated span.sampled (#11274)
• feat(v8/core): Remove getActiveTransaction (#11280)
• feat(v8/core): Remove spanMetadata field (#11271)
• feat(v8/ember): Remove deprecated StartTransactionFunction (#11270)
• feat(v8/replay): Remove deprecated replay options (#11268)
• feat(v8/svelte): Remove deprecated componentTrackingPreprocessor export (#11277)
• ref: Remove more usages of getCurrentHub in the codebase (#11281)
• ref(core): Remove scope.setSpan() and scope.getSpan() methods (#11051)
• ref(profiling-node): Remove usage of getCurrentHub (#11275)
• ref(v8): change integration.setupOnce signature (#11238)
• ref: remove node-experimental references (#11290)

Other Changes

• feat(feedback): Make "required" text for input elements configurable (#11152) (#11153)
• feat(feedback): Update user feedback screenshot and cropping to align with designs (#11227)
• feat(nextjs): Remove runtime and vercel tags (#11291)
• feat(node): Add scope to ANR events (#11256)
• feat(node): Do not include prismaIntegration by default (#11265)
• feat(node): Ensure tracePropagationTargets are respected (#11285)
• feat(node): Simplify SentrySpanProcessor (#11273)
• feat(profiling): Use OTEL powered node package (#11239)
• feat(utils): Allow text encoder/decoder polyfill from global SENTRY (#11283)
• fix(nextjs): Show misconfiguration warning (no instrumentation.ts) (#11266)
• fix(node): Add logs when node-fetch cannot be instrumented (#11289)
• fix(node): Skip capturing Hapi Boom error responses. (#11151)
• fix(node): Use suppressTracing to avoid capturing otel spans (#11288)
• fix(opentelemetry): Do not stomp span status when startSpan callback throws (#11170)