feat(node-core): Add lightweight mode docs#16396
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
andreiborza
requested review from
chargome,
inventarSarah,
nicohrubec and
s1gr1d
| ### I don't need automatic spans/transactions | ||
|
|
||
| If you don't need spans emitted by OpenTelemetry instrumentation, you can use `@sentry/node-core` in [Lightweight Mode](./lightweight) without OpenTelemetry dependencies. You still get errors, logs, metrics, breadcrumbs, and more. This mode is experimental. | ||
|
|
There was a problem hiding this comment.
I think this would be nice in a dropdown, as not everyone needs to read the paragraph.
There was a problem hiding this comment.
Hm, this is in the overview of install methods. Tbh I don't even know if this is the right place to put this but it's the best I could think of atm.
If we put it in a dropdown I fear the discoverability suffers a lot. It's already kind of hidden in this page (can't see lightweight mode in the sidebar).
There was a problem hiding this comment.
Ah makes sense! I expanded the rest of the file and I think it's better to just keep it like this.
|
|
||
| Request isolation works automatically. No additional setup is needed — just make sure `Sentry.init()` is called before you create your HTTP server. | ||
|
|
||
| ### Node.js < 22 |
| | **Error tracking** | Yes | Yes | | ||
| | **Logs and metrics** | Yes | Yes | | ||
| | **Automatic spans** | Yes | No | | ||
| | **OpenTelemetry required** | Yes | No | |
There was a problem hiding this comment.
It might be a bit unclear what "required" means here. As a user, I might come up with questioning "I need to add OpenTelemetry when I am using @sentry/node?".
| | **OpenTelemetry required** | Yes | No | | |
| | **OpenTelemetry auto-included** | Yes | No | |
There was a problem hiding this comment.
Right, I like that suggestion a lot.
There was a problem hiding this comment.
Updated, I didn't accept the suggestion because of the table formatting.
Co-authored-by: Sigrid <32902192+s1gr1d@users.noreply.github.com>
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Co-authored-by: Sigrid <32902192+s1gr1d@users.noreply.github.com>
Co-authored-by: Sigrid <32902192+s1gr1d@users.noreply.github.com>
2 participants
DESCRIBE YOUR PR
This PR adds basic documentation for
@sentry/node-core/light, the lightweight mode of@sentry/node-core.IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
EXTRA RESOURCES
Readme of the SDK: https://github.com/getsentry/sentry-javascript/tree/develop/packages/node-core#lightweight-mode