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.
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.
The Node.js agent is compatible with the following operating systems:
Linux
SmartOS
macOS 10.7 and higher
Windows Server 2008 and higher
The following are proposed time ranges. The actual release date may vary.
We will support the latest even versions of Node.js releases by the beginning of the following active long term support schedule. The version support policy does not replace our general end-of-life (EOL) policy.
The following are proposed time ranges. The actual release date may vary.
Node.js version
Active long term support (LTS) start date
Initial release date of Node.js agent
with support
18
October 2022
August 3, 2022 with Node.js agent v9.0.0
16
October 2021
July 26, 2021 with Node.js agent v8.0.0
14
October 2020
Nov 09, 2020 with Node.js agent v7.0.0
The following are proposed time ranges for EOL on older Node.js versions. The actual release date may vary.
Node.js version
End of life (EOL) date
Initial release date of Node.js agent dropping support
12
April 2022
As of August 3, 2022, we have discontinued support for Node.js 12 with v9 of the Node.js agent.
10
April 2021
As of July 26, 2021, we have discontinued support for Node.js 10 with v8 of the Node.js agent. For more details, including how you can easily prepare for this transition, see our Support Forum post.
Instrument with Node.js
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.
The Node.js agent monitors the performance of Node.js application calls to these datastores:
The Prisma instrumentation treats Prisma itself as the datastore, not the underlying SQL or NoSQL datastore that Prisma is configured to use. This means metrics and traces will show Prisma ORM queries such as find or updateMany and not SQL statements such as SELECT or UPDATE. As an exception, raw Prisma queries will record the actual raw SQL or NoSQL query.
The grpc-js library is supported for unary, streaming, or bidirectional client calls.
The Node.js agent instruments the native http module.
In addition, the popular undici client has experimental support as well. To use undici, be sure to set feature_flag.undici_instrumentation = true in the newrelic.jsconfiguration file.
All calls to Amazon Web Services(AWS) with the aws-sdk are tracked.
TypeScript is a programming language that can compile to JavaScript. After installation, the Node.js agent automatically instruments your TypeScript apps, giving you immediate access to performance data right out of the box.
ES modules are the official standard for packaging JavaScript code for sharing/reuse. The Node.js agent has experimental support for ES module applications running Node.js version 16.12.0 or higher and agent version 9.1.0 or higher. Please see our ES module documentation for additional information and instructions.
Nest.js 8.0.0 or higher (if using the nest start command to start the application, modify its startup binary to load the New Relic agent: nest start --exec 'node -r newrelic')
Next.js 12.0.9 - 13.3.0 (12.2.0 or higher required for middleware instrumentation)
If you are using a supported framework with default routers, the Node.js agent can read these frameworks' route names as is. However, if you want more specific names than are provided by your framework, you may want to use one or more of the tools New Relic provides with the Node.js transaction naming API.
EOL NOTICE
We have discontinued support for several capabilities in November 2021. This includes the Oracle Driver Package and Hapi versions prior to Hapi 19.2 for our Node.js agent. For more details, including how you can easily prepare for this transition, see our Support Forum post.
Connect the agent to other New Relic features
The Node.js agent integrates with other features to give you observability across your entire stack:
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 infrastructure hosts by APM app in the Infrastructure UI. For more information, see APM data in infrastructure monitoring.