\n\n# Official Sentry SDK for Electron\n\n[](https://github.com/getsentry/sentry-electron/actions/workflows/build.yml)\n[](https://docs.sentry.io/platforms/javascript/electron/)\n[](https://www.npmjs.com/package/@sentry/electron)\n[](https://github.com/getsentry/sentry-electron/blob/master/LICENSE)\n[](https://discord.gg/SugnmRwkmV)\n\n## Features\n\n- Captures **Node errors** in the main process (using\n [`@sentry/node`](https://github.com/getsentry/sentry-javascript/tree/master/packages/node))\n- Captures **JavaScript errors** in renderer processes (using\n [`@sentry/browser`](https://github.com/getsentry/sentry-javascript/tree/master/packages/browser))\n- Captures **native crashes** (Minidump crash reports) from renderers and the main process\n- Collects **breadcrumbs and context** information along with events across renderers and the main process\n- Supports `electron >= v35`\n\n## Usage\n\nTo use this SDK, call `init(options)` as early as possible in the entry modules in the main process as well as all\nrenderer processes or further sub processes you spawn. This will initialize the SDK and hook the environment.\n\nIn the Electron main process:\n\n```javascript\nimport { init } from '@sentry/electron/main';\n\ninit({\n dsn: '__DSN__',\n // ...\n});\n```\n\nIn all Electron renderer processes:\n\n```javascript\n// In the Electron renderer processes\nimport { init } from '@sentry/electron/renderer';\n\ninit();\n```\n\nIf you are using a framework specific Sentry SDK, you can pass that `init` function as the second parameter in the\nrenderer and the two SDKs functionalities will be combined:\n\n```javascript\nimport { init } from '@sentry/electron/renderer';\nimport { init as reactInit } from '@sentry/react';\n\ninit(\n {\n /* config */\n },\n reactInit,\n);\n```\n\nTo set context information or send manual events, use the exported functions of `@sentry/electron`. Note that these\nfunctions will not perform any action before you have called `init()`:\n\n```javascript\nimport * as Sentry from '@sentry/electron/main';\n\n// Set user information, as well as tags and further extras\nconst scope = Sentry.getCurrentScope();\nscope.setExtra('battery', 0.7);\nscope.setTag('user_mode', 'admin');\nscope.setUser({ id: '4711' });\n\n// Add a breadcrumb for future events\nSentry.addBreadcrumb({\n message: 'My Breadcrumb',\n // ...\n});\n\n// Capture exceptions, messages or manual events\nSentry.captureMessage('Hello, world!');\nSentry.captureException(new Error('Good bye'));\nSentry.captureEvent({\n message: 'Manual',\n stacktrace: [\n // ...\n ],\n});\n```\n\n## Contributors\n\nThanks to everyone who contributed to the Sentry Electron SDK!\n\n\n \n\n","readmeFilename":"README.md","users":{"timfish":true,"flumpus-dev":true}}
![\"Sentry\"](\"https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png\")
\n \n