Skip to content

Commit

Permalink
update wizard instructions and add troubleshooting item
Browse files Browse the repository at this point in the history
  • Loading branch information
s1gr1d committed Nov 28, 2024
1 parent 87b5764 commit 91214a2
Show file tree
Hide file tree
Showing 5 changed files with 96 additions and 41 deletions.
49 changes: 42 additions & 7 deletions docs/platforms/javascript/common/troubleshooting/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -470,21 +470,21 @@ Learn more about fixing these caching issues in the <PlatformLink to="/sourcemap
```json {tabTitle:npm} {filename:package.json}
"overrides": {
"@vercel/nft": "^0.27.4"
}
"@vercel/nft": "^0.27.4"
}
```
```json {tabTitle:yarn} {filename:package.json}
"resolutions": {
"@vercel/nft": "^0.27.4"
}
"@vercel/nft": "^0.27.4"
}
```
```json {tabTitle:pnpm} {filename:package.json}
"pnpm": {
"overrides": {
"@vercel/nft": "^0.27.4"
}
"overrides": {
"@vercel/nft": "^0.27.4"
}
}
```
Expand All @@ -501,6 +501,41 @@ Learn more about fixing these caching issues in the <PlatformLink to="/sourcemap
pnpm add import-in-the-middle
```
</Expandable>
<Expandable permalink title="Nuxt: Server-side Nitro is not sending events">
Nuxt builds the server-side Nitro application as ES Modules, which introduces limitations for server-side tracing during development.
Currently, trace collection is only supported when running the built application, not in development mode (`nuxt dev`).
To collect traces, build your project and run the production build output.
---
We are currently investigating an issue where the server-side is not correctly initialized with a recent update of Nitro (the server-side toolkit in Nuxt).
We are working on figuring this out ([see issue here](https://github.com/getsentry/sentry-javascript/issues/14514)). For the time being, you can add the following overrides to your application:
```json {tabTitle:npm} {filename:package.json}
"overrides": {
"nitropack": "2.9.7"
"@vercel/nft": "^0.27.4"
}
```
```json {tabTitle:yarn} {filename:package.json}
"resolutions": {
"nitropack": "2.9.7"
"@vercel/nft": "^0.27.4"
}
```
```json {tabTitle:pnpm} {filename:package.json}
"pnpm": {
"overrides": {
"nitropack": "2.9.7"
"@vercel/nft": "^0.27.4"
}
}
```
</Expandable>
</PlatformSection>
If you need additional help, you can [ask on GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose). Customers on a paid plan may also contact support.
28 changes: 27 additions & 1 deletion docs/platforms/javascript/guides/nuxt/manual-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,33 @@ If you can't (or prefer not to) run the <PlatformLink to="/#install">automatic s

## Compatibility

The minimum supported Nuxt version is `3.7.0`.
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.

In case you are using Nuxt before version `3.14.0`, add the following overrides:

```json {tabTitle:npm} {filename:package.json}
"overrides": {
"ofetch": "^1.4.0"
"@vercel/nft": "^0.27.4"
}
```

```json {tabTitle:yarn} {filename:package.json}
"resolutions": {
"ofetch": "^1.4.0"
"@vercel/nft": "^0.27.4"
}
```

```json {tabTitle:pnpm} {filename:package.json}
"pnpm": {
"overrides": {
"ofetch": "^1.4.0"
"@vercel/nft": "^0.27.4"
}
}
```

## Install

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
## Next Steps

- 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 <PlatformLink to="/troubleshooting">Troubleshooting</PlatformLink>


or read through the different <PlatformLink to="/install">installation methods</PlatformLink>.
- In case you experience any issues during setup or startup, check out <PlatformLink to="/troubleshooting">Troubleshooting</PlatformLink>.
53 changes: 24 additions & 29 deletions platform-includes/getting-started-primer/javascript.nuxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,30 @@ Sentry's Nuxt SDK enables automatic reporting of errors and performance data.

## Compatibility

The minimum supported Nuxt version is `3.7.0`.

<Note>
We are currently investigating an issue where the server-side is not correctly initialized with a recent update of Nitro (the server-side toolkit in Nuxt).

We are working on figuring this out ([see issue here](https://github.com/getsentry/sentry-javascript/issues/14514)). For the time being, you can add the following overrides to your application:

<br/>

```json {tabTitle:npm} {filename:package.json}
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.

In case you are using Nuxt before version `3.14.0`, add the following overrides:

```json {tabTitle:npm} {filename:package.json}
"overrides": {
"ofetch": "^1.4.0"
"@vercel/nft": "^0.27.4"
}
```

```json {tabTitle:yarn} {filename:package.json}
"resolutions": {
"ofetch": "^1.4.0"
"@vercel/nft": "^0.27.4"
}
```

```json {tabTitle:pnpm} {filename:package.json}
"pnpm": {
"overrides": {
"nitropack": "2.9.7"
"ofetch": "^1.4.0"
"@vercel/nft": "^0.27.4"
}
```

```json {tabTitle:yarn} {filename:package.json}
"resolutions": {
"nitropack": "2.9.7"
"@vercel/nft": "^0.27.4"
}
```

```json {tabTitle:pnpm} {filename:package.json}
"pnpm": {
"overrides": {
"nitropack": "2.9.7"
"@vercel/nft": "^0.27.4"
}
}
```
</Note>
}
```
2 changes: 2 additions & 0 deletions platform-includes/getting-started-verify/javascript.nuxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,6 @@ export default defineEventHandler(event => {
# Start your app after building your project with `nuxi build`
node .output/server/index.mjs
```

In case you experience any issues with the server-side setup, check out <PlatformLink to="/troubleshooting">Troubleshooting</PlatformLink>.
</Alert>

0 comments on commit 91214a2

Please sign in to comment.