@vicrab/node v1.0.1

Official Vicrab SDK for NodeJS

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.

// ES5 Syntax
const Vicrab = require('@vicrab/node');
// ES6 Syntax
import * as Vicrab from '@vicrab/node';

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

To set context information or send manual events, use the exported functions of @vicrab/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
Vicrab.configureScope(scope => {
  scope.setExtra('battery', 0.7);
  scope.setTag('user_mode', 'admin');
  scope.setUser({ id: '4711' });
  // scope.clear();
});

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

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