getsentry / getsentry/sentry-javascript

Add diagnostics_channel based instrumentation to supported Node libraries

Aperta
#15,107 4 commenti 2 reazioni 0 assegnatari Vedi su GitHub
Tracking Issue
Lingua principale
TypeScript
Stelle
8.7k
Fork
1.8k
Merge medio
1g 17h
PR unite (30g)
515

Descrizione

### Description

Today, we use `import-in-the-middle` and `require-in-the-middle` based instrumentation for Node libraries in our Node SDK, e.g. for express, mysql, etc.

This has some downsides:

1. For ESM, to have `import-in-the-middle` work reliably it should be configured via `--import` in the Node CLI
2. `import-in-the-middle` is flawed in a couple of ways that means it can't be used to wrap all libraries
3. Neither `import-in-the-middle` or `require-in-the-middle` work with bundled code (as it instruments `import`/`require`, basically)

To "fix" this, we want to migrate to using [`diagnostics_channel`](https://nodejs.org/api/diagnostics_channel.html) for the packages we instrument. With this, both of these downsides disappear.

In order to achieve this, we need to actually PR the libraries themselves (e.g. express, mysql, ...) and make them emit `diagnostics_channel` (or a [tracing channel](https://nodejs.org/api/diagnostics_channel.html#class-tracingchannel)). Then, the OTEL instrumentation can be updated to use this instead of using import-in-the-middle.

This will be a gradual approach, we can update libraries as we go, starting with more important ones.

```[tasklist]
### Libraries to update
- [ ] http
- [ ] express
- [ ] fastify
- [ ] graphql
- [ ] mongo
- [ ] mongoose
- [ ] mysql
- [ ] mysql2
- [ ] redis
- [ ] postgres
- [ ] hapi
- [ ] koa
- [ ] connect
- [ ] tedious
- [ ] genericPool
- [ ] kafka
- [ ] amqlib
- [ ] lruMemoizer
- [ ] vercelAIIntergation (?)
```

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.