@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.0.0-beta.6

This beta release contains various bugfixes and improvements for the v8 beta cycle.

• feat: Add tunnel support to multiplexed transport (#11806)
• feat: Export spanToBaggageHeader utility (#11881)
• feat(browser): Disable standalone http.client spans (#11879)
• feat(ember): Update ember dependencies (#11753)
• feat(fedback): Convert CDN bundles to use async feedback for lower bundle sizes (#11791)
• feat(feedback): Add captureFeedback method (#11428)
• feat(feedback): Have screenshot by default (#11839)
• feat(integrations): Add zod integration (#11144)
• feat(ioredis): Add integration for ioredis (#11856)
• feat(nextjs): Add transaction name to scope of server component (#11850)
• feat(nextjs): Be smarter in warning about old ways of init configuration (#11882)
• feat(nextjs): Set transaction names on scope for route handlers and generation functions (#11869)
• feat(node): Support Node 22 (#11871)
• fix(angular): Run tracing calls outside Angular (#11748)
• fix(feedback): Be consistent about whether screenshot should and can render (#11859)
• fix(nestjs): Ensure Nest.js interceptor works with non-http context (#11880)
• fix(node): Fix nest.js error handler (#11874)
• fix(react): Fix react router v4/v5 instrumentation (#11855)
• ref: Add geo location types (#11847)