Skip to content

Commit c2b4650

Browse files
authored
chore(otel): Update README to add SentryPropagator info (#6126)
1 parent 492dad7 commit c2b4650

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

packages/opentelemetry-node/README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,20 @@ yarn add @sentry/node @sentry/opentelemetry-node
2121

2222
Note that `@sentry/opentelemetry-node` depends on the following peer dependencies:
2323

24-
* `@opentelemetry/api` version 1 or greater
25-
* `@opentelemetry/sdk-trace-base` version 1 or greater, or a package that implements that, like `@opentelemetry/sdk-node`.
24+
- `@opentelemetry/api` version `1.0.0` or greater
25+
- `@opentelemetry/sdk-trace-base` version `1.0.0` or greater, or a package that implements that, like
26+
`@opentelemetry/sdk-node`.
2627

2728
## Usage
2829

29-
You need to register the SentrySpanProcessor with your OpenTelemetry installation:
30+
You need to register the `SentrySpanProcessor` and `SentryPropagator` with your OpenTelemetry installation:
3031

3132
```js
3233
import * as Sentry from '@sentry/node';
34+
import * as otelApi from '@opentelemetry/api';
3335
import { SentrySpanProcessor } from '@sentry/opentelemetry-node';
3436

35-
// Make sure to call this BEFORE setting up OpenTelemetry
37+
// Make sure to call `Sentry.init` BEFORE initializing the OpenTelemetry SDK
3638
Sentry.init({
3739
dsn: '__DSN__',
3840
// ...
@@ -41,11 +43,13 @@ Sentry.init({
4143
const sdk = new opentelemetry.NodeSDK({
4244
// Existing config
4345
traceExporter: new OTLPTraceExporter(),
44-
instrumentations: [ getNodeAutoInstrumentations() ],
46+
instrumentations: [getNodeAutoInstrumentations()],
4547

4648
// Sentry config
47-
spanProcessor: new SentrySpanProcessor()
48-
})
49+
spanProcessor: new SentrySpanProcessor(),
50+
});
51+
52+
otelApi.propagation.setGlobalPropagator(new SentryPropagator());
4953
```
5054

5155
## Links

0 commit comments

Comments
 (0)