Skip to content

Commit b333218

Browse files
committed
Update README with suggestions
1 parent 62497c6 commit b333218

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

packages/node-core/README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -118,13 +118,17 @@ NODE_OPTIONS="--import ./instrument.mjs" npm run start
118118

119119
## Lightweight Mode
120120

121+
> [!WARNING]
121122
> **⚠️ Experimental**: The `@sentry/node-core/light` subpath export is experimental and may receive breaking changes in minor or patch releases.
122123
123-
If you don't need automatic spans/transactions, you can use the lightweight mode which doesn't require OpenTelemetry dependencies. This mode is ideal for:
124+
> [!IMPORTANT]
125+
> This SDK requires Node 22.12.0+ for full functionality. If you're using lower Node versions, this SDK only offers limited tracing support. Consider using `@sentry/node` or `@sentry/node-core` instead.
124126
125-
- Applications that don't need automatic performance monitoring
126-
- Reducing bundle size and runtime overhead
127-
- Environments where OpenTelemetry isn't needed
127+
If you don't need automatic spans/transactions, you can use the lightweight mode which doesn't require OpenTelemetry dependencies. This mode is ideal for when:
128+
129+
- you only need error tracking, logs or metrics without tracing data (no spans)
130+
- you want to minimize bundle size and runtime overhead
131+
- you don't need spans emitted by OpenTelemetry instrumentation
128132

129133
### Installation (Light Mode)
130134

@@ -200,7 +204,7 @@ app.get('/error', (req, res) => {
200204

201205
### Manual Request Isolation (Node.js < 22)
202206

203-
If you're using Node.js versions below 22, automatic request isolation is not available. You'll need to manually wrap your request handlers with `withIsolationScope`:
207+
If you're using Node.js versions below 22.12.0, automatic request isolation is not available. You'll need to manually wrap your request handlers with `withIsolationScope`:
204208

205209
```js
206210
import * as Sentry from '@sentry/node-core/light';
@@ -228,7 +232,7 @@ app.get('/error', (req, res) => {
228232

229233
- Manual isolation prevents scope data leakage between requests
230234
- However, **distributed tracing will not work correctly** - incoming `sentry-trace` and `baggage` headers won't be automatically extracted and propagated
231-
- For full distributed tracing support, use Node.js 22+ or the full `@sentry/node` SDK with OpenTelemetry
235+
- For full distributed tracing support, use Node.js 22.12.0+ or the full `@sentry/node` SDK with OpenTelemetry
232236

233237
## Links
234238

0 commit comments

Comments
 (0)