server-devtools 0.1.4 → 0.1.5

package/README.md

@@ -165,6 +165,18 @@ server.listen(3000);
 tsx watch --import ./server-devtools.ts src/main.ts
 ```
 
+`await devtools.start()` automatically registers OpenTelemetry's ESM loader hook
+once per process before starting the OpenTelemetry SDK. Keep startup in the
+preload module and let it complete before application dependencies load, including
+normal Redis (ioredis) imports. Already-loaded dependencies cannot be instrumented
+retroactively.
+
+The installed OpenTelemetry hook exports asynchronous loader hooks, which require
+`node:module.register()`. Newer Node.js versions deprecate this API; its
+`registerHooks()` replacement takes synchronous hooks and cannot directly load
+OpenTelemetry's `hook.mjs`. This compatibility requirement does not change the
+startup command or configuration.
+
 The application can import the same instance normally and mount it in Express:
 
 ```ts
@@ -454,6 +466,7 @@ ServerDevTools currently supports:
 -   MongoDB
 -   PostgreSQL through `pg`
 -   MySQL through `mysql2`
+-   Redis (ioredis)
 -   native HTTP/HTTPS and fetch/Undici requests, including headers and bodies
 -   request search and filtering by HTTP method and status
 -   current/authenticated user context when supplied by the application
@@ -467,6 +480,11 @@ execution trace when using these supported drivers:
 -   MongoDB
 -   PostgreSQL (`pg`)
 -   MySQL (`mysql2`)
+-   Redis (ioredis)
+
+Redis command spans include command inspection, arguments, timings, request
+links, and command errors. Redis (ioredis) support has been verified in
+Express and NestJS applications, including pipelines and transactions.
 
 ------------------------------------------------------------------------
 
@@ -507,7 +525,6 @@ Expect APIs and configuration to evolve before `1.0`.
 
 Planned, not yet available:
 
--   Redis visibility
 -   Configurable trace storage, including storing ServerDevTools data through
     user-configured storage instead of only the default local SQLite storage
 
@@ -548,6 +565,19 @@ The goal is simple:
 
 The project is still early.
 
+### Redis (ioredis) integration tests
+
+The ioredis integration tests require a disposable Redis instance. Run
+them with its connection URL:
+
+```sh
+REDIS_TEST_URL=redis://127.0.0.1:6379 npx tsx --test tests/ioredis-integration.test.ts
+```
+
+When `REDIS_TEST_URL` is not set, the Redis integration tests are
+reported as skipped. The tests use isolated keys and clean up their
+clients and data.
+
 Issues, ideas, bug reports, and contributions are welcome.
 
 ------------------------------------------------------------------------