@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:

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.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.6.1 and ofetch to satisfy ^1.3.3. 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!