@sentry/electron
TypeScript icon, indicating that this package has built-in type declarations

5.2.0 • Public • Published

Sentry

Official Sentry SDK for Electron

Build & Test Documentation npm version license Discord

Features

  • Captures Node errors in the main process (using @sentry/node)
  • Captures JavaScript errors in renderer processes (using @sentry/browser)
  • Captures native crashes (Minidump crash reports) from renderers and the main process
  • Collects breadcrumbs and context information along with events across renderers and the main process
  • Supports electron >= v15

Usage

To use this SDK, call init(options) as early as possible in the entry modules in the main process as well as all renderer processes or further sub processes you spawn. This will initialize the SDK and hook the environment.

In the Electron main process:

import { init } from '@sentry/electron/main';

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

In all Electron renderer processes:

// In the Electron renderer processes
import { init } from '@sentry/electron/renderer';

init();

If you are using a framework specific Sentry SDK, you can pass that init function as the second parameter in the renderer and the two SDKs functionalities will be combined:

import { init } from '@sentry/electron/renderer';
import { init as reactInit } from '@sentry/react';

init({ /* config */ }, reactInit);

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

import * as Sentry from '@sentry/electron/main';

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

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

Contributors

Thanks to everyone who contributed to the Sentry Electron SDK!

Readme

Keywords

none

Package Sidebar

Install

npm i @sentry/electron

Weekly Downloads

68,143

Version

5.2.0

License

MIT

Unpacked Size

881 kB

Total Files

379

Last publish

Collaborators

  • benvinegar
  • billyvg
  • mitsuhiko
  • haza
  • jauer
  • sentry-bot
  • evanpurkhiser
  • lynnagara
  • leedongwei
  • markstory
  • zeeg