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

Important Changes

• feat(nextjs/vercel-edge/cloudflare): Switch to OTEL for performance monitoring (#13889)

With this release, the Sentry Next.js, and Cloudflare SDKs will now capture performance data based on OpenTelemetry. Some exceptions apply in cases where Next.js captures inaccurate data itself.

NOTE: You may experience minor differences in transaction names in Sentry. Most importantly transactions for serverside pages router invocations will now be named GET /[param]/my/route instead of /[param]/my/route. This means that those transactions are now better aligned with the OpenTelemetry semantic conventions.

Other Changes

• deps: Bump bundler plugins and CLI to 2.22.6 and 2.37.0 respectively (#14050)
• feat(deps): bump @opentelemetry/instrumentation-aws-sdk from 0.44.0 to 0.45.0 (#14099)
• feat(deps): bump @opentelemetry/instrumentation-connect from 0.39.0 to 0.40.0 (#14101)
• feat(deps): bump @opentelemetry/instrumentation-express from 0.43.0 to 0.44.0 (#14102)
• feat(deps): bump @opentelemetry/instrumentation-fs from 0.15.0 to 0.16.0 (#14098)
• feat(deps): bump @opentelemetry/instrumentation-kafkajs from 0.3.0 to 0.4.0 (#14100)
• feat(nextjs): Add method and url to route handler request data (#14084)
• feat(node): Add breadcrumbs for child_process and worker_thread (#13896)
• fix(core): Ensure standalone spans are not sent if SDK is disabled (#14088)
• fix(nextjs): Await flush in api handlers (#14023)
• fix(nextjs): Don't leak webpack types into exports (#14116)
• fix(nextjs): Fix matching logic for file convention type for root level components (#14038)
• fix(nextjs): Respect directives in value injection loader (#14083)
• fix(nuxt): Only wrap .mjs entry files in rollup (#14060)
• fix(nuxt): Re-export all exported bindings (#14086)
• fix(nuxt): Server-side setup in readme (#14049)
• fix(profiling-node): Always warn when running on incompatible major version of Node.js (#14043)
• fix(replay): Fix onError callback (#14002)
• perf(otel): Only calculate current timestamp once (#14094)
• test(browser-integration): Add sentry DSN route handler by default (#14095)