Skip to content

Add OpenTelemetry Node SDK docs #5760

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.

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 8 commits into from
Nov 16, 2022
Merged
Show file tree
Hide file tree
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
16 changes: 16 additions & 0 deletions src/platform-includes/performance/opentelemetry-install/node.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
```bash {tabTitle:npm}
npm install @sentry/node @sentry/opentelemetry-node
```

```bash {tabTitle:yarn}
yarn add @sentry/node @sentry/opentelemetry-node
```

<Note>

Note that @sentry/opentelemetry-node depends on the following peer dependencies:

- @opentelemetry/api, version 1.0.0 or greater
- @opentelemetry/sdk-trace-base, version 1.0.0 or greater, or a package that implements it, like @opentelemetry/sdk-node

</Note>
Comment on lines +9 to +16
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the note about dependencies come before the install step?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

personally I find it better placed below (so the flow: this is how to install sentry. But make sure that you also have these dependencies installed). But we can of course still adjust this later as well! :)

27 changes: 27 additions & 0 deletions src/platform-includes/performance/opentelemetry-setup/node.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
You need to register `SentrySpanProcessor` and `SentryPropagator` with your OpenTelemetry installation:

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

import * as otelApi from "@opentelemetry/api";
import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-grpc";

// Make sure to call `Sentry.init` BEFORE initializing the OpenTelemetry SDK
Sentry.init({
dsn: "___PUBLIC_DSN___",
// ...
});

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

// Sentry config
spanProcessor: new SentrySpanProcessor(),
});

otelApi.propagation.setGlobalPropagator(new SentryPropagator());
```
43 changes: 43 additions & 0 deletions src/platforms/common/performance/instrumentation/opentelemetry.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: OpenTelemetry Support
sidebar_order: 20
supported:
- node
notSupported:
- javascript
- python
- dart
- flutter
- react-native
- java
- java.spring-boot
- android
- apple
- dotnet
- javascript.cordova
- javascript.electron
- go
- ruby
- unity
- rust
- native
- php
- native.breakpad
- native.crashpad
- native.minidumps
- unreal
- native.wasm
description: "Using OpenTelemetry with Sentry Performance."
---

<Include name="alpha-note.mdx" />

You can configure your [OpenTelemetry SDK](https://opentelemetry.io/) to send traces and spans to Sentry.

## Install

<PlatformContent includePath="performance/opentelemetry-install" />

## Usage

<PlatformContent includePath="performance/opentelemetry-setup" />