New Relic's Node.js agent is publicly available on the Node Package Manager (npm) repository as well as on New Relic's GitHub repo for Node.js. Before you install the Node.js agent, make sure your application meets New Relic's system requirements. You may also want to watch the installation video before you begin.
Install the Node.js agent
If you are using the agent in a Docker container, install the agent within each container.
To install the Node.js agent for New Relic:
- Ensure you meet the system requirements. In particular, ensure you are using a supported version of Node.
- Use the command
npm install newrelic --savefor each application you want to monitor.
newrelic.jsinto the root directory of your app.
Configure agent via the
newrelic.jsfile or via environment variable:
require('newrelic');as the first line of your app's main module.
- Optional: For additional Node.js runtime-level statistics, ensure the
@newrelic/native-metricspackage is installed.
- Generate some traffic, then wait a few minutes for data to appear in the New Relic APM UI.
Keep your Node.js agent up-to-date
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.
View installation video
Before installing New Relic, you may want to view the video tutorials at New Relic University: