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

    2.5.4 • Public • Published


    Official Sentry SDK for Electron

    Travis npm version license

    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
    • Support electron version >= 1.8.x

    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 processees you spawn. This will initialize the SDK and hook into the environment. Note that you can turn off almost all side effects using the respective options.

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

    Deep Dive

    Resources

    Keywords

    none

    Install

    npm i @sentry/electron

    DownloadsWeekly Downloads

    64,237

    Version

    2.5.4

    License

    MIT

    Unpacked Size

    664 kB

    Total Files

    183

    Last publish

    Collaborators

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