Our Node.js agent includes built-in instrumentation of the most popular Node.js frameworks, app servers, databases, and message queuing systems. For frameworks and libraries that aren't instrumented out of the box, you can extend the agent with our Node.js agent API.
Our Node.js agent is publicly available on the Node Package Manager (npm) repository as well as on GitHub. Ready to try out New Relic's Node.js agent? Create a New Relic account!
Requirements to install the agent
Before installing the agent, check that your system meets its minimum requirements. For best performance, use the latest active long term support (LTS) version of Node.js.
Instrumented modules
After installation, the agent automatically instruments with our catalog of supported Node.js libraries and frameworks. This gives you immediate access to granular information specific to your web apps and servers. For unsupported frameworks or libraries, you'll need to instrument the agent yourself using the Node.js agent API.
Note: The latest supported version may not reflect the most recent supported version.
| Package name | Minimum supported version | Latest supported version | Introduced in* |
|---|---|---|---|
@apollo/gateway | 2.3.0 | 2.9.3 | @newrelic/apollo-server-plugin@1.0.0 |
@apollo/server | 4.0.0 | 4.11.2 | @newrelic/apollo-server-plugin@2.1.0 |
@aws-sdk/client-bedrock-runtime | 3.474.0 | 3.696.0 | 11.13.0 |
@aws-sdk/client-dynamodb | 3.0.0 | 3.696.0 | 8.7.1 |
@aws-sdk/client-sns | 3.0.0 | 3.696.0 | 8.7.1 |
@aws-sdk/client-sqs | 3.0.0 | 3.696.0 | 8.7.1 |
@aws-sdk/lib-dynamodb | 3.377.0 | 3.696.0 | 8.7.1 |
@aws-sdk/smithy-client | 3.47.0 | 3.374.0 | 8.7.1 |
@elastic/elasticsearch | 7.16.0 | 8.16.1 | 11.9.0 |
@grpc/grpc-js | 1.4.0 | 1.12.2 | 8.17.0 |
@hapi/hapi | 20.1.2 | 21.3.12 | 9.0.0 |
@koa/router | 11.0.2 | 13.1.0 | 3.2.0 |
@langchain/core | 0.1.17 | 0.3.18 | 11.13.0 |
@nestjs/cli | 9.0.0 | 10.4.8 | 10.1.0 |
@prisma/client | 5.0.0 | 5.22.0 | 11.0.0 |
@smithy/smithy-client | 2.0.0 | 3.4.4 | 11.0.0 |
amqplib | 0.5.0 | 0.10.4 | 2.0.0 |
apollo-server | 3.0.0 | 3.13.0 | @newrelic/apollo-server-plugin@1.0.0 |
apollo-server-express | 3.0.0 | 3.13.0 | @newrelic/apollo-server-plugin@1.0.0 |
aws-sdk | 2.2.48 | 2.1692.0 | 6.2.0 |
bluebird | 2.0.0 | 3.7.2 | 1.27.0 |
bunyan | 1.8.12 | 1.8.15 | 9.3.0 |
cassandra-driver | 3.4.0 | 4.7.2 | 1.7.1 |
connect | 3.0.0 | 3.7.0 | 2.6.0 |
express | 4.6.0 | 4.21.1 | 2.6.0 |
fastify | 2.0.0 | 5.1.0 | 8.5.0 |
generic-pool | 3.0.0 | 3.9.0 | 0.9.0 |
ioredis | 4.0.0 | 5.4.1 | 1.26.2 |
kafkajs | 2.0.0 | 2.2.4 | 11.19.0 |
koa | 2.0.0 | 2.15.3 | 3.2.0 |
koa-route | 3.0.0 | 4.0.1 | 3.2.0 |
koa-router | 11.0.2 | 13.0.1 | 3.2.0 |
memcached | 2.2.0 | 2.2.2 | 1.26.2 |
mongodb | 4.1.4 | 6.10.0 | 1.32.0 |
mysql | 2.2.0 | 2.18.1 | 1.32.0 |
mysql2 | 2.0.0 | 3.11.4 | 1.32.0 |
next | 13.4.19 | 15.0.3 | 12.0.0 |
openai | 4.0.0 | 4.73.0 | 11.13.0 |
pg | 8.2.0 | 8.13.1 | 9.0.0 |
pg-native | 3.0.0 | 3.2.0 | 9.0.0 |
pino | 7.0.0 | 9.5.0 | 8.11.0 |
q | 1.3.0 | 1.5.1 | 1.26.2 |
redis | 3.1.0 | 4.7.0 | 1.31.0 |
restify | 11.0.0 | 11.1.0 | 2.6.0 |
superagent | 3.0.0 | 10.1.1 | 4.9.0 |
undici | 5.0.0 | 6.21.0 | 11.1.0 |
when | 3.7.0 | 3.7.8 | 1.26.2 |
winston | 3.0.0 | 3.17.0 | 8.11.0 |
*When package is not specified, support is within the newrelic package.
AI Monitoring Support
The Node.js agent supports the following AI platforms and integrations.
Amazon Bedrock
Through the @aws-sdk/client-bedrock-runtime module, we support:
| Model | Image | Text | Vision |
|---|---|---|---|
| AI21 Labs Jurassic-2 | ❌ | ✅ | - |
| Amazon Titan | ❌ | ✅ | - |
| Anthropic Claude | ❌ | ✅ | ❌ |
| Cohere | ❌ | ✅ | - |
| Meta Llama2 | ❌ | ✅ | - |
| Meta Llama3 | ❌ | ✅ | - |
Note: if a model supports streaming, we also instrument the streaming variant.
Langchain
The following general features of Langchain are supported:
| Agents | Chains | Tools | Vectorstores |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
Models/providers are generally supported transitively by our instrumentation of the provider's module.
| Provider | Supported | Transitively |
|---|---|---|
| Azure OpenAI | ❌ | ❌ |
| Amazon Bedrock | ❌ | ❌ |
| OpenAI | ✅ | ✅ |
OpenAI
Through the openai module, we support:
| Audio | Chat | Completions | Embeddings | Files | Images |
|---|---|---|---|---|---|
| ❌ | ✅ | ✅ | ✅ | ❌ | ❌ |
Connect the agent to other New Relic features
The Node.js agent integrates with other features to give you observability across your entire stack:
Product | Capability |
|---|---|
If you have version 11.13.0 of the Node.js agent, you can collect AI data from certain AI libraries and frameworks:
| |
The Node.js agent can add the benefits of when you enable auto-instrumentation. After enabling browser monitoring injection, simply follow our guide to installing browser monitoring with the Node.js agent. Once you've completed these steps, you can view your browser data in the APM Summary page and quickly switch between the APM and browser data for a particular app. For configuration options and manual instrumentation, see browser monitoring and the Node.js agent. | |
When you install the infrastructure and APM agents on the same host, they automatically detect one another. You can then view a list of hosts in the APM UI, and filter your hosts by APM app in the infrastructure UI. For more information, see APM data in infrastructure monitoring. | |
The Node.js agent sends default events and attributes for NRQL queries. You can also record custom events for advanced analysis. | |
Synthetic transaction traces connect requests from synthetic monitors to the underlying APM transaction. |