Supported Node.js libraries and frameworks
Validated libraries and frameworks
The following libraries and frameworks are supported by Observe APM and work with all Observe APM features.
Database Client
Observe supports the following Node.js database client libraries and services for APM instrumentation:
| Library name | Supported versions | Trace Explorer | Catalog | Service Inspector | RED Metrics | Database Statements | Service Maps |
|---|---|---|---|---|---|---|---|
| mongodb (native driver) | >= 3.3.0, < 8 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| pg (PostgreSQL) | >= 8.0.3, < 9 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
ORM
Observe supports the following Node.js ORM libraries and services for APM instrumentation:
| Library name | Supported versions | Trace Explorer | Catalog | Service Inspector | RED Metrics | Database Statements | Service Maps |
|---|---|---|---|---|---|---|---|
| knex | >= 0.10.0, < 4 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| mongoose | >= 5.9.7, < 10 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Prisma (@prisma/client) | >= 5.0.0 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Web / HTTP Server
Observe supports the following Node.js HTTP server libraries and services for APM instrumentation:
| Library name | Supported versions | Trace Explorer | Catalog | Service Inspector | RED Metrics | Deployments | Service Maps | Error & Exception Tracking |
|---|---|---|---|---|---|---|---|---|
| Express | >= 4.0.0, < 6 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Fastify | >= 4.0.0, < 6 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Hapi (@hapi/hapi) | >= 17.0.0, < 22 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Koa | >= 2.0.0, < 4 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| NestJS (@nestjs/core) | >= 4.0.0, < 12 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Other libraries and frameworks supported by Observe APM
The libraries and frameworks in this section are supported by OTel but may not work seamlessly with Observe APM features.
Cache Client
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| ioredis | >= 2.0.0, < 6 | ✅ |
| redis (node-redis) | >= 2.6.0, < 6 | ✅ |
Cloud SDK
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| AWS SDK v3 (@aws-sdk/client-*) | >= 3.0.0, < 4 | ✅ |
Database
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| mysql | >= 2.0.0, < 3 | ✅ |
| mysql2 | >= 1.4.2, < 4 | ✅ |
| tedious (MSSQL) | >= 1.11.0, < 20 | ✅ |
Database Client
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| cassandra-driver | >= 4.4.0, < 5 | ✅ |
GenAI
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| openai | >= 4.19.0, < 7 | ✅ |
HTTP Client
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| undici / fetch | >= 5.12.0 | ✅ |
HTTP Client / Server
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| http / https (Node.js core) | Node.js built-in | ✅ |
Messaging
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| amqplib (RabbitMQ) | >= 0.5.5, < 1 | ✅ |
| kafkajs | >= 0.3.0, < 3 | ✅ |
| socket.io | >= 2.0.0, < 5 | ✅ |
GraphQL
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| graphql | >= 14.0.0, < 17 | ✅ |
Runtime Metrics
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| runtime-node (V8 / process) | Auto-included in auto-instrumentations-node | ✅ |
Web / HTTP Server
Library name | Supported versions | Trace Explorer |
|---|---|---|
Connect |
| ✅ |
Restify |
| ✅ |
Web / RPC
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| @grpc/grpc-js | ^1.0.0 | ✅ |
Updated 1 day ago