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:
- For ESM, to have
import-in-the-middle work reliably it should be configured via --import in the Node CLI import-in-the-middle is flawed in a couple of ways that means it can't be used to wrap all libraries- 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 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). 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.
### Libraries to update
- [ ] http
- [ ] express
- [ ] fastify
- [ ] graphql
- [ ] mongo
- [ ] mongoose
- [ ] mysql
- [ ] mysql2
- [ ] redis
- [ ] postgres
- [ ] hapi
- [ ] koa
- [ ] connect
- [ ] tedious
- [ ] genericPool
- [ ] kafka
- [ ] amqlib
- [ ] lruMemoizer
- [ ] vercelAIIntergation (?)
Description
Today, we use
import-in-the-middleandrequire-in-the-middlebased instrumentation for Node libraries in our Node SDK, e.g. for express, mysql, etc.This has some downsides:
import-in-the-middlework reliably it should be configured via--importin the Node CLIimport-in-the-middleis flawed in a couple of ways that means it can't be used to wrap all librariesimport-in-the-middleorrequire-in-the-middlework with bundled code (as it instrumentsimport/require, basically)To "fix" this, we want to migrate to using
diagnostics_channelfor 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). 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.