@sentry/opentelemetry

Official Sentry SDK for OpenTelemetry

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

If you are using @sentry/node, OpenTelemetry support is included out of the box. This package is only necessary if you are setting up OpenTelemetry support for Sentry yourself.

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:

• Initialize Sentry, e.g. @sentry/node!
• Call setupEventContextTrace(client)
• Add SentrySampler as sampler
• Add SentrySpanProcessor as span processor
• Add a context manager wrapped via wrapContextManagerClass
• Add SentryPropagator as propagator
• 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

9.6.0

Important Changes

• feat(tanstackstart): Add @sentry/tanstackstart-react package and make @sentry/tanstackstart package a utility package (#15629)

  Since TanStack Start is supposed to be a generic framework that supports libraries like React and Solid, the @sentry/tanstackstart SDK package was renamed to @sentry/tanstackstart-react to reflect that the SDK is specifically intended to be used for React TanStack Start applications. Note that the TanStack Start SDK is still in alpha status and may be subject to breaking changes in non-major package updates.

Other Changes

• feat(astro): Accept all vite-plugin options (#15638)
• feat(deps): bump @sentry/webpack-plugin from 3.2.1 to 3.2.2 (#15627)
• feat(tanstackstart): Refine initial API (#15574)
• fix(core): Ensure fill only patches functions (#15632)
• fix(nextjs): Consider pageExtensions when looking for instrumentation file (#15701)
• fix(remix): Null-check options (#15610)
• fix(sveltekit): Correctly parse angle bracket type assertions for auto instrumentation (#15578)
• fix(sveltekit): Guard process variable (#15605)

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