@sentry/node 8.0.0-alpha.1 → 8.0.0-alpha.3

package/README.md

@@ -4,36 +4,28 @@
   </a>
 </p>
 
-# Official Sentry SDK for Node (EXPERIMENTAL)
+# Official Sentry SDK for Node
 
-[![npm version](https://img.shields.io/npm/v/@sentry/node-experimental.svg)](https://www.npmjs.com/package/@sentry/node-experimental)
-[![npm dm](https://img.shields.io/npm/dm/@sentry/node-experimental.svg)](https://www.npmjs.com/package/@sentry/node-experimental)
-[![npm dt](https://img.shields.io/npm/dt/@sentry/node-experimental.svg)](https://www.npmjs.com/package/@sentry/node-experimental)
-
-This is a WIP, proof of concept implementation of a Node SDK that uses OpenTelemetry for performance instrumentation under the hood.
-
-THIS MAY/WILL BREAK IN MANY UNEXPECTED WAYS. We may remove, add, change any of the integrations, add/remove any exports, etc.
-This package is **NOT READY TO USE IN ANY FORM OF PRODUCTION ENVIRONMENT**!
-
-This SDK is **considered experimental and in an alpha state**. It may experience breaking changes, and may be discontinued at any time. Please reach out on
-[GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback/concerns.
+[![npm version](https://img.shields.io/npm/v/@sentry/node.svg)](https://www.npmjs.com/package/@sentry/node)
+[![npm dm](https://img.shields.io/npm/dm/@sentry/node.svg)](https://www.npmjs.com/package/@sentry/node)
+[![npm dt](https://img.shields.io/npm/dt/@sentry/node.svg)](https://www.npmjs.com/package/@sentry/node)
 
 ## Installation
 
 ```bash
-npm install @sentry/node-experimental
+npm install @sentry/node
 
 # Or yarn
-yarn add @sentry/node-experimental
+yarn add @sentry/node
 ```
 
 ## Usage
 
 ```js
 // CJS Syntax
-const Sentry = require('@sentry/node-experimental');
+const Sentry = require('@sentry/node');
 // ESM Syntax
-import * as Sentry from '@sentry/node-experimental';
+import * as Sentry from '@sentry/node';
 
 Sentry.init({
   dsn: '__DSN__',
@@ -43,65 +35,12 @@ Sentry.init({
 
 Note that it is necessary to initialize Sentry **before you import any package that may be instrumented by us**.
 
-## Status of this Experiment
-
-Currently, this SDK:
-
-* Will capture errors (same as @sentry/node)
-* Auto-instrument for performance - see below for which performance integrations are available.
-* Provide _some_ manual instrumentation APIs
-* Sync OpenTelemetry Context with our Sentry Hub/Scope
-
-### Manual Instrumentation
-
-You can manual instrument using the following APIs:
-
-```js
-const Sentry = require('@sentry/node-experimental');
-
-Sentry.startSpan({ description: 'outer' }, function (span) {
-  span.setData(customData);
-  doSomethingSlow();
-  Sentry.startSpan({ description: 'inner' }, function() {
-    // inner span is a child of outer span
-    doSomethingVerySlow();
-    // inner span is auto-ended when this callback ends
-  });
-  // outer span is auto-ended when this callback ends
-});
-```
-
-You can also create spans without marking them as the active span.
-Note that for most scenarios, we recommend the `startSpan` syntax.
-
-```js
-const Sentry = require('@sentry/node-experimental');
-
-// This will _not_ be put on the scope/set as active, so no other spans will be attached to it
-const span = Sentry.startInactiveSpan({ description: 'non-active span' });
-
-doSomethingSlow();
-
-span.end();
-```
-
-Finally you can also get the currently active span, if you need to do more with it:
-
-```js
-const Sentry = require('@sentry/node-experimental');
-const span = Sentry.getActiveSpan();
-```
-
-### Async Context
-
-We leverage the OpenTelemetry context forking in order to ensure isolation of parallel requests.
-This means that as long as you are using an OpenTelemetry instrumentation for your framework of choice
-(currently: Express or Fastify), you do not need to setup any `requestHandler` or similar.
+[More information on how to set up Sentry for Node in v8.](./../../docs/v8-node.md)
 
 ### ESM Support
 
-Due to the way OpenTelemetry handles instrumentation, this only works out of the box for CommonJS (`require`) applications.
-
+Due to the way OpenTelemetry handles instrumentation, this only works out of the box for CommonJS (`require`)
+applications.
 
 There is experimental support for running OpenTelemetry with ESM (`"type": "module"`):
 
@@ -111,27 +50,9 @@ node --experimental-loader=@opentelemetry/instrumentation/hook.mjs ./app.js
 
 You'll need to install `@opentelemetry/instrumentation` in your app to ensure this works.
 
-See [OpenTelemetry Instrumentation Docs](https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-instrumentation#instrumentation-for-es-modules-in-nodejs-experimental) for details on this -
-but note that this is a) experimental, and b) does not work with all integrations.
-
-
-## Available (Performance) Integrations
-
-* Http
-* Express
-* Fastify
-* Nest
-* Mysql
-* Mysql2
-* GraphQL
-* Mongo
-* Mongoose
-* Postgres
-* Prisma
-
-All of these are auto-discovered, you don't need to configure anything for performance.
-You still need to register middlewares etc. for error capturing.
-Other, non-performance integrations from `@sentry/node` are also available (except for Undici).
+See
+[OpenTelemetry Instrumentation Docs](https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-instrumentation#instrumentation-for-es-modules-in-nodejs-experimental)
+for details on this - but note that this is a) experimental, and b) does not work with all integrations.
 
 ## Links