Skip to content
Merged
Changes from all commits
Commits
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
38 changes: 38 additions & 0 deletions packages/opentelemetry-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,44 @@
[![npm dm](https://img.shields.io/npm/dm/@sentry/opentelemetry-node.svg)](https://www.npmjs.com/package/@sentry/opentelemetry-node)
[![npm dt](https://img.shields.io/npm/dt/@sentry/opentelemetry-node.svg)](https://www.npmjs.com/package/@sentry/opentelemetry-node)

## Installation

```bash
npm install @sentry/node @sentry/opentelemetry-node

# Or yarn
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`.

## Usage

You need to register the SentrySpanProcessor with your OpenTelemetry installation:

```js
import * as Sentry from '@sentry/node';
import { SentrySpanProcessor } from '@sentry/opentelemetry-node';

// Make sure to call this BEFORE setting up OpenTelemetry
Sentry.init({
dsn: '__DSN__',
// ...
});

const sdk = new opentelemetry.NodeSDK({
// Existing config
traceExporter: new OTLPTraceExporter(),
instrumentations: [ getNodeAutoInstrumentations() ],

// Sentry config
spanProcessor: new SentrySpanProcessor()
})
```

## Links

- [Official SDK Docs](https://docs.sentry.io/quickstart/)
Expand Down