New Relic Next.js instrumentation
This is New Relic's official Next.js framework instrumentation for use with the New Relic Node.js agent.
This module provides instrumentation for server-side rendering via getServerSideProps, middleware, and New Relic transaction naming for both page and server requests. It does not provide any instrumentation for actions occurring during build or in client-side code. If you want telemetry data on actions occurring on the client (browser), you can inject the browser agent.
Here are documents for more in-depth explanations about transaction naming, segments/spans, and injecting the browser agent.
Note: The minimum supported Next.js version is 12.0.9. If you are using Next.js middleware the minimum supported version is 12.2.0.
Currently this package is not bundled with the agent, and must be installed as a standalone. However, the package depends on the agent so you will get all the capabilities of the agent when loading this package.
npm install @newrelic/next
NODE_OPTIONS='-r @newrelic/next' next start
If you cannot control how your program is run, you can load the
@newrelic/next module before any other module in your program. However, we strongly suggest you avoid this method at all costs. We found bundling when running
next build causes problems and also will make your bundle unnecessarily large.
require('@newrelic/next') /* ... the rest of your program ... */
Custom Next.js servers
If you are using next as a custom server, you're probably not running your application with the
next CLI. In that scenario we recommend running the Next.js instrumentation as follows.
node -r @newrelic/next your-program.js
For more information, please see the agent installation guide.
Our API and developer documentation for writing instrumentation will be of help. We particularly recommend the tutorials and various "shim" API documentation.
Next.js is a full stack React Framework. This module augments the Node.js New Relic agent, thus any client-side actions will not be instrumented. However, there is an example for injecting New Relic Browser agent to get more information on client-side actions.
For more information, please see the agent compatibility and requirements.
For capturing both the client and server side errors it is best to use
pages/_error.js pattern recommended by Next.js documentation on Advanced Error Page Customization. This example can be used to send either client, server or both types of errors to New Relic. The example assumes that both the New Relic Browser and Node.js agents are integrated. The
if statement checks whether an error was thrown on the server side (
typeof window === "undefined") and if it was the case, it
requires New Relic Node.js agent and sends an
noticeError method. Otherwise it assumes the error was thrown on the front-end side, and uses the browser agent to send the error to New Relic by using
The module includes a suite of unit and functional tests which should be used to verify that your changes don't break existing functionality.
All tests are stored in
tests/ and are written using
Tap with the extension
.test.js (unit), or
To run the full suite, run:
Individual test scripts include:
npm run unit npm run versioned
Click here for our official Next.js example project that integrates both the New Relic Next.js plugin and the browser agent.
New Relic hosts and moderates an online forum where you can interact with New Relic employees as well as other customers to get help and share best practices. Like all official New Relic open source projects, there's a related community topic in the New Relic Explorers Hub. You can find this project's topic/threads here:
- New Relic Documentation: Comprehensive guidance for using our platform
- New Relic Community: The best place to engage in troubleshooting questions
- New Relic Developer: Resources for building a custom observability applications
- New Relic University: A range of online training for New Relic users of every level
- New Relic Technical Support 24/7/365 ticketed support. Read more about our Technical Support Offerings.
We encourage your contributions to improve the Next.js instrumentation module! Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project.
If you have any questions, or want to execute our corporate CLA (which is required if your contribution is on behalf of a company), drop us an email at firstname.lastname@example.org.
A note about vulnerabilities
As noted in our security policy, New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.
If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through HackerOne.
If you would like to contribute to this project, review these guidelines.
To all contributors, we thank you! Without your contribution, this project would not be what it is today. We also host a community project page dedicated to New Relic Next.js instrumentation.
New Relic Next.js instrumentation is licensed under the Apache 2.0 License.
New Relic Next.js instrumentation also uses source code from third-party libraries. You can find the full details on which libraries are used and the terms under which they are licensed in the third-party notices document.