Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Latest commit

 

History

History
History
 
 

README.md

Outline


Official Sentry SDK for NodeJS (Preview)

npm version npm dm npm dt

WARNING: This SDK is part of an early access preview for the next generation of Sentry JavaScript SDKs. Public interfaces might change and break backwards compatibility from time to time. We absolutely recommend raven in production!

Usage

To use this SDK, call init(options) as early as possible in the main entry module. This will initialize the SDK and hook into the environment. Note that you can turn off almost all side effects using the respective options.

const Sentry = require('@sentry/node');

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

To set context information or send manual events, use the exported functions of @sentry/node. Note that these functions will not perform any action before you have called init():

// 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: [
    // ...
  ],
});

Advanced Usage

If you don't want to use a global static instance of Sentry, you can create one yourself:

const { NodeClient } = require('@sentry/node');

const client = new NodeClient({
  dsn: '__DSN__',
  // ...
});

client.install();
// ...
Morty Proxy This is a proxified and sanitized view of the page, visit original site.