Skip to content

chore(otel): Update README to add SentryPropagator info #6126

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
merged 1 commit into from
Nov 3, 2022
Merged

chore(otel): Update README to add SentryPropagator info #6126

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 11 additions & 7 deletions packages/opentelemetry-node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__',
// ...
Expand All @@ -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
Expand Down