diff --git a/docs/platforms/javascript/common/index.mdx b/docs/platforms/javascript/common/index.mdx index ca1c07e5a3bac..a8426f6730af5 100644 --- a/docs/platforms/javascript/common/index.mdx +++ b/docs/platforms/javascript/common/index.mdx @@ -16,7 +16,10 @@ Check out the other SDKs we support in the left-hand dropdown. ## Prerequisites -* You need a Sentry [account](https://sentry.io/signup/) and [project](/product/projects/) +You need: + +- A Sentry [account](https://sentry.io/signup/) and [project](/product/projects/) +- Your application up and running @@ -32,11 +35,23 @@ Select which Sentry features you'd like to install in addition to Error Monitori + + +## Step 1: Install + + + + + ## Install + + - + @@ -64,12 +79,17 @@ Select which Sentry features you'd like to install in addition to Error Monitori + + Sentry captures data by using an SDK within your application’s runtime. + + + ## Configure @@ -86,6 +106,8 @@ Sentry supports multiple versions of React Router. To learn how to configure the + + @@ -96,6 +118,14 @@ Sentry supports multiple versions of React Router. To learn how to configure the + + + + + + + + ## Verify This snippet includes an intentional error, so you can test that everything is working as soon as you set it up. @@ -110,4 +140,6 @@ Learn more about manually capturing an error or message in our + diff --git a/docs/platforms/javascript/guides/nextjs/config.yml b/docs/platforms/javascript/guides/nextjs/config.yml index bed3f7977d4c5..87587bbfe0184 100644 --- a/docs/platforms/javascript/guides/nextjs/config.yml +++ b/docs/platforms/javascript/guides/nextjs/config.yml @@ -1,5 +1,5 @@ -title: Next.js -description: Next.js is a flexible React framework that gives you building blocks to create fast, full-stack web applications. Learn how to set it up with Sentry. +title: 'Next.js' +description: Learn how to set up and configure Sentry in your Next.js application using the installation wizard, capture your first errors, and view them in Sentry. sdk: sentry.javascript.nextjs categories: - javascript diff --git a/platform-includes/getting-started-install/javascript.nextjs.mdx b/platform-includes/getting-started-install/javascript.nextjs.mdx index 2be74b8fe81c0..810b56e4a3191 100644 --- a/platform-includes/getting-started-install/javascript.nextjs.mdx +++ b/platform-includes/getting-started-install/javascript.nextjs.mdx @@ -1,24 +1,34 @@ -We recommend installing the SDK through our installation wizard: +To install Sentry using the installation wizard, run the following command within your project: ```bash npx @sentry/wizard@latest -i nextjs ``` -The wizard will prompt you to log in to Sentry. It will then automatically do the following steps for you: +The wizard then guides you through the setup process, asking you to enable additional (optional) Sentry features for your application beyond error monitoring. -- create config files with the default `Sentry.init()` calls for each runtime (node, browser, edge) -- add a Next.js instrumentation hook to your project (`instrumentation.ts`) -- create or update your Next.js config with the default Sentry configuration -- create `.sentryclirc` with an auth token to upload source maps (this file is automatically added to `.gitignore`) -- add an example page to your app to verify your Sentry setup + -After the wizard setup is completed, the SDK will automatically capture unhandled errors, and monitor performance. -You can also manually capture errors. +- [**Issues**](/product/issues) (always enabled): Sentry's core error monitoring product that automatically reports errors, + uncaught exceptions, and unhandled rejections. If you have something that + looks like an exception, Sentry can capture it. +- [**Tracing**](/product/tracing): Track software performance while seeing the + impact of errors across multiple systems. For example, distributed tracing + allows you to follow a request from the frontend to the backend and back. +- [**Session Replay**](/product/explore/session-replay/web): + Get to the root cause of an issue faster by viewing a video-like reproduction + of what was happening in the user's browser before, during, and after the + problem. -To learn how to connect your app to Sentry and deploy it on Vercel, see the [Vercel integration](/organization/integrations/deployment/vercel/). + - +This guide assumes that you enable all features and allow the wizard to create an example page and route. You can add or remove features at any time, but setting them up now will save you the effort of configuring them manually later. -If the setup through the wizard doesn't work for you, you can also set up the SDK manually. + - +- Creates config files with the default `Sentry.init()` calls for all runtimes (Node.js, Browser, and Edge) +- Adds a Next.js instrumentation hook to your project (`instrumentation.ts`) +- Creates or updates your Next.js config with the default Sentry settings +- Creates `.sentryclirc` with an auth token to upload source maps (this file is automatically added to `.gitignore`) +- Adds an example page and route to your application to help verify your Sentry setup + + diff --git a/platform-includes/getting-started-next-steps/javascript.nextjs.mdx b/platform-includes/getting-started-next-steps/javascript.nextjs.mdx new file mode 100644 index 0000000000000..0df6191599bc5 --- /dev/null +++ b/platform-includes/getting-started-next-steps/javascript.nextjs.mdx @@ -0,0 +1,18 @@ +## Next Steps + +At this point, you should have integrated Sentry into your Next.js application and should already be sending error and performance data to your Sentry project. + +Now's a good time to customize your setup and look into more advanced topics. +Our next recommended steps for you are: + +- Learn how to [manually capture errors](/platforms/javascript/guides/nextjs/usage/) +- Continue to [customize your configuration](/platforms/javascript/guides/nextjs/configuration/) +- Get familiar with [Sentry's product features](/product) like tracing, insights, and alerts +- Learn more about our [Vercel integration](/organization/integrations/deployment/vercel/) + + + +- If you encountered issues with our installation wizard, try [setting up Sentry manually](/platforms/javascript/guides/nextjs/manual-setup/) +- [Get support](https://sentry.zendesk.com/hc/en-us/) + + diff --git a/platform-includes/getting-started-primer/javascript.nextjs.mdx b/platform-includes/getting-started-primer/javascript.nextjs.mdx index 6cbd7f3cb1f61..e69de29bb2d1d 100644 --- a/platform-includes/getting-started-primer/javascript.nextjs.mdx +++ b/platform-includes/getting-started-primer/javascript.nextjs.mdx @@ -1,24 +0,0 @@ -Features: - -- Automatic [Error Tracking](/product/issues/) with source maps for both JavaScript and TypeScript -- Automatic [Tracing](/product/performance/) for both the client and server -- Errors and Performance support for [Middleware](https://vercel.com/docs/concepts/functions/edge-middleware) and [Edge routes](https://vercel.com/docs/concepts/functions/edge-functions) in Vercel's edge runtime. Due to complexities with the runtime, some features of errors like stack traces may not be as expected. Requires sentry.edge.config.js, more info [here](/platforms/javascript/guides/nextjs/manual-setup/#create-initialization-config-files) -- Events [enriched](/platforms/javascript/enriching-events/context/) with device data -- [Breadcrumbs](/platforms/javascript/enriching-events/breadcrumbs/) created for outgoing HTTP request with XHR and Fetch, and console logs -- [Release health](/product/releases/health/) for tracking crash-free users and sessions - - - -The Sentry SDK does not fully support `next dev --turbo` while Turbopack does not ship all the features required to run Sentry. - -Currently, when you run your devserver with Turbopack, the Sentry Next.js SDK will not be loaded in the browser. -Keep this in mind when configuring the SDK. - -Note that this only affects the devserver. -The Sentry SDK will run without issues when you do a production build, even if you develop locally with Turbopack. - -To support the SDK in the browser with Turbopack, [follow the feature request for client-side instrumentation in the Next.js repository](https://github.com/vercel/next.js/discussions/69294). - -You can track Sentry's Turbopack support in the [GitHub Issue in the Sentry SDK repository](https://github.com/getsentry/sentry-javascript/issues/8105). - - diff --git a/platform-includes/getting-started-verify/javascript.nextjs.mdx b/platform-includes/getting-started-verify/javascript.nextjs.mdx index 789594e95cefc..68f15637aebe5 100644 --- a/platform-includes/getting-started-verify/javascript.nextjs.mdx +++ b/platform-includes/getting-started-verify/javascript.nextjs.mdx @@ -1,46 +1,42 @@ -Add a button to a frontend component that throws an error: +## Step 2: Verify Your Setup -```javascript {filename:pages/index.js} - -``` + -And throw an error in an API route: +The Sentry SDK doesn't fully support `next dev --turbo` as Turbopack is still under development. This means that the Sentry SDK will not capture any data from your frontend. Other than that, your dev server should be fully operational. -```javascript {filename:pages/api/error.js} -export default (req, res) => { - throw new Error("API throw error test"); - res.status(200).json({ name: "John Doe" }); -}; -``` +Check the latest information on [Sentry's support for Turbopack on GitHub](https://github.com/getsentry/sentry-javascript/issues/8105). -```typescript {filename:pages/api/error.ts} -import type { NextApiRequest, NextApiResponse } from "next"; + -export default (req: NextApiRequest, res: NextApiResponse) => { - throw new Error("API throw error test"); - res.status(200).json({ name: "John Doe" }); -}; -``` +If you haven't tested your Sentry configuration yet, let's do it now. You can confirm that Sentry is working properly and sending data to your Sentry project by using the example page and route created by the installation wizard: - +1. Open the example page `/sentry-example-page` in your browser. For most Next.js applications, this will be at localhost. +2. Click the "Throw error" button. This triggers two errors: + - a frontend error + - an error within the API route -Errors triggered from within Browser DevTools are sandboxed, so they will not trigger error monitoring. Keep this in mind when verifying your Sentry SDK installation. +Sentry captures both of these errors for you. Additionally, the button click starts a performance trace to measure the time it takes for the API request to complete. + + + +Don't forget to explore the example files' code in your project to understand what's happening after your button click. - +### View Captured Data in Sentry -Prior to Next.js version 15, errors thrown in nested React Server Components were not exposed by the framework, preventing the SDK from capturing them. +Now, head over to your project on [Sentry.io](https://sentry.io) to view the collected data (it takes a couple of moments for the data to appear). -Next.js 15 introduced an `onRequestError` hook in `instrumentation.ts` that allows capturing and reporting these errors. + -Refer to Capturing Errors From Nested React Server Components for detailed setup instructions. +Errors triggered from within your browser's developer tools (i.e., the browser console) are sandboxed, so they will not trigger Sentry's error monitoring. + + + +1. Open the [**Issues**](https://sentry.io/orgredirect/organizations/:orgslug/issues) page and select an error from the issues list to view the full details and context of this error. For an interactive UI walkthrough, click [here](/product/sentry-basics/integrate-frontend/generate-first-error/#ui-walkthrough). +2. Open the [**Traces**](https://sentry.io/orgredirect/organizations/:orgslug/traces) page and select a trace to reveal more information about each span, its duration, and any errors. For an interactive UI walkthrough, click [here](/product/sentry-basics/distributed-tracing/generate-first-error/#ui-walkthrough). +3. Open the [**Replays**](https://sentry.io/orgredirect/organizations/:orgslug/replays) page and select an entry from the list to get a detailed view where you can replay the interaction and get more information to help you troubleshoot. + +