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

Important Changes

• meta(nuxt): Require minimum Nuxt v3.7.0 (#14473)

  We formalized that the Nuxt SDK is at minimum compatible with Nuxt version 3.7.0 and above. Additionally, the SDK requires the implicit nitropack dependency to satisfy version ^2.10.0 and ofetch to satisfy ^1.4.0. It is recommended to check your lock-files and manually upgrade these dependencies if they don't match the version ranges.

Deprecations

We are deprecating a few APIs which will be removed in the next major.

The following deprecations will potentially affect you:

• feat(core): Update & deprecate undefined option handling (#14450)

  In the next major version we will change how passing undefined to tracesSampleRate / tracesSampler / enableTracing will behave.

  Currently, doing the following:

  Sentry.init({
    tracesSampleRate: undefined,
  });
  

  Will result in tracing being enabled (although no spans will be generated) because the tracesSampleRate key is present in the options object. In the next major version, this behavior will be changed so that passing undefined (or rather having a tracesSampleRate key) will result in tracing being disabled, the same as not passing the option at all. If you are currently relying on undefined being passed, and and thus have tracing enabled, it is recommended to update your config to set e.g. tracesSampleRate: 0 instead, which will also enable tracing in v9.

  The same applies to tracesSampler and enableTracing.

• feat(core): Log warnings when returning null in beforeSendSpan (#14433)

  Currently, the beforeSendSpan option in Sentry.init() allows you to drop individual spans from a trace by returning null from the hook. Since this API lends itself to creating "gaps" inside traces, we decided to change how this API will work in the next major version.

  With the next major version the beforeSendSpan API can only be used to mutate spans, but no longer to drop them. With this release the SDK will warn you if you are using this API to drop spans. Instead, it is recommended to configure instrumentation (i.e. integrations) directly to control what spans are created.

  Additionally, with the next major version, root spans will also be passed to beforeSendSpan.

• feat(utils): Deprecate @sentry/utils (#14431)

  With the next major version the @sentry/utils package will be merged into the @sentry/core package. It is therefore no longer recommended to use the @sentry/utils package.

• feat(vue): Deprecate configuring Vue tracing options anywhere else other than through the vueIntegration's tracingOptions option (#14385)

  Currently it is possible to configure tracing options in various places in the Sentry Vue SDK:

  • In Sentry.init()
  • Inside tracingOptions in Sentry.init()
  • In the vueIntegration() options
  • Inside tracingOptions in the vueIntegration() options

  Because this is a bit messy and confusing to document, the only recommended way to configure tracing options going forward is through the tracingOptions in the vueIntegration(). The other means of configuration will be removed in the next major version of the SDK.

• feat: Deprecate registerEsmLoaderHooks.include and registerEsmLoaderHooks.exclude (#14486)

  Currently it is possible to define registerEsmLoaderHooks.include and registerEsmLoaderHooks.exclude options in Sentry.init() to only apply ESM loader hooks to a subset of modules. This API served as an escape hatch in case certain modules are incompatible with ESM loader hooks.

  Since this API was introduced, a way was found to only wrap modules that there exists instrumentation for (meaning a vetted list). To only wrap modules that have instrumentation, it is recommended to instead set registerEsmLoaderHooks.onlyIncludeInstrumentedModules to true.

  Note that onlyIncludeInstrumentedModules: true will become the default behavior in the next major version and the registerEsmLoaderHooks will no longer accept fine-grained options.

The following deprecations will most likely not affect you unless you are building an SDK yourself:

• feat(core): Deprecate arrayify (#14405)
• feat(core): Deprecate flatten (#14454)
• feat(core): Deprecate urlEncode (#14406)
• feat(core): Deprecate validSeverityLevels (#14407)
• feat(core/utils): Deprecate getNumberOfUrlSegments (#14458)
• feat(utils): Deprecate memoBuilder, BAGGAGE_HEADER_NAME, and makeFifoCache (#14434)
• feat(utils/core): Deprecate addRequestDataToEvent and extractRequestData (#14430)

Other Changes

• feat: Streamline sentry-trace, baggage and DSC handling (#14364)
• feat(core): Further optimize debug ID parsing (#14365)
• feat(node): Add openTelemetryInstrumentations option (#14484)
• feat(nuxt): Add filter for not found source maps (devtools) (#14437)
• feat(nuxt): Only delete public source maps (#14438)
• fix(nextjs): Don't report NEXT_REDIRECT from browser (#14440)
• perf(opentelemetry): Bucket spans for cleanup (#14154)

Work in this release was contributed by @NEKOYASAN and @fmorett. Thank you for your contributions!