From c2b4650efd257b249c6a46f5f4facc012d1dfaae Mon Sep 17 00:00:00 2001 From: Abhijeet Prasad Date: Thu, 3 Nov 2022 13:21:08 +0100 Subject: [PATCH] chore(otel): Update README to add SentryPropagator info (#6126) --- packages/opentelemetry-node/README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/packages/opentelemetry-node/README.md b/packages/opentelemetry-node/README.md index 190efbd22073..a3202801fd3d 100644 --- a/packages/opentelemetry-node/README.md +++ b/packages/opentelemetry-node/README.md @@ -21,18 +21,20 @@ yarn add @sentry/node @sentry/opentelemetry-node Note that `@sentry/opentelemetry-node` depends on the following peer dependencies: -* `@opentelemetry/api` version 1 or greater -* `@opentelemetry/sdk-trace-base` version 1 or greater, or a package that implements that, like `@opentelemetry/sdk-node`. +- `@opentelemetry/api` 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 -You need to register the SentrySpanProcessor with your OpenTelemetry installation: +You need to register the `SentrySpanProcessor` and `SentryPropagator` with your OpenTelemetry installation: ```js import * as Sentry from '@sentry/node'; +import * as otelApi from '@opentelemetry/api'; import { SentrySpanProcessor } from '@sentry/opentelemetry-node'; -// Make sure to call this BEFORE setting up OpenTelemetry +// Make sure to call `Sentry.init` BEFORE initializing the OpenTelemetry SDK Sentry.init({ dsn: '__DSN__', // ... @@ -41,11 +43,13 @@ Sentry.init({ const sdk = new opentelemetry.NodeSDK({ // Existing config traceExporter: new OTLPTraceExporter(), - instrumentations: [ getNodeAutoInstrumentations() ], + instrumentations: [getNodeAutoInstrumentations()], // Sentry config - spanProcessor: new SentrySpanProcessor() -}) + spanProcessor: new SentrySpanProcessor(), +}); + +otelApi.propagation.setGlobalPropagator(new SentryPropagator()); ``` ## Links