Official Sentry SDK for Next.js

Links

• Official SDK Docs
• TypeDoc

Compatibility

Currently, the minimum Next.js supported version is 10.0.8.

General

This package is a wrapper around @sentry/node for the server and @sentry/react for the client, with added functionality related to Next.js.

To use this SDK, init it in the Sentry config files.

// sentry.client.config.js

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

Sentry.init({
  dsn: "__DSN__",
  // ...
});
Copy

// sentry.server.config.js

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

Sentry.init({
  dsn: "__DSN__",
  // ...
});
Copy

To set context information or send manual events, use the exported functions of @sentry/nextjs.

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

// Set user information, as well as tags and further extras
Sentry.configureScope(scope => {
  scope.setExtra('battery', 0.7);
  scope.setTag('user_mode', 'admin');
  scope.setUser({ id: '4711' });
  // scope.clear();
});

// Add a breadcrumb for future events
Sentry.addBreadcrumb({
  message: 'My Breadcrumb',
  // ...
});

// Capture exceptions, messages or manual events
Sentry.captureMessage('Hello, world!');
Sentry.captureException(new Error('Good bye'));
Sentry.captureEvent({
  message: 'Manual',
  stacktrace: [
    // ...
  ],
});
Copy