From ccb3ad69ef6a914a0666953b095084704e3972c1 Mon Sep 17 00:00:00 2001 From: Abhijeet Prasad Date: Wed, 9 Nov 2022 14:53:16 +0100 Subject: [PATCH] chore(otel): Update README to add alpha note (#6169) Co-authored-by: Lukas Stracke --- packages/opentelemetry-node/README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/packages/opentelemetry-node/README.md b/packages/opentelemetry-node/README.md index a3202801fd3d..859dea93c8e8 100644 --- a/packages/opentelemetry-node/README.md +++ b/packages/opentelemetry-node/README.md @@ -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. + +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 @@ -55,7 +60,3 @@ otelApi.propagation.setGlobalPropagator(new SentryPropagator()); ## Links - [Official SDK Docs](https://docs.sentry.io/quickstart/) - -## Usage - -TODO