@sentry/nextjs

What is @sentry/nextjs?

The @sentry/nextjs package is a JavaScript SDK for Sentry that provides error tracking and performance monitoring specifically tailored for Next.js applications. It helps developers to automatically capture exceptions, track performance issues, and improve the reliability of their Next.js applications.

What are @sentry/nextjs's main functionalities?

Automatic Error Tracking

Automatically captures unhandled exceptions and errors in the Next.js application and sends them to Sentry for monitoring and analysis.

import * as Sentry from '@sentry/nextjs';

Sentry.init({ dsn: 'YOUR_DSN' });

Performance Monitoring

Enables performance monitoring to track the performance of server-side and client-side Next.js operations, providing insights into slow transactions and bottlenecks.

import * as Sentry from '@sentry/nextjs';

Sentry.init({
  dsn: 'YOUR_DSN',
  tracesSampleRate: 1.0
});

Custom Error Reporting

Allows developers to manually report custom errors or exceptions to Sentry, giving them control over what gets reported.

import * as Sentry from '@sentry/nextjs';

Sentry.captureException(new Error('Custom error message'));

Release Health Tracking

Tracks the health of releases by monitoring error rates and issues that affect end-users, helping developers to understand the impact of new releases.

import * as Sentry from '@sentry/nextjs';

Sentry.init({
  dsn: 'YOUR_DSN',
  release: 'my-project-name@1.0.0'
});

Other packages similar to @sentry/nextjs

bugsnag-js

Bugsnag provides error monitoring for JavaScript applications, including Next.js. It offers similar features to Sentry, such as automatic error detection, custom error reporting, and release tracking. However, Bugsnag's interface and integrations may differ from Sentry's.

raygun4js

Raygun offers real-time error tracking and crash reporting for JavaScript applications. It includes features like user tracking, performance monitoring, and deployment tracking. Raygun's focus on user-centric metrics and detailed diagnostics provides a different perspective compared to Sentry.

logrocket

LogRocket is a frontend application monitoring solution that combines session replay, performance monitoring, and error tracking. Unlike Sentry, which focuses on error and performance data, LogRocket provides insights into user interactions and experiences by recording user sessions.

README

Official Sentry SDK for Next.js

See the Official Sentry Next.js SDK Docs 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:

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:

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
• Sentry.io
• Sentry Discord Server
• Stack Overflow

Changelog

8.23.0

Important Changes

• feat(cloudflare): Add Cloudflare D1 instrumentation (#13142)

This release includes support for Cloudflare D1, Cloudflare's serverless SQL database. To instrument your Cloudflare D1 database, use the instrumentD1WithSentry method as follows:

// env.DB is the D1 DB binding configured in your `wrangler.toml`
const db = instrumentD1WithSentry(env.DB);
// Now you can use the database as usual
await db.prepare('SELECT * FROM table WHERE id = ?').bind(1).run();

Other Changes

• feat(cloudflare): Allow users to pass handler to sentryPagesPlugin (#13192)
• feat(cloudflare): Instrument scheduled handler (#13114)
• feat(core): Add getTraceData function (#13134)
• feat(nestjs): Automatic instrumentation of nestjs interceptors before route execution (#13153)
• feat(nestjs): Automatic instrumentation of nestjs pipes (#13137)
• feat(nuxt): Filter out Nuxt build assets (#13148)
• feat(profiling): Attach sdk info to chunks (#13145)
• feat(solidstart): Add sentry onBeforeResponse middleware to enable distributed tracing (#13221)
• feat(solidstart): Filter out low quality transactions for build assets (#13222)
• fix(browser): Avoid showing browser extension error message in non-window global scopes (#13156)
• fix(feedback): Call dialog.close() in dialog close callbacks in \_loadAndRenderDialog (#13203)
• fix(nestjs): Inline Observable type to resolve missing 'rxjs' dependency (#13166)
• fix(nuxt): Detect pageload by adding flag in Vue router (#13171)
• fix(utils): Handle when requests get aborted in fetch instrumentation (#13202)
• ref(browser): Improve browserMetrics collection (#13062)

Work in this release was contributed by @horochx. Thank you for your contribution!