@sentry/nextjs not reporting errors from API (serverless) endpoints in Vercel

[jmurty]

• Review the documentation: https://docs.sentry.io/
• Search for existing issues: https://github.com/getsentry/sentry-javascript/issues
• Use the latest release: https://github.com/getsentry/sentry-javascript/releases
• Provide a link to the affected event from your Sentry account

Package + Version

• @sentry/nextjs

Version:

6.11.0

Description

I was unable to get error reporting from API endpoints deployed in Vercel (as serverless functions) with @sentry/nextjs version 6.11.0 but downgrading to 6.4.1 fixed in.

Our app is a new one built with Next.js 11.1 from create-next-app as of last week.

We used the latest @sentry/nextjs configured according to the documentation, and with additional changes following the with-sentry example: specifically, added _error.js page and err pass through to <Component/> in _app.js.

Before downgrading, client errors were logged fine but I couldn't get error reports from Vercel serverless functions at all.
Both client- and server-side errors were logged successfully to Sentry when running the project locally with yarn dev.

This is the failing API endpoint I used to test in file pages/api/boom.js:

import { withSentry } from "@sentry/nextjs";

const handler = async function handler(req, res) {
  // Trigger an exception
  boom();

  res.status(200).send("OK");
};

export default withSentry(handler);

The problem seems similar to other reported issues:

• @sentry/nextjs not reporting issues i serverless functions #3643 (closed at time of writing, otherwise I would have commented there instead)
• Next.js package does not report server and some client errors #3869 (open at time of writing; seemingly fixed, but does not mention API routes)

[DavidChouinard]

Bummer, also experiencing this — should have been fixed with #3643 but appears to still be an issue

[lobsterkatie]

Hi, @jmurty and @DavidChouinard. Can you please set debug to true in your server-side Sentry.init() and let me know what you see in your logs? Hopefully that should help in figuring out where things are falling off.

Also, can you please post your sentry.server.config.js and next.config.js?

Thanks!

[DavidChouinard]

Sure, sentry.server.config.js:

import * as Sentry from '@sentry/nextjs';

Sentry.init({
  dsn: process.env.SENTRY_SERVER_DSN,
  environment: process.env.IS_PREVIEW ? 'preview' : process.env.NODE_ENV,
  tracesSampleRate: 1.0,
  debug: true,
});

And Vercel logs for the function invocation:

Sentry Logger [Log]: Integration installed: Http
Sentry Logger [Log]: SDK successfully initialized
Sentry Logger [Log]: Initializing SDK...
Sentry Logger [Log]: SDK already initialized
Sentry Logger [Log]: [Tracing] starting http.server transaction - POST /api/wealth/lead
2021-08-25T01:07:44.624Z	059dc976-2060-4642-a77d-4434c2c070d7	ERROR	Error: Sentry testing - wealth error (backend)
    ... rest of stack trace
2021-08-25T01:07:44.624Z	059dc976-2060-4642-a77d-4434c2c070d7	ERROR	Error: Sentry testing - wealth error (backend)
    ... rest of stack trace
RequestId: 059dc976-2060-4642-a77d-4434c2c070d7 Error: Runtime exited with error: exit status 1
Runtime.ExitError

Note that Sentry works correctly locally but things failed when deployed to Vercel.

[jmurty]

Hi @lobsterkatie I have set up a minimal example Next.js + Sentry project to demonstrate the issue: https://github.com/jmurty/nextjs-sentry-vercel-test

This project is set up using the Next.js and Sentry installation wizards, with some extra steps to work better with Vercel. Hopefully the commit messages explain what I did.

I also set up a new Sentry project to log messages to: https://sentry.io/organizations/murty/issues/?project=5925157 (org murty project nextjs-sentry-vercel-test)

When run the app locally with yarn dev (or with yarn start after yarn build) clicking the button on the index page or visiting the API endpoints /api/test1 through /api/test4 trigger an error that gets logged to the Sentry project.

The same app is deployed to Vercel at https://nextjs-sentry-vercel-test.vercel.app/
But when I trigger the errors on the Vercel site only the client-side (button press) and /api/test4 errors get logged. Errors are not logged for /api/test1, /api/test2, or /api/test3

The /api/test4 API endpoint explicitly catches and captures the error to Sentry.

The /api/test3 is closest to this issue: an error raised in the Next.js handler function that should be caught and captured by withSentry.

The other two examples trigger errors outside the scope of the the handler function and withSentry so should presumably be caught and captured by the custom _error.js page as a fallback. The custom error page is displayed for these endpoints.

Here are the logs from Vercel after hitting the four error-triggering API endpoints:
nextjs-sentry-vercel-test.vercel.logs.txt

[jmurty]

I also created a sentry-6.4.1 branch on the example project where I downgraded @sentry/nextjs from 6.11 to 6.4.1: https://github.com/jmurty/nextjs-sentry-vercel-test/tree/sentry-6.4.1

This branch is running on Vercel at https://nextjs-sentry-vercel-test-git-sentry-641-jmurty.vercel.app/ and with it the /api/test3 trigger is logged unlike with version 6.11. This matches my experience where downgrading fixed logging of errors within the handler function.

The client-side and /api/test4 triggers are also logged, like the 6.11 version. The /api/test1 and /api/test2 example errors are not logged.

Here are the Vercel logs again for the 6.4.1 deployment:
nextjs-sentry-vercel-test.6_4_1.vercel.logs.txt

[lobsterkatie]

@jmurty @DavidChouinard Thanks to both of you! One of my colleagues has been looking at this while I've been pulled away on another project, and I'm now going to poke at it, too. Will let you know what I come up with!

[DavidChouinard]

@lobsterkatie have you been able to replicate the issue on your side?