To complete a basic Node.js agent installation, you can use our guided installation for an automated install, (choose EU if you're in the EU) or follow the instructions in this document. Either way, you need a New Relic account if you don't already have one. (It's free, forever!)
If you're using the agent in a Docker container, install the agent in each container.
To install the Node.js agent:
Create a New Relic account. Don't have one? Sign up for free! No credit card required.
Ensure you meet the system requirements. In particular, make sure you use a supported Node.js version.
Use the command
npm install newrelicfor each application you want to monitor. If your app is using one of these Apollo Server modules install our Apollo plugin with
npm install @newrelic/apollo-server-plugin. More details about using
@newrelic/apollo-server-plugincan be found here.
newrelic.jsinto the root directory of your app.
Configure agent via the
newrelic.jsfile or via environment variable:
-r newrelicto your app's startup script. For example, if your application's entry point is
./dist/server.jsthen you would use the require flag like so:bash$node -r newrelic ./dist/server.js
An example Docker command:CMD ["node", "-r", "newrelic", "server.js"]
For Next.js use
-r @newrelic/nextinstead of
If you're using Nest.JS and the
nest startcommand to start the application, modify its startup binary to load the New Relic agent:
nest start --exec 'node -r newrelic'. Here is an example Nest.js application
More info about the Node.js command line option
If you are unable to use the
-rrequire flag you can also use
require('newrelic')as the first line of your app's main module. Note If you are using Babel or a similar transpiler
require('newrelic')will cause instrumentation issues.
If neither of these options work for you, (e.g. asynchronously loading api keys from a remote location during application bootstrapping), you may also add stock instrumentation to an already loaded supported module by using
newrelic.instrumentLoadedModule:// module loaded before newrelicconst expressModule = require('express');// load the agentconst newrelic = require('newrelic');// instrument express after the agent has been loadednewrelic.instrumentLoadedModule('express', // the module's name, as a stringexpressModule // the module instance);
Generate some traffic, then wait a few minutes for data to appear in the APM UI.
For more information, see our API doc.
Did this doc help with your installation?
You can also bring your logs and application's data together to make troubleshooting easier and faster. With logs in context, you can see log messages related to your errors and traces directly in your app's UI. You can also see logs in context of your infrastructure data, such as Kubernetes clusters. No need to switch to another UI page.
To ensure that you have the most up-to-date version of New Relic, refer to the Node.js release notes. When applicable, the release notes include a download link with instructions on how to update the Node.js agent.
After you update the agent, generate some traffic and wait a few minutes. If no data appears in the New Relic UI, see the troubleshooting procedures.