Fix Next.js instrumentation

[unflxw]

I took a look at a Next.js application that Shairyar prepared (Slack conversation), instrumented with our Express documentation as described in the docs. We couldn't get it to report routing correctly — all requests end up logged as GET, even for requests to other endpoints using getServerSideProps, which should be hitting the server.

I think the Next.js instrumentation, at least in the way we suggest it’s set up in the docs, is likely broken.

To do

• Figure out if this is really broken
• Research the new OpenTelemetry instrumentation built-in to Next.js 13.2.0, see PR: feat: add OTEL instrumentation for next-server + OTEL example vercel/next.js#46198
• Add an extractor if needed -- https://github.com/appsignal/appsignal-agent/pull/972
• Update the docs to use the instrumentationHook Next.js config option -- https://github.com/appsignal/appsignal-docs/pull/1258
• Add test setup -- New Next.js test setups test-setups#109
• Add events in server -- https://github.com/appsignal/appsignal-server/pull/9490

[backlog-helper]

✔️ All good!

New issue guide | Backlog management | Rules | Feedback

[shairyar]

https://app.intercom.com/a/inbox/yzor8gyw/inbox/admin/4356044/conversation/16410700175854?view=List (Private link)

[unflxw]

Confirming that it's really broken.

Let's see if we can find a quick win to make this work in some circumstances -- even if it it's something that isn't ideal, like downgrading Next.js.

In the not-so-long term, it seems that the Next.js team are working on a built-in OpenTelemetry instrumentation. So eventually, supporting that and asking users to upgrade Next would be the way to go.

It might be possible to backport some of that instrumentation, or take inspiration from it to fix this.

[tombruijn]

Related issue https://github.com/appsignal/appsignal-docs/issues/1130 ?

[tombruijn]

Next.js has a new release 13.2.0 with OpenTelemetry instrumentation. Let's use that.

[unflxw]

Updating here as well: waiting on some improvements to the Next.js OpenTelemetry instrumentation that are currently in progress.

[jeffkreeftmeijer]

https://app.intercom.com/a/apps/yzor8gyw/inbox/inbox/unassigned/conversations/16410700181253 (Private link)

[unflxw]

AppSignal for Node.js 3.0.14 was just released, which includes support for Next.js instrumentation via their newly-added, built-in OpenTelemetry support. It requires Next.js version 13.3.0 or above, and it is not compatible with the use of custom servers. Check out our Next.js integration documentation.