Next.js App Router Standalone Example

[ADNolan]

Is your feature request related to a problem?

The existing Next.js App Router (v14) example works well in development mode and the standard Next.js production mode. When it comes to using the standalone output mode, there is seemingly a need for an extra step to ensure that newrelic node package is included in the build output node_modules.

Feature Description

Add an example or documentation for having Newrelic work with the App router in standalone output (i.e. for running in Docker).

Describe Alternatives

The current approach that seems to work is by adding the instrumentation.{js|ts} file and having a import for the newrelic module. Also to set the experimental instrumentation flag in the next config. The other steps outlined in the existing example for the Next.js app router configuration is needed as well.

export async function register(): Promise<void> {
  if (process.env.NEXT_RUNTIME === 'nodejs') {
    await import('newrelic')
  }
}

Additional context

• None

Priority

Nice to Have

[workato-integration]

https://new-relic.atlassian.net/browse/NR-362108

[mrickard]

Thank you for surfacing this, @ADNolan! Would you be willing to submit a PR here for it?

[ADNolan]

Thank you for surfacing this, @ADNolan! Would you be willing to submit a PR here for it?

Yes, I can try to get one ready in the next day or so.

[accedo-robcc]

@ADNolan I’ve been trying the same thing without success, newrelic.agent.collector.isConnected() never returns true so the app doesn’t load when running CMD ["node", "-r", "newrelic", "server.js"].

I added instrumentationHook: true to next.config.js but the issue persist. Would you happen to have an example of the complete setup?

[ADNolan]

@accedo-robcc hey, sorry I haven't got the example up yet. Things I have noticed is that when rebuilding the docker image, try with --no-cache to avoid docker build cache using old code.

The quick outline is to follow the steps in the existing app router example, add the instrumentation file in the manner in the first post in this issue, and enable it in the next config with experimental.instrumentationHook: true.

Dockerfile command i have is the same that you put CMD ["node", "-r", "newrelic", "server.js"].

Not sure it matters, but I have tried on Next.js version 14.2.16 and 14.2.23. I haven't updated to 15 yet, but that will be in the near future I believe. I will try to get the example submitted tomorrow when I will have a bit of free time.