getsentry / sentry-electron

The official Sentry SDK for Electron

Home Page:https://sentry.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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 >= 2

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 into the environment.

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

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

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';

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

About

The official Sentry SDK for Electron

https://sentry.io/

License:MIT License


Languages

Language:TypeScript 79.9%Language:JavaScript 15.0%Language:HTML 5.0%Language:Shell 0.1%