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

Important Changes

• feat(browser): Add debugId sync APIs between web worker and main thread (#16981)

This release adds two Browser SDK APIs to let the main thread know about debugIds of worker files:

• webWorkerIntegration({worker}) to be used in the main thread
• registerWebWorker({self}) to be used in the web worker

// main.js
Sentry.init({...})

const worker = new MyWorker(...);

Sentry.addIntegration(Sentry.webWorkerIntegration({ worker }));

worker.addEventListener('message', e => {...});

// worker.js
Sentry.registerWebWorker({ self });

self.postMessage(...);

• feat(core): Deprecate logger in favor of debug (#17040)

The internal SDK logger export from @sentry/core has been deprecated in favor of the debug export. debug only exposes log, warn, and error methods but is otherwise identical to logger. Note that this deprecation does not affect the logger export from other packages (like @sentry/browser or @sentry/node) which is used for Sentry Logging.

import { logger, debug } from '@sentry/core';

// before
logger.info('This is an info message');

// after
debug.log('This is an info message');

• feat(node): Add OpenAI integration (#17022)

This release adds official support for instrumenting OpenAI SDK calls in with Sentry tracing, following OpenTelemetry semantic conventions for Generative AI. It instruments:

• client.chat.completions.create() - For chat-based completions
• client.responses.create() - For the responses API

// The integration respects your `sendDefaultPii` option, but you can override the behavior in the integration options

Sentry.init({
  dsn: '__DSN__',
  integrations: [
    Sentry.openAIIntegration({
      recordInputs: true, // Force recording prompts
      recordOutputs: true, // Force recording responses
    }),
  ],
});

Other Changes

• feat(node-core): Expand @opentelemetry/instrumentation range to cover 0.203.0 (#17043)
• fix(cloudflare): Ensure errors get captured from durable objects (#16838)
• fix(sveltekit): Ensure server errors from streamed responses are sent (#17044)

Work in this release was contributed by @0xbad0c0d3 and @tommy-gilligan. Thank you for your contributions!