Skip to content

Commit 9626c35

Browse files
authored
feat(electron): Update child process details (#12737)
* feat(electron): Update child process details * Use the same tick characters as elsewhere
1 parent ed9a345 commit 9626c35

File tree

1 file changed

+11
-8
lines changed
  • docs/platforms/javascript/guides/electron

1 file changed

+11
-8
lines changed

docs/platforms/javascript/guides/electron/index.mdx

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -231,17 +231,20 @@ Information_](/cli/dif/) for the upload process.
231231

232232
### Child Processes
233233

234-
The SDK relies on the [Electron CrashReporter](https://electronjs.org/docs/api/crash-reporter) to generate the crash dumps. To receive crash reports for child processes, you need to make sure the crash reporter is activated by either the SDK or manually (see [below](/platforms/javascript/guides/electron/#electron-native-manual)).
234+
The SDK relies on the [Electron crashReporter](https://electronjs.org/docs/api/crash-reporter) to capture crash dumps. To receive crash reports for child processes, you need to make sure the crash reporter is activated by either the SDK or manually (see [below](/platforms/javascript/guides/electron/#manual-crash-reporting)).
235235

236-
An exception to this is _macOS_, where the crash reporter only needs to be started in the `main` process and watches all its child processes. The SDK already takes care of this difference, so there is no need to manually disable `enableNative`.
236+
Once the crash reporter is active, the SDK will automatically capture native
237+
crashes for the following processes:
237238

238-
For custom child processes, especially ones not written in JavaScript, you need to integrate a library that can generate Minidumps. These are most notably [Crashpad](https://chromium.googlesource.com/crashpad/crashpad/) and [Breakpad](https://chromium.googlesource.com/breakpad/breakpad). Please refer to their respective documentation on how to build and integrate them. Configure them with the following upload URL:
239+
| | `event.process` tag|macOS | Windows | Linux |
240+
|--------------------|-------|---------|-------|---|
241+
| Electron `main` process |`browser` ||||
242+
| Electron `renderer` process |`renderer` ||||
243+
| Electron `utilityProcess`|`utility`|||✓ <sup>1</sup>|
244+
| `child_process.fork` | `node`||| |
245+
| `child_process.exec/spawn` | `unknown`|| | |
239246

240-
```text
241-
___MINIDUMP_URL___
242-
```
243-
244-
It currently not possible create breadcrumbs or other event meta data from native code. This has to happen in JavaScript. Support for this is planned in future releases.
247+
<sup>1</sup> Not working with Electron v29.4.6.
245248

246249
### Manual Crash Reporting
247250

0 commit comments

Comments
 (0)