Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
60 lines
2.1 KiB
Plaintext
60 lines
2.1 KiB
Plaintext
<p align="center">
|
|
<a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
|
|
<img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84">
|
|
</a>
|
|
</p>
|
|
|
|
# Official Sentry SDK for Next.js
|
|
|
|
[](https://www.npmjs.com/package/@sentry/nextjs)
|
|
[](https://www.npmjs.com/package/@sentry/nextjs)
|
|
[](https://www.npmjs.com/package/@sentry/nextjs)
|
|
|
|
> See the [Official Sentry Next.js SDK Docs](https://docs.sentry.io/platforms/javascript/guides/nextjs/) to get started.
|
|
|
|
## Compatibility
|
|
|
|
Currently, the minimum supported version of Next.js is `13.2.0`.
|
|
|
|
## Installation
|
|
|
|
To get started installing the SDK, use the Sentry Next.js Wizard by running the following command in your terminal or
|
|
read the [Getting Started Docs](https://docs.sentry.io/platforms/javascript/guides/nextjs/):
|
|
|
|
```sh
|
|
npx @sentry/wizard@latest -i nextjs
|
|
```
|
|
|
|
The wizard will prompt you to log in to Sentry. After the wizard setup is completed, the SDK will automatically capture
|
|
unhandled errors, and monitor performance.
|
|
|
|
## Custom Usage
|
|
|
|
To set context information or to send manual events, you can use `@sentry/nextjs` as follows:
|
|
|
|
```ts
|
|
import * as Sentry from '@sentry/nextjs';
|
|
|
|
// Set user information, as well as tags and further extras
|
|
Sentry.setTag('user_mode', 'admin');
|
|
Sentry.setUser({ id: '4711' });
|
|
Sentry.setContext('application_area', { location: 'checkout' });
|
|
|
|
// Add a breadcrumb for future events
|
|
Sentry.addBreadcrumb({
|
|
message: '"Add to cart" clicked',
|
|
// ...
|
|
});
|
|
|
|
// Capture exceptions or messages
|
|
Sentry.captureException(new Error('Oh no.'));
|
|
Sentry.captureMessage('Hello, world!');
|
|
```
|
|
|
|
## Links
|
|
|
|
- [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/nextjs/)
|
|
- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_nextjs)
|
|
- [Sentry Discord Server](https://discord.gg/Ww9hbqr)
|
|
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry)
|