@sentry/opentelemetry

Official Sentry SDK for OpenTelemetry

This package allows you to send your OpenTelemetry trace data to Sentry via OpenTelemetry SpanProcessors.

This SDK is considered experimental and in an alpha state. It may experience breaking changes. Please reach out on GitHub if you have any feedback/concerns.

Installation

npm install @sentry/opentelemetry

# Or yarn
yarn add @sentry/opentelemetry

Note that @sentry/opentelemetry depends on the following peer dependencies:

• @opentelemetry/api version 1.0.0 or greater
• @opentelemetry/core version 1.0.0 or greater
• @opentelemetry/semantic-conventions version 1.0.0 or greater
• @opentelemetry/sdk-trace-base version 1.0.0 or greater, or a package that implements that, like @opentelemetry/sdk-node.

Usage

This package exposes a few building blocks you can add to your OpenTelemetry setup in order to capture OpenTelemetry traces to Sentry.

This is how you can use this in your app:

1. Initialize Sentry, e.g. @sentry/node!
2. Call setupEventContextTrace(client)
3. Add SentrySampler as sampler
4. Add SentrySpanProcessor as span processor
5. Add a context manager wrapped via wrapContextManagerClass
6. Add SentryPropagator as propagator
7. Setup OTEL-powered async context strategy for Sentry via setOpenTelemetryContextAsyncContextStrategy()

For example, you could set this up as follows:

import * as Sentry from '@sentry/node';
import {
  SentryPropagator,
  SentrySampler,
  SentrySpanProcessor,
  setupEventContextTrace,
  wrapContextManagerClass,
  setOpenTelemetryContextAsyncContextStrategy,
} from '@sentry/opentelemetry';
import { AsyncLocalStorageContextManager } from '@opentelemetry/context-async-hooks';

function setupSentry() {
  Sentry.init({
    dsn: 'xxx',
  });

  const client = Sentry.getClient();
  setupEventContextTrace(client);

  const provider = new BasicTracerProvider({
    sampler: new SentrySampler(client),
  });
  provider.addSpanProcessor(new SentrySpanProcessor());

  const SentryContextManager = wrapContextManagerClass(AsyncLocalStorageContextManager);

  // Initialize the provider
  provider.register({
    propagator: new SentryPropagator(),
    contextManager: new SentryContextManager(),
  });

  setOpenTelemetryContextAsyncContextStrategy();
}

A full setup example can be found in node-experimental.

Links

• Official SDK Docs

Changelog

8.23.0

Important Changes

• feat(cloudflare): Add Cloudflare D1 instrumentation (#13142)

This release includes support for Cloudflare D1, Cloudflare's serverless SQL database. To instrument your Cloudflare D1 database, use the instrumentD1WithSentry method as follows:

// env.DB is the D1 DB binding configured in your `wrangler.toml`
const db = instrumentD1WithSentry(env.DB);
// Now you can use the database as usual
await db.prepare('SELECT * FROM table WHERE id = ?').bind(1).run();

Other Changes

• feat(cloudflare): Allow users to pass handler to sentryPagesPlugin (#13192)
• feat(cloudflare): Instrument scheduled handler (#13114)
• feat(core): Add getTraceData function (#13134)
• feat(nestjs): Automatic instrumentation of nestjs interceptors before route execution (#13153)
• feat(nestjs): Automatic instrumentation of nestjs pipes (#13137)
• feat(nuxt): Filter out Nuxt build assets (#13148)
• feat(profiling): Attach sdk info to chunks (#13145)
• feat(solidstart): Add sentry onBeforeResponse middleware to enable distributed tracing (#13221)
• feat(solidstart): Filter out low quality transactions for build assets (#13222)
• fix(browser): Avoid showing browser extension error message in non-window global scopes (#13156)
• fix(feedback): Call dialog.close() in dialog close callbacks in \_loadAndRenderDialog (#13203)
• fix(nestjs): Inline Observable type to resolve missing 'rxjs' dependency (#13166)
• fix(nuxt): Detect pageload by adding flag in Vue router (#13171)
• fix(utils): Handle when requests get aborted in fetch instrumentation (#13202)
• ref(browser): Improve browserMetrics collection (#13062)

Work in this release was contributed by @horochx. Thank you for your contribution!