Compatibility and requirements for the Node.js agent

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.

It's also compatible with these hosting services:

• Google App Engine (GAE) flexible environment
• AWS EC2
• Microsoft Azure
• Heroku

As a standard security measure for data collection, your app server must support SHA-2 (256-bit). SHA-1 is not supported.

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.

The following are proposed time ranges for EOL on older Node.js versions. The actual release date may vary.

The Node.js agent monitors the performance of Node.js application calls to these datastores:

• Cassandra
• Memcached
• MongoDB
• MySQL (via mysql and mysql2 packages)
• Redis
• Postgres (including the native and pure JavaScript packages)

• 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.js configuration file.

We collect instance details for a variety of databases and database drivers. The ability to view specific instances and the types of database information in APM depends on your agent version.

New Relic's Node.js agent version 1.31.0 or higher supports the following:

To request instance-level information from datastores currently not listed for your New Relic agent, get support at support.newrelic.com.

In order to support APM logs in context, the Node.js agent instruments the following libraries:

• winston
• pino
• bunyan

Message queue instrumentation is only available with the New Relic Node.js agent v2 or higher. Currently supported message queue instrumentation: amqplib.

For other message queue libraries, use custom instrumentation.

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.

• Express 4.6.0 or higher
• Restify
• Connect
• Hapi
• Koa 2.0.0 or higher (external module loaded with the agent)
• Fastify
• Next.js 12.0.9 or higher (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.