• EnglishEspañol日本語한국어Português
  • Log inStart now

Compatibility and requirements for the Node.js agent

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 nameMinimum supported versionLatest supported versionIntroduced in*
@apollo/gateway2.3.02.7.7@newrelic/apollo-server-plugin@1.0.0
@apollo/server4.0.04.10.4@newrelic/apollo-server-plugin@2.1.0
@aws-sdk/client-bedrock-runtime3.0.03.576.011.13.0
@aws-sdk/client-dynamodb3.0.03.576.08.7.1
@aws-sdk/client-sns3.0.03.576.08.7.1
@aws-sdk/client-sqs3.0.03.576.08.7.1
@aws-sdk/smithy-client3.0.03.374.08.7.1
@elastic/elasticsearch7.16.08.13.111.9.0
@grpc/grpc-js1.4.01.10.78.17.0
@hapi/hapi20.1.221.3.99.0.0
@koa/router2.0.012.0.13.2.0
@langchain/core0.1.170.1.6311.13.0
@nestjs/cli8.0.010.3.210.1.0
@prisma/client5.0.05.14.011.0.0
@smithy/smithy-client3.0.03.0.111.0.0
amqplib0.5.00.10.42.0.0
apollo-server2.14.03.13.0@newrelic/apollo-server-plugin@1.0.0
apollo-server-express2.14.03.13.0@newrelic/apollo-server-plugin@1.0.0
apollo-server-fastify2.14.03.13.0@newrelic/apollo-server-plugin@1.0.0
apollo-server-hapi3.0.03.13.0@newrelic/apollo-server-plugin@1.0.0
apollo-server-koa2.14.03.13.0@newrelic/apollo-server-plugin@1.0.0
apollo-server-lambda2.14.03.13.0@newrelic/apollo-server-plugin@1.0.0
aws-sdk2.2.482.1620.06.2.0
bluebird2.0.03.7.21.27.0
bunyan1.8.121.8.159.3.0
cassandra-driver3.4.04.7.21.7.1
connect2.0.03.7.02.6.0
director1.2.01.2.82.0.0
express4.6.04.19.22.6.0
fastify2.0.04.27.08.5.0
generic-pool2.4.03.9.00.9.0
ioredis3.0.05.4.11.26.2
koa2.0.02.15.33.2.0
koa-route2.0.04.0.13.2.0
koa-router2.0.012.0.13.2.0
mongodb2.1.06.6.11.32.0
mysql2.2.02.18.11.32.0
mysql21.3.13.9.71.32.0
next13.0.014.2.3@newrelic/next@0.7.0
openai4.0.04.47.111.13.0
pg8.2.08.11.59.0.0
pg-native2.0.03.0.19.0.0
pino7.0.09.1.08.11.0
redis2.0.04.6.131.31.0
restify5.0.011.1.02.6.0
superagent2.0.09.0.24.9.0
undici4.7.06.16.111.1.0
winston3.0.03.13.08.11.0

*When package is not specified, support is within the newrelic package.

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

AI monitoring

If you have version 11.13.0 of the Node.js agent, you can collect AI data from certain AI libraries and frameworks:

Browser monitoring

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.

Infrastructure monitoring

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.

New Relic dashboards

The Node.js agent sends default events and attributes for NRQL queries. You can also record custom events for advanced analysis.

Synthetic monitoring

Synthetic transaction traces connect requests from synthetic monitors to the underlying APM transaction.

Copyright © 2024 New Relic Inc.

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.