Skip to content

docs(opentelemetry): Point README to documentation #24642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicohrubec merged 3 commits into from
Sep 23, 2026
+8 −90
Merged

docs(opentelemetry): Point README to documentation #24642

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ade8e31
docs(opentelemetry): Point README to documentation
nicohrubec Sep 23, 2026
9899618
docs: Resolve new documentation links within the branch
nicohrubec Sep 23, 2026
d14f8a8
docs: Link OpenTelemetry README to public setup guides
nicohrubec Sep 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 8 additions & 90 deletions packages/opentelemetry/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,97 +10,15 @@
[![npm dm](https://img.shields.io/npm/dm/@sentry/opentelemetry.svg)](https://www.npmjs.com/package/@sentry/opentelemetry)
[![npm dt](https://img.shields.io/npm/dt/@sentry/opentelemetry.svg)](https://www.npmjs.com/package/@sentry/opentelemetry)

This package allows you to send your OpenTelemetry trace data to Sentry via OpenTelemetry SpanProcessors.
OpenTelemetry support for Sentry’s JavaScript SDKs.

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.
## Documentation

## Installation
- [OpenTelemetry documentation](https://docs.sentry.io/platforms/javascript/guides/node/opentelemetry/)
- [Capture spans from OpenTelemetry APIs](https://docs.sentry.io/platforms/javascript/guides/node/opentelemetry/using-opentelemetry-apis/)
- [Use your own OpenTelemetry pipeline](https://docs.sentry.io/platforms/javascript/guides/node/opentelemetry/custom-setup/)

```bash
npm install @sentry/opentelemetry
## Support

# Or yarn
yarn add @sentry/opentelemetry
```

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

- `@opentelemetry/api` version `1.0.0` or greater

## 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. Register the Sentry context manager (`SentryAsyncLocalStorageContextManager`, or `wrapContextManagerClass` for a custom base)
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:

```js
import * as Sentry from '@sentry/node';
import {
SentryAsyncLocalStorageContextManager,
SentryPropagator,
SentrySampler,
SentrySpanProcessor,
setupEventContextTrace,
setOpenTelemetryContextAsyncContextStrategy,
} from '@sentry/opentelemetry';
import { context, propagation, trace } from '@opentelemetry/api';

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

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

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

// Initialize the provider
trace.setGlobalTracerProvider(provider);
context.setGlobalContextManager(new SentryAsyncLocalStorageContextManager());

setOpenTelemetryContextAsyncContextStrategy();
}
```

A full setup example can be found in
[node-experimental](https://github.com/getsentry/sentry-javascript/blob/develop/packages/node-experimental).

## Sentry Tracer Provider

`SentryTracerProvider` is a minimal OpenTelemetry tracer provider which creates native Sentry spans directly.
It is useful when code uses the global OpenTelemetry API and you do not need the full OpenTelemetry SDK span processor
and exporter pipeline.

```js
import { trace } from '@opentelemetry/api';
import { SentryTracerProvider } from '@sentry/opentelemetry';

trace.setGlobalTracerProvider(new SentryTracerProvider());

const span = trace.getTracer('example').startSpan('work');
span.end();
```

In `@sentry/node`, this is the default tracer provider.

The `SentryTracerProvider` does not handle OpenTelemetry logs and metrics.

## Links

- [Official SDK Docs](https://docs.sentry.io/quickstart/)
- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose)
- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)
Loading