Introduction to New Relic for Node.js

Many Node application requests are based on raw URLs. New Relic for Node.js is different.

New Relic for Node.js assumes it can group requests to your application into transactions instead of HTTP requests. Transactions are defined by giving one or more request paths a name. These names are used to:

  • Visualize where your app is spending its time (in transaction breakdowns).
  • Identify slow requests.
  • Group metrics.
  • Show you which portions of your application are, for example, suffering from slow database performance.

System requirements

Before you install New Relic's Node.js agent, make sure your application meets these system requirements.

Resource Requirements
Operating system
  • Linux
  • SmartOS
  • Mac OSX 10.7 and higher
  • Windows Server 2008 and higher
Node.js version

New Relic recommends using the latest LTS version of Node.js for best performance, currently v6.x.

New Relic's Node.js agent is tested on and supports versions 4 and later of Node.js (including the latest version, 7.x). Other supported versions are 0.8, 0.10* and 0.12. Unstable versions of Node.js are not supported.

* Node.js version 0.10.34 is not supported.

Frameworks
  • Express 2 or higher
  • Restify
  • Connect 1 and Connect 2 (router not supported)
  • Hapi
  • Kraken

If you are using a supported framework with default routers, New Relic's 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. For more information, see Node.js transaction naming API.

Data stores
  • Cassandra with cassandra-driver on Node.js version 0.10 or higher. (The author has deprecated node-cassandra-cql but New Relic for Node.js still supports it.)
  • Memcached
  • MongoDB
  • MySQL 0.9 and 2.0
  • Redis
  • Postgres
  • Oracle
Hosting services
Security requirements As a standard security measure for data collection, your app server must support SHA-2 (256-bit). SHA-1 is not supported.

Extend your instrumentation

After installing the Node.js agent, extend your instrumentation:

Troubleshoot your installation

If you encounter issues with your Node.js agent, see our troubleshooting information:

You can also view all troubleshooting docs. If you need additional assistance, get support at support.newrelic.com.

For more help

Additional documentation resources include:

Join the discussion about Node.js monitoring in the New Relic Online Technical Community! The Technical Community is a public platform to discuss and troubleshoot your New Relic toolset.

If you need additional help, get support at support.newrelic.com.