ElectronBreadcrumbs

Supports capturing events from `uncaughtException` while retaining Electrons default behaviour. (default)

This integration captures breadcrumbs for many of Electron's built-in modules. The breadcrumbs captured for each module can be configured as true to capture all events, or false to capture no events. Alternatively, you can supply a function which is passed the event name and returns true or false, depending on whether the event should be captured.

The defaults for this integration are effectively:

Copied
import * as Sentry from "@sentry/electron/main";

Sentry.init({
  dsn: "https://examplePublicKey@o0.ingest.sentry.io/0
example-org / example-project
",
  integrations: [
    Sentry.electronBreadcrumbsIntegration({
      app: (name) => !name.startsWith("remote-"),
      autoUpdater: true,
      webContents: (name) =>
        ["dom-ready", "context-menu", "load-url", "destroyed"].includes(
          name,
        ),
      browserWindow: (name) =>
        [
          "closed",
          "close",
          "unresponsive",
          "responsive",
          "show",
          "blur",
          "focus",
          "hide",
          "maximize",
          "minimize",
          "restore",
          "enter-full-screen",
          "leave-full-screen",
        ].includes(name),
      screen: true,
      powerMonitor: true,
    }),
  ],
});
Previous
ChildProcess
Next
ElectronMinidump
Was this helpful?
Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").