export function getNextjsWebpackPluginOptionsTemplate( orgSlug: string, projectSlug: string, ): string { return `{ // For all available options, see: // https://github.com/getsentry/sentry-webpack-plugin#options // Suppresses source map uploading logs during build silent: true, org: "${orgSlug}", project: "${projectSlug}", }`; } export function getNextjsSentryBuildOptionsTemplate(): string { return `{ // For all available options, see: // https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/ // Upload a larger set of source maps for prettier stack traces (increases build time) widenClientFileUpload: true, // Transpiles SDK to be compatible with IE11 (increases bundle size) transpileClientSDK: true, // Routes browser requests to Sentry through a Next.js rewrite to circumvent ad-blockers (increases server load) tunnelRoute: "/monitoring", // Hides source maps from generated client bundles hideSourceMaps: true, // Automatically tree-shake Sentry logger statements to reduce bundle size disableLogger: true, }`; } export function getNextjsConfigCjsTemplate( sentryWebpackPluginOptionsTemplate: string, sentryBuildOptionsTemplate: string, ): string { return `const { withSentryConfig } = require("@sentry/nextjs"); /** @type {import('next').NextConfig} */ const nextConfig = {}; module.exports = withSentryConfig( nextConfig, ${sentryWebpackPluginOptionsTemplate}, ${sentryBuildOptionsTemplate} ); `; } export function getNextjsConfigCjsAppendix( sentryWebpackPluginOptionsTemplate: string, sentryBuildOptionsTemplate: string, ): string { return ` // Injected content via Sentry wizard below const { withSentryConfig } = require("@sentry/nextjs"); module.exports = withSentryConfig( module.exports, ${sentryWebpackPluginOptionsTemplate}, ${sentryBuildOptionsTemplate} ); `; } export function getNextjsConfigEsmCopyPasteSnippet( sentryWebpackPluginOptionsTemplate: string, sentryBuildOptionsTemplate: string, ): string { return ` // next.config.mjs import { withSentryConfig } from "@sentry/nextjs"; export default withSentryConfig( yourNextConfig, ${sentryWebpackPluginOptionsTemplate}, ${sentryBuildOptionsTemplate} ); `; } export function getSentryConfigContents( dsn: string, config: 'server' | 'client' | 'edge', ): string { let primer; if (config === 'server') { primer = `// This file configures the initialization of Sentry on the server. // The config you add here will be used whenever the server handles a request. // https://docs.sentry.io/platforms/javascript/guides/nextjs/`; } else if (config === 'client') { primer = `// This file configures the initialization of Sentry on the client. // The config you add here will be used whenever a users loads a page in their browser. // https://docs.sentry.io/platforms/javascript/guides/nextjs/`; } else if (config === 'edge') { primer = `// This file configures the initialization of Sentry for edge features (middleware, edge routes, and so on). // The config you add here will be used whenever one of the edge features is loaded. // Note that this config is unrelated to the Vercel Edge Runtime and is also required when running locally. // https://docs.sentry.io/platforms/javascript/guides/nextjs/`; } let additionalOptions = ''; if (config === 'client') { additionalOptions = ` replaysOnErrorSampleRate: 1.0, // This sets the sample rate to be 10%. You may want this to be 100% while // in development and sample at a lower rate in production replaysSessionSampleRate: 0.1, // You can remove this option if you're not planning to use the Sentry Session Replay feature: integrations: [ new Sentry.Replay({ // Additional Replay configuration goes in here, for example: maskAllText: true, blockAllMedia: true, }), ],`; } // eslint-disable-next-line @typescript-eslint/restrict-template-expressions return `${primer} import * as Sentry from "@sentry/nextjs"; Sentry.init({ dsn: "${dsn}", // Adjust this value in production, or use tracesSampler for greater control tracesSampleRate: 1, // Setting this option to true will print useful information to the console while you're setting up Sentry. debug: false,${additionalOptions} }); `; } export function getSentryExamplePageContents(options: { selfHosted: boolean; url: string; orgSlug: string; projectId: string; }): string { const issuesPageLink = options.selfHosted ? `${options.url}organizations/${options.orgSlug}/issues/?project=${options.projectId}` : `https://${options.orgSlug}.sentry.io/issues/?project=${options.projectId}`; return `import Head from "next/head"; import * as Sentry from "@sentry/nextjs"; export default function Home() { return (
Sentry Onboarding

Get started by sending us a sample error:

Next, look for the error on the{" "} Issues Page.

For more information, see{" "} https://docs.sentry.io/platforms/javascript/guides/nextjs/

); } `; } export function getSentryExampleApiRoute() { return `// A faulty API route to test Sentry's error monitoring export default function handler(_req, res) { throw new Error("Sentry Example API Route Error"); res.status(200).json({ name: "John Doe" }); } `; }