diff --git a/docs/platforms/javascript/guides/nextjs/index.mdx b/docs/platforms/javascript/guides/nextjs/index.mdx index cf45d286357251..d3f5ab35ea36b1 100644 --- a/docs/platforms/javascript/guides/nextjs/index.mdx +++ b/docs/platforms/javascript/guides/nextjs/index.mdx @@ -21,20 +21,7 @@ npx @sentry/wizard@latest -i nextjs The wizard then guides you through the setup process, asking you to enable additional (optional) Sentry features for your application beyond error monitoring. - - -- [**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. - - + 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. diff --git a/docs/platforms/javascript/guides/nextjs/manual-setup.mdx b/docs/platforms/javascript/guides/nextjs/manual-setup.mdx index 99f2de1096250f..a0eb8166983b30 100644 --- a/docs/platforms/javascript/guides/nextjs/manual-setup.mdx +++ b/docs/platforms/javascript/guides/nextjs/manual-setup.mdx @@ -19,20 +19,7 @@ Choose the features you want to configure, and this guide will show you how: options={["error-monitoring", "performance", "session-replay"]} /> - - -- [**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. - - + ### Install the Sentry SDK diff --git a/docs/platforms/javascript/guides/nuxt/index.mdx b/docs/platforms/javascript/guides/nuxt/index.mdx index f50a30e3fd4c7f..175934c809ce2c 100644 --- a/docs/platforms/javascript/guides/nuxt/index.mdx +++ b/docs/platforms/javascript/guides/nuxt/index.mdx @@ -1,6 +1,6 @@ --- title: Nuxt -description: Nuxt is a framework for full-stack web apps and websites. Learn how to set it up with Sentry. +description: Learn how to set up and configure Sentry in your Nuxt application using the installation wizard, capture your first errors, and view them in Sentry. sdk: sentry.javascript.nuxt categories: - javascript @@ -9,128 +9,90 @@ categories: --- - This SDK is currently in **beta**. Beta features are still in progress and may have bugs. Please reach out on - [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback or concerns. + This SDK is currently in **beta**. Beta features are still in progress and may + have bugs. Please reach out on + [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if + you have any feedback or concerns. -Sentry's Nuxt SDK enables automatic reporting of errors and performance data. - -## Compatibility - -The Sentry Nuxt SDK supports Nuxt version `3.7.0` and above. For best results, we recommend -using Nuxt `3.14.0` or later, which includes updated dependencies critical to the SDK's functionality. - -## Install - -Sentry captures data by using an SDK within your application’s runtime. +## Step 1: Install -We recommend installing the SDK by running our installation wizard in the root directory of your project: +To install Sentry using the installation wizard, run the following command within your project: ```bash npx @sentry/wizard@latest -i nuxt ``` -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 or update Nuxt files with the default Sentry configuration: - - `sentry.(client|server).config.ts` to initialize the SDK - - `nuxt.config.ts` to add build options to add source maps upload and auto-instrumentation via Vite plugins. -- create a `.env.sentry-build-plugin` file with an auth token to upload source maps (this file is automatically added to `.gitignore`) -- add an example page to your frontend app and your server to verify your Sentry setup + -After the wizard setup is completed, the SDK will automatically capture unhandled errors, and monitor performance. +This guide assumes that you enable all features and allow the wizard to create an example page or component. You can add or remove features at any time, but setting them up now will save you the effort of configuring them manually later. -You can also manually capture errors. + +- Creates `sentry.(client|server).config.ts` to initialize the SDK +- Creates or updates your `nuxt.config.ts` to add build options to add source maps upload and auto-instrumentation via Vite plugins +- Creates `.env.sentry-build-plugin` 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 + - If it couldn't create a page, the wizard adds an example component instead - - If the setup through the wizard doesn't work for you, you can also set up the SDK manually. - + -## Configure +## Step 2: Verify Your Setup -Configuration should happen as early as possible in your application's lifecycle. +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 created by the installation wizard. -To complete your configuration, add options to your `Sentry.init()` calls. + +The wizard creates a `SentryErrorButton` component when it fails to add an example page to your project. This usually happens if you don't have a `app.vue` file or if that file does not contain the `NuxtPage` component. To verify your setup, follow these steps before continuing with the next section, "View Captured Data in Sentry": -Here, you'll also be able to set context data, which includes data about the user, tags, or even arbitrary data, all of which will be added to every event sent to Sentry. +1. Add the `SentryErrorButton` component to a page and open it in your browser. For most Nuxt applications, this will be at localhost. +2. Click the "Throw Sample Error" button, which triggers an error and starts a performance trace on the client side. -## Verify +To test the server side as well, refer to the "Verify" section in the [Manual setup guide](/platforms/javascript/guides/nuxt/manual-setup/). -This snippet includes an intentional error, so you can test that everything is working as soon as you set it up. + -### Server-side +To test Sentry on the server side, you first need to build your project since Sentry's server-side monitoring **doesn't work in development mode**.\ +Then run your project and make sure to load Sentry on the server side by explicitly adding it via [`--import`](/platforms/javascript/guides/nuxt/install/cli-import/): -Sentry can only be loaded on the server-side by being explicitly added via `--import`. -Check out the `--import` CLI flag docs for setup instructions. +``` +# Start your app after building your project with `nuxi build` +node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs +``` -To verify that Sentry works on the server-side, add the following snippet on the server-side: +After building and running your project: -```js {tabTitle:Nitro} {filename:server/api/sentry-example.get.ts} -export default defineEventHandler(event => { - throw new Error("Sentry Example API Route Error"); -}); -``` +1. Open the example page `/sentry-example-page` in your browser. For most Nuxt applications, this will be at localhost. +2. Click the "Throw sample error" button. This triggers two errors: + - a frontend error + - an error within the API route -If you want to test server-side monitoring locally, build your project and run: - ``` - # Start your app after building your project with `nuxi build` - node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs - ``` +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. - - Sentry server-side monitoring **doesn't work in development mode!** +### View Captured Data in Sentry - If you experience any issues with the server-side setup, check out Troubleshooting - or read through the different installation methods. - +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). -### Client-side - -Add the following snippet on the client-side: - -```html {tabTitle:Vue} {filename:pages/example-error.vue} - - - -``` + + + - +## Next Steps -Learn more about manually capturing an error or message in our Usage documentation. +At this point, you should have integrated Sentry into your Nuxt 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: -To view and resolve the recorded error, log into [sentry.io](https://sentry.io) and select your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved. +- Learn how to [manually capture errors](/platforms/javascript/guides/nuxt/usage/) +- Continue to [customize your configuration](/platforms/javascript/guides/nuxt/configuration/) +- Get familiar with [Sentry's product features](/product) like tracing, insights, and alerts +- Learn how to [track your Vue components or your Pinia store](/platforms/javascript/guides/nuxt/features/) -## Next Steps + + +- If you encountered issues with our installation wizard, try [setting up Sentry manually](/platforms/javascript/guides/nuxt/manual-setup/) +- [Get support](https://sentry.zendesk.com/hc/en-us/) -- Track your Vue Components or your Pinia store by [adding support for client features](/platforms/javascript/guides/nuxt/features/) -- In case you experience any issues during setup or startup, check out Troubleshooting -or read through the different installation methods. + diff --git a/docs/platforms/javascript/guides/react/index.mdx b/docs/platforms/javascript/guides/react/index.mdx index 4222d5488ac384..008153bba9041e 100644 --- a/docs/platforms/javascript/guides/react/index.mdx +++ b/docs/platforms/javascript/guides/react/index.mdx @@ -17,20 +17,7 @@ Choose the features you want to configure, and this guide will show you how: options={["error-monitoring", "performance", "session-replay"]} /> - - -- [**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. - - + ### Install the Sentry SDK diff --git a/docs/platforms/javascript/guides/tanstackstart-react/index.mdx b/docs/platforms/javascript/guides/tanstackstart-react/index.mdx index cc623dd8e2306d..d796edd749cbe4 100644 --- a/docs/platforms/javascript/guides/tanstackstart-react/index.mdx +++ b/docs/platforms/javascript/guides/tanstackstart-react/index.mdx @@ -13,20 +13,7 @@ Choose the features you want to configure, and this guide will show you how: options={["error-monitoring", "performance", "session-replay"]} /> - - -- [**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. - - + Run the command for your preferred package manager to add the SDK package to your application: diff --git a/platform-includes/getting-started-features-expandable/_default.mdx b/platform-includes/getting-started-features-expandable/_default.mdx new file mode 100644 index 00000000000000..aa7caac60f58cd --- /dev/null +++ b/platform-includes/getting-started-features-expandable/_default.mdx @@ -0,0 +1,14 @@ + + +- [**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. + + diff --git a/platform-includes/getting-started-features-expandable/javascript.node.mdx b/platform-includes/getting-started-features-expandable/javascript.node.mdx new file mode 100644 index 00000000000000..af2368dbab320c --- /dev/null +++ b/platform-includes/getting-started-features-expandable/javascript.node.mdx @@ -0,0 +1,11 @@ + + +- [**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. +- [**Profiling**](/product/explore/profiling/): Gain deeper insight than traditional tracing without custom instrumentation, letting you discover slow-to-execute or resource-intensive functions in your app. + + diff --git a/platform-includes/getting-started-node/javascript.mdx b/platform-includes/getting-started-node/javascript.mdx index 9fe14f424912bd..28b9ba96f53f55 100644 --- a/platform-includes/getting-started-node/javascript.mdx +++ b/platform-includes/getting-started-node/javascript.mdx @@ -8,17 +8,7 @@ Choose the features you want to configure, and this guide will show you how: options={["error-monitoring", "performance", "profiling"]} /> - - -- [**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. -- [**Profiling**](/product/explore/profiling/): Gain deeper insight than traditional tracing without custom instrumentation, letting you discover slow-to-execute or resource-intensive functions in your app. - - + ### Install the Sentry SDK @@ -78,13 +68,7 @@ Let's test your setup and confirm that Sentry is working correctly and sending d 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). - - -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 [**Profiles**](https://sentry.io/orgredirect/organizations/:orgslug/profiling) page, select a transaction, and then a profile ID to view its flame graph. For more information, click [here](/product/explore/profiling/profile-details/). - - + ## Next Steps diff --git a/platform-includes/getting-started-prerequisites/javascript.nuxt.mdx b/platform-includes/getting-started-prerequisites/javascript.nuxt.mdx new file mode 100644 index 00000000000000..76ff039776f4aa --- /dev/null +++ b/platform-includes/getting-started-prerequisites/javascript.nuxt.mdx @@ -0,0 +1,7 @@ +## Prerequisites + +You need: + +- A Sentry [account](https://sentry.io/signup/) and [project](/product/projects/) +- Your application up and running +- Nuxt version `3.7.0` or above (`3.14.0`+ recommended) diff --git a/platform-includes/getting-started-verify-locate-data/javascript.node.mdx b/platform-includes/getting-started-verify-locate-data/javascript.node.mdx new file mode 100644 index 00000000000000..cb1d4cacf62ed4 --- /dev/null +++ b/platform-includes/getting-started-verify-locate-data/javascript.node.mdx @@ -0,0 +1,7 @@ + + +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 [**Profiles**](https://sentry.io/orgredirect/organizations/:orgslug/profiling) page, select a transaction, and then a profile ID to view its flame graph. For more information, click [here](/product/explore/profiling/profile-details/). + +