Skip to content

Commit

Permalink
chore(otel): Add basic usage instructions to readme (#6094)
Browse files Browse the repository at this point in the history
  • Loading branch information
mydea committed Nov 2, 2022
1 parent 621e0b3 commit cfa196b
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions packages/opentelemetry-node/README.md
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

0 comments on commit cfa196b

Please sign in to comment.