Skip to content

Commit 2f52a45

Browse files
authored
Add OpenTelemetry Node SDK docs (#5760)
1 parent 4c39976 commit 2f52a45

File tree

3 files changed

+86
-0
lines changed

3 files changed

+86
-0
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
```bash {tabTitle:npm}
2+
npm install @sentry/node @sentry/opentelemetry-node
3+
```
4+
5+
```bash {tabTitle:yarn}
6+
yarn add @sentry/node @sentry/opentelemetry-node
7+
```
8+
9+
<Note>
10+
11+
Note that @sentry/opentelemetry-node depends on the following peer dependencies:
12+
13+
- @opentelemetry/api, version 1.0.0 or greater
14+
- @opentelemetry/sdk-trace-base, version 1.0.0 or greater, or a package that implements it, like @opentelemetry/sdk-node
15+
16+
</Note>
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
You need to register `SentrySpanProcessor` and `SentryPropagator` with your OpenTelemetry installation:
2+
3+
```js
4+
import * as Sentry from "@sentry/node";
5+
import { SentrySpanProcessor } from "@sentry/opentelemetry-node";
6+
7+
import * as otelApi from "@opentelemetry/api";
8+
import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
9+
import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-grpc";
10+
11+
// Make sure to call `Sentry.init` BEFORE initializing the OpenTelemetry SDK
12+
Sentry.init({
13+
dsn: "___PUBLIC_DSN___",
14+
// ...
15+
});
16+
17+
const sdk = new opentelemetry.NodeSDK({
18+
// Existing config
19+
traceExporter: new OTLPTraceExporter(),
20+
instrumentations: [getNodeAutoInstrumentations()],
21+
22+
// Sentry config
23+
spanProcessor: new SentrySpanProcessor(),
24+
});
25+
26+
otelApi.propagation.setGlobalPropagator(new SentryPropagator());
27+
```
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: OpenTelemetry Support
3+
sidebar_order: 20
4+
supported:
5+
- node
6+
notSupported:
7+
- javascript
8+
- python
9+
- dart
10+
- flutter
11+
- react-native
12+
- java
13+
- java.spring-boot
14+
- android
15+
- apple
16+
- dotnet
17+
- javascript.cordova
18+
- javascript.electron
19+
- go
20+
- ruby
21+
- unity
22+
- rust
23+
- native
24+
- php
25+
- native.breakpad
26+
- native.crashpad
27+
- native.minidumps
28+
- unreal
29+
- native.wasm
30+
description: "Using OpenTelemetry with Sentry Performance."
31+
---
32+
33+
<Include name="alpha-note.mdx" />
34+
35+
You can configure your [OpenTelemetry SDK](https://opentelemetry.io/) to send traces and spans to Sentry.
36+
37+
## Install
38+
39+
<PlatformContent includePath="performance/opentelemetry-install" />
40+
41+
## Usage
42+
43+
<PlatformContent includePath="performance/opentelemetry-setup" />

0 commit comments

Comments
 (0)