Support Nitro

[MickL]

Problem Statement

Nitro is not just the server of Nuxt, but can be used as a high performance, deploys everywhere, backend on its own. With Nitro v3 just around the corner, we would love to see either a dedicated @sentry/nitro package, or at least a page in the documentation to set it up manually.

Sentry probably already integrates with Nitro with its Nuxt package, therefore it could be an easy to make this.

Solution Brainstorm

• Add a page to documentation
• Nitro is now a Vite plugin, therefor for sourcemap-upload @sentry/vite-plugin can be used, see [Nitro] Upload sourcemaps #17992 (comment)
• Create a dedicated package @sentry/nitro, related: Nitro SDK #13670
• Keep in mind that Nitro runs in nearly every runtime (Node, Bun, Deno, serverless workers) so possibly dont use any Node specific features

Additional Context

Tip: React with 👍 to help prioritize this improvement. Please use comments to provide useful context, avoiding +1 or me too, to help us triage it.

[linear]

JS-1165

[MickL]

For anyone coming here, this is how I did it with Nitro v3, thanks to @manniL and his article.

Error logging and profiling

plugins/sentry.ts

import { definePlugin } from 'nitro';
import { useRuntimeConfig } from 'nitro/runtime-config';
import * as Sentry from '@sentry/node';
import { nodeProfilingIntegration } from '@sentry/profiling-node';
import { HTTPError } from 'nitro/h3';

export default definePlugin((nitroApp) => {
  const { dsn } = useRuntimeConfig().sentry;

  Sentry.init({
    dsn,
    integrations: [nodeProfilingIntegration()],
    tracesSampleRate: 1.0,
    profileSessionSampleRate: 1.0,
    profileLifecycle: 'trace',
  });

  nitroApp.hooks.hook('error', (error, { event }) => {
    if (error instanceof HTTPError && [400, 401, 404].includes(error.status)) {
      return;
    }

    if (!import.meta.env.PROD) {
      // Dont send events to Sentry in development
      return;
    }
    
    Sentry.captureException(error);
  });

  nitroApp.hooks.hook('request', (event) => {
    event.context.sentry = Sentry;
  });
});

declare module 'nitro/h3' {
  interface H3EventContext {
    sentry?: typeof Sentry;
  }
}

Upload sourcemaps

nitro.config.ts

import { defineNitroConfig } from 'nitro/config';

export default defineNitroConfig({
   sourcemap: true, // For Sentry
});

General

.env

NITRO_SENTRY_DSN=""

Note: Only thing I am worried about is that the package is named @sentry/node but Nitro runs in every runtime (Node, Bun, Deno, serverless workers), not sure if @sentry/node does, too. Keep this in mind if you use any other runtime than Node.

[s1gr1d]

Hy, as already pointed out in the other issue, we are already working on a standalone Nitro SDK. This will support Nitro v3 as well and can be used with Nuxt.

See the tracking issue (you already linked it): #13670

Thank you for providing your current approach but I'll close this issue for now to prevent duplicates. However, we will still check the upvotes on this issue and we can also open it again if there is a good reason for it.

cc @logaretm