Sentry doing nothing on a NextJS application run within NX

[jporsay]

Is there an existing issue for this?

• I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
• I have reviewed the documentation https://docs.sentry.io/
• I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Sentry Saas (sentry.io)

Which package are you using?

@sentry/nextjs

SDK Version

7.21.1

Framework Version

No response

Link to Sentry event

No response

Steps to Reproduce

Given that we're using NX for our service, we cannot use the wizard to automatically configure our application, so we followed the manual steps and created all of the files within our application folder, apps/app (not the root of the repository).

Which means that is / is the root of the repository, we now have the following files in the following paths:

• apps/app/sentry.client.config.js
• apps/app/sentry.server.config.js
• apps/app/.sentryclirc
• apps/app/sentry.properties

We also:

• Modified the next.config.js to add the withSentryConfig with extra values for Sentry (or the webpack plugin).
• Added the custom _error page.

We've added a console.log to both sentry.client.config.js and sentry.server.config.js to see if they're being called (trying to diagnose the symptom).

We've executed nx serve app from the root of the project.

Expected Result

• We can see the console.log appear in the console of the client/server (confirming that Sentry.init has been executed).
• When performing an action that throws an error we expect it to see it reported in Sentry.

Actual Result

• No log appears
• No message from Sentry appears
• No error is reported

[lforst]

Hi, can you provide a minimal reproduction example (e.g. on stackblitz) so we can effectively debug this?

Also, I have a few questions:

• What is the command you're starting next with? (next dev or next build && next start)
• What do your sentry.client/server.config.js files look like.

[jporsay]

Hey @lforst , we use nx serve app to start next, which internally uses @nx/next (see docs here).

As for the minimal reproduction example, give me a few minutes and I'll create one.

As for the sentry.client/server.config.js

The server one is:

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

const SENTRY_DSN = process.env.SENTRY_DSN || process.env.NEXT_PUBLIC_SENTRY_DSN;
console.log('Sentry server executed');

Sentry.init({
  dsn:
    SENTRY_DSN ||
    'https://XXXX@XXXXX.ingest.sentry.io/XXXXXX',
  // We recommend adjusting this value in production, or using tracesSampler
  // for finer control
  tracesSampleRate: 1.0,
  // ...
  // Note: if you want to override the automatic release value, do not set a
  // `release` value here - use the environment variable `SENTRY_RELEASE`, so
  // that it will also get attached to your source maps
  integrations: [new Tracing.Integrations.Prisma({ client: prisma })],
});

And the client one is:

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

const SENTRY_DSN = process.env.SENTRY_DSN || process.env.NEXT_PUBLIC_SENTRY_DSN;
console.log('Sentry client executed');

Sentry.init({
  dsn:
    SENTRY_DSN ||
    'https://XXXXXX@XXXXXX.ingest.sentry.io/XXXXX',
  // We recommend adjusting this value in production, or using tracesSampler
  // for finer control
  tracesSampleRate: 1.0,
  // ...
  // Note: if you want to override the automatic release value, do not set a
  // `release` value here - use the environment variable `SENTRY_RELEASE`, so
  // that it will also get attached to your source maps
  integrations: [
    // new Sentry.BrowserTracing({
    //   // custom options
    // }),
  ],
});

[jporsay]

Here's the reproduction repository: https://github.com/jporsay/sentry-nx-issue

[charleskoehl]

Having the same problem with next 13.0.3. Our config is almost exactly the same, except that our project is in an nx monorepo, and we've added sentryWebpackPluginOptions:

const sentryWebpackPluginOptions = {
  // Additional config options for the Sentry Webpack plugin. Keep in mind that
  // the following options are set automatically, and overriding them is not
  // recommended:
  //   release, url, org, project, authToken, configFile, stripPrefix,
  //   urlPrefix, include, ignore

  silent: true, // Suppresses all logs
  // For all available options, see:
  // https://github.com/getsentry/sentry-webpack-plugin#options.
}

// Make sure adding Sentry options is the last code to run before exporting, to
// ensure that your source maps include changes from all other Webpack plugins
module.exports = withSentryConfig(
  withNx(nextConfig),
  sentryWebpackPluginOptions
)

We're trying to get Sentry errors from dev and preview environments first. We haven't tried it on prod yet.

[jorgearuv]

Same issue. Just created a new project with Next v13 and used the wizard to add Sentry, and a test error is not being reported to Sentry.

[charleskoehl]

We just downgraded from next 13.0.3 to 13.0.0 and it works now.

[charleskoehl]

We then tried installing next@13.0.1, then 2, then 3, and it worked for each of them, so perhaps it was just the act of reinstalling next that fixed it:

Perhaps it was one of the other dependencies getting updated (like next/env or next/swc-darwin-x64) that fixed the issue:

info Direct dependencies
└─ next@13.0.2
info All dependencies
├─ @next/env@13.0.2
├─ @next/swc-darwin-x64@13.0.2
└─ next@13.0.2

We then just ran yarn add next to get the current version, which is 13.0.5, and it still worked.

[lforst]

@charleskoehl can you confirm Sentry works for you now?

[charleskoehl]

It's working now @lforst . Thanks for following up.

[github-actions]

This issue has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you label it Status: Backlog or Status: In Progress, I will leave it alone ... forever!

---

"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀