Introduction to New Relic for Node.js

Pinpoint and solve issues down to the line of code with Node.js monitoring from New Relic. With features like service maps, errors inbox, logs in context, and more, our Node.js agent helps you get the full picture of your app environment.

Why it matters

Many Node.js application requests are based on raw URLs. Our solution 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 suffering from slow database performance.

Installation

To install our agent, you need to sign up for New Relic first. Once you're logged in, follow the instructions or use our launcher to get data flowing in.

Review the system requirements.
Read the install docs.
Go directly to the New Relic UI to add Node.js data.

Extend your instrumentation

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

The Node.js agent auto-instruments many different 3rd party packages. However there are two other modules that are needed if you want telemetry for Apollo Server and Next.js.

Extend your instrumentation	Comments
Customization	Implement Node.js custom instrumentation. Collect custom metrics via an API call. Use our Node.js agent API to control, customize, or extend the agent's functionality. Browse our example applications to see various out of the box and custom instrumentation in action.
Extend Instrumentation
VM measurements	Collect key metric timeslice data from the Node.js virtual machine. View detailed VM statistics in the New Relic UI.
End-user activity	Integrate the Node.js agent with . Gain visibility into user activity with browser monitoring's page load timing process.

View logs for your APM and infrastructure data

You can also bring your logs and application's data together to make troubleshooting easier and faster. With APM 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 in New Relic.

Troubleshoot your installation

If you encounter issues with your Node.js agent, see our troubleshooting docs. Some of the most important troubleshooting docs in that section include:

Large memory usage: If you've installed the Node.js agent and your memory usage has increased, check out these possible solutions.
Troubleshooting your Node.js installation: Try these steps if you don't see any data, cannot log files, or encounter other installation problems with the Node.js agent.
Troubleshooting browser instrumentation: If you encounter problems with browser data, see these additional tips for Node.js.

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

Check the source code