@sentry/electron

What is @sentry/electron?

@sentry/electron is a package that provides error tracking and performance monitoring for Electron applications. It allows developers to capture and report errors, monitor application performance, and gain insights into application behavior in production environments.

What are @sentry/electron's main functionalities?

Error Tracking

This feature allows developers to initialize Sentry in their Electron application to automatically capture and report errors. The DSN (Data Source Name) is used to identify the project in Sentry.

const { init } = require('@sentry/electron');

init({
  dsn: 'https://[e-mail]/0',
});

Performance Monitoring

This feature enables performance monitoring by setting a sample rate for tracing. It helps in capturing performance data to analyze application speed and responsiveness.

const { init } = require('@sentry/electron');

init({
  dsn: 'https://[e-mail]/0',
  tracesSampleRate: 1.0,
});

Breadcrumbs

Breadcrumbs are used to record events leading up to an error. This feature allows developers to add custom breadcrumbs to provide context around errors.

const { addBreadcrumb } = require('@sentry/electron');

addBreadcrumb({
  category: 'ui.click',
  message: 'User clicked on button',
  level: 'info',
});

Other packages similar to @sentry/electron

electron-log

electron-log is a package for logging in Electron applications. Unlike @sentry/electron, it focuses on logging messages to files, console, and remote endpoints without providing error tracking or performance monitoring capabilities.

winston

Winston is a versatile logging library for Node.js applications, including Electron. It provides logging capabilities but lacks the integrated error tracking and performance monitoring features of @sentry/electron.

log4js

log4js is another logging library for Node.js that can be used in Electron applications. It offers logging features similar to winston but does not include the error tracking and performance monitoring functionalities of @sentry/electron.

README

Official Sentry SDK for Electron

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!