Skip to content

chore(otel): Update README to add alpha note #6169

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
AbhiPrasad merged 2 commits into from
Nov 9, 2022
Merged

chore(otel): Update README to add alpha note #6169

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2cb29e
chore(otel): Update README to add alpha note
AbhiPrasad Nov 9, 2022
ace0f34
Update packages/opentelemetry-node/README.md
AbhiPrasad Nov 9, 2022
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
9 changes: 5 additions & 4 deletions packages/opentelemetry-node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@
[![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)

This package allows you to send your NodeJS OpenTelemetry trace data to Sentry via OpenTelemetry SpanProcessors.
Copy link
Member

@mydea mydea Nov 9, 2022

Choose a reason for hiding this comment

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

l: We maybe also want to mention that this only affects performance/transaction data, not errors, but we can also further extend on this readme later.

Copy link
Member Author

@AbhiPrasad AbhiPrasad Nov 9, 2022

Choose a reason for hiding this comment

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

I thought about this, but given we might add the ability to capture errors I thought against it. Maybe later!


This SDK is **considered experimental and in an alpha state**. It may experience breaking changes. Please reach out on
[GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback/concerns.

## Installation

```bash
Expand Down Expand Up @@ -55,7 +60,3 @@ otelApi.propagation.setGlobalPropagator(new SentryPropagator());
## Links

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

## Usage

TODO