crashReporter

Submit crash reports to a remote server.

Important

If you want to call this API from a renderer process with context isolation enabled, place the API call in your preload script and expose it using the contextBridge API.

The following is an example of setting up Electron to automatically submit crash reports to a remote server:

const { crashReporter } = require('electron')

crashReporter.start({ submitURL: 'https://your-domain.com/url-to-submit' })

For setting up a server to accept and process crash reports, you can use following projects:

socorro
mini-breakpad-server

Note

Electron uses Crashpad, not Breakpad, to collect and upload crashes, but for the time being, the upload protocol is the same.

Or use a 3rd party hosted solution:

Backtrace
Sentry
BugSplat
Bugsnag

Crash reports are stored temporarily before being uploaded in a directory underneath the app's user data directory, called 'Crashpad'. You can override this directory by calling app.setPath('crashDumps', '/path/to/crashes') before starting the crash reporter.

Electron uses crashpad to monitor and report crashes.

Methods

The crashReporter module has the following methods:

`crashReporter.start(options)`

options Object
- submitURL string (optional) - URL that crash reports will be sent to as POST. Required unless uploadToServer is false.
- productName string (optional) - Defaults to app.name.
- companyName string (optional) Deprecated - Deprecated alias for { globalExtra: { _companyName: ... } }.
- uploadToServer boolean (optional) - Whether crash reports should be sent to the server. If false, crash reports will be collected and stored in the crashes directory, but not uploaded. Default is true.
- ignoreSystemCrashHandler boolean (optional) - If true, crashes generated in the main process will not be forwarded to the system crash handler. Default is false.
- rateLimit boolean (optional) macOS Windows - If true, limit the number of crashes uploaded to 1/hour. Default is false.
- compress boolean (optional) - If true, crash reports will be compressed and uploaded with Content-Encoding: gzip. Default is true.
- extra Record<string, string> (optional) - Extra string key/value annotations that will be sent along with crash reports that are generated in the main process. Only string values are supported. Crashes generated in child processes will not include these extra parameters. To add extra parameters to crash reports generated from child processes, call addExtraParameter from the child process.
- globalExtra Record<string, string> (optional) - Extra string key/value annotations that will be sent along with any crash reports generated in any process. These annotations cannot be changed once the crash reporter has been started. If a key is present in both the global extra parameters and the process-specific extra parameters, then the global one will take precedence. By default, productName and the app version are included, as well as the Electron version.

This method must be called before using any other crashReporter APIs. Once initialized this way, the crashpad handler collects crashes from all subsequently created processes. The crash reporter cannot be disabled once started.

This method should be called as early as possible in app startup, preferably before app.on('ready'). If the crash reporter is not initialized at the time a renderer process is created, then that renderer process will not be monitored by the crash reporter.

Note

You can test out the crash reporter by generating a crash using process.crash().

Note

If you need to send additional/updated extra parameters after your first call start you can call addExtraParameter.

Note

Parameters passed in extra, globalExtra or set with addExtraParameter have limits on the length of the keys and values. Key names must be at most 39 bytes long, and values must be no longer than 127 bytes. Keys with names longer than the maximum will be silently ignored. Key values longer than the maximum length will be truncated.

Note