Install the Node.js agent

Install the agent

Install the agent package in your application directory:

$
npm install newrelic

Then copy the default configuration file from the package into the root of your application:

$
cp node_modules/newrelic/newrelic.js .

Configure the agent

Open newrelic.js in the root of your application. The only two settings you must change before going live:

1. Set license_key to your clave de licencia.

2. Set app_name to a meaningful name for your application.

   exports.config = {
     app_name: ['Your Application Name'],
     license_key: 'YOUR_LICENSE_KEY',
     // ...
   }

   Copia

   You can also set these via environment variables instead of editing the file:

   bash

   Copia

   $
   NEW_RELIC_APP_NAME="Your Application Name"
   $
   NEW_RELIC_LICENSE_KEY="YOUR_LICENSE_KEY"

Start the agent

Load the agent before any other require statements by adding -r newrelic to your startup command:

$
node -r newrelic ./your-app.js

If your application uses ESM, add the --import newrelic/esm-loader.mjs option:

$
node --import newrelic/esm-loader.mjs -r newrelic ./your-app.js

For a Next.js app, load our agent via NODE_OPTIONS='-r newrelic' next start.

If you're using Nest.js and the nest start command 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.

Verify data is flowing

If your agent version is 14.9.0 or above, you can run this command to validate your configuration:

$
npx newrelic validate-config --config-file ./newrelic.js

1. Send at least two requests to your application.

2. Wait 2–3 minutes, then open one.newrelic.com > APM and look for your app by name.