Skip to content

Commit 3fbf2a2

Browse files
authored
chore(otel): Update installation instructions (#6262)
1. Convert from ES modules to `require` 2. Specify to set the `instrumenter` option to turn off Sentry instrumentation 3. Clean up imports 4. Add `sdk.start` command to match otel docs: https://opentelemetry.io/docs/instrumentation/js/getting-started/nodejs/#setup
1 parent 3d9f0fd commit 3fbf2a2

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

packages/opentelemetry-node/README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,27 @@ Note that `@sentry/opentelemetry-node` depends on the following peer dependencie
3535
You need to register the `SentrySpanProcessor` and `SentryPropagator` with your OpenTelemetry installation:
3636

3737
```js
38-
import * as Sentry from '@sentry/node';
39-
import { SentrySpanProcessor } from '@sentry/opentelemetry-node';
40-
import * as otelApi from '@opentelemetry/api';
41-
import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
42-
import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-grpc';
38+
const Sentry = require("@sentry/node");
39+
const {
40+
SentrySpanProcessor,
41+
SentryPropagator,
42+
} = require("@sentry/opentelemetry-node");
43+
44+
const opentelemetry = require("@opentelemetry/sdk-node");
45+
const otelApi = require("@opentelemetry/api");
46+
const {
47+
getNodeAutoInstrumentations,
48+
} = require("@opentelemetry/auto-instrumentations-node");
49+
const {
50+
OTLPTraceExporter,
51+
} = require("@opentelemetry/exporter-trace-otlp-grpc");
4352

4453
// Make sure to call `Sentry.init` BEFORE initializing the OpenTelemetry SDK
4554
Sentry.init({
4655
dsn: '__DSN__',
56+
tracesSampleRate: 1.0,
57+
// set the instrumenter to use OpenTelemetry instead of Sentry
58+
instrumenter: 'otel',
4759
// ...
4860
});
4961

@@ -57,6 +69,8 @@ const sdk = new opentelemetry.NodeSDK({
5769
});
5870

5971
otelApi.propagation.setGlobalPropagator(new SentryPropagator());
72+
73+
sdk.start();
6074
```
6175

6276
## Links

0 commit comments

Comments
 (0)