Install the Node.js agent for Docker

You can use our Node.js agent to instrument Node.js applications deployed in Docker containers. This document explains how to build, configure, and deploy your Dockerized Node.js application that you've instrumented with New Relic.

If you need general help with the Node.js agent installation, see our main installation instructions.

Instrument your container

Caution

Don't include your license key in your Dockerfile or Docker image. For more information, see our documentation on license key security.

By making a few configuration changes and adding New Relic environment variables to your existing Dockerfile, you can instrument your Dockerized app with our Node.js agent.

Add newrelic to your package.json:
```
npm install newrelic --save
```
Inject the agent in your node start command to instrument your application.

Depending on how you run your Node.js application, the method for injecting the agent may vary.

ENTRYPOINT
bash
```
$ENTRYPOINT ["node", "-r", "newrelic", "YOUR_PROGRAM.js"]
```

CMD

bash

$CMD ["node", "-r", "newrelic", "YOUR_PROGRAM.js"]

npm script such as npm start

bash

$npm pkg set scripts.start="node -r newrelic your-program.js"

Depending on how you run your Node.js application, the method for injecting the agent may vary.

ENTRYPOINT

bash

$ENTRYPOINT ["node", "--import", "newrelic/esm-loader.mjs", "-r", "newrelic", "YOUR_PROGRAM.js"]

CMD

bash

$CMD ["node", "--import", "newrelic/esm-loader.mjs", "-r", "newrelic", "YOUR_PROGRAM.js"]

npm script such as npm start

bash

$npm pkg set scripts.start="node --import newrelic/esm-loader.mjs -r newrelic your-program.js"

Build your Docker image the way you normally do.
To run your Docker app with the agent enabled, add your and app name to your docker run command as environment variables:
bash
```
$docker run -e NEW_RELIC_LICENSE_KEY=YOUR_LICENSE_KEY \
>        -e NEW_RELIC_APP_NAME="YOUR_APP_NAME" \
>        YOUR_IMAGE_NAME:latest
```

Did this doc help with your installation?

Other configuration options

In addition to setting your application name or license key, you can set other configuration options by starting your container with the -e option.

Instrument your container

Caution

App using CommonJS

App using ESM

Did this doc help with your installation?

Other configuration options

Install the Node.js agent for Docker

Instrument your container .css-21sua1{background:none;border:none;width:0;padding:0;}

Caution

App using ESM

Did this doc help with your installation?

Other configuration options

Instrument your container