mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Minor updates to crash reporter notes

Browse source
This commit is contained in:
Kevin Sawicki 2016-11-28 15:37:06 -08:00 committed by GitHub
parent f8b738e6c2
commit 446065b88c
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/api/crash-reporter.md
View file

@ -47,17 +47,17 @@ The `crashReporter` module has the following methods:
report. Only string properties are sent correctly, Nested objects are not report. Only string properties are sent correctly, Nested objects are not
supported. supported.
You are required to call this method before using other `crashReporter` APIs You are required to call this method before using any other `crashReporter` APIs
and in each process (main/renderer) from which you want to collect crash reports. and in each process (main/renderer) from which you want to collect crash reports.
You can pass different options to `crashReporter.start` while calling from different processes. You can pass different options to `crashReporter.start` when calling from different processes.
**Note:** On Windows and Linux, Electron uses `breakpad` for crash collection and reporting. **Note:** On Windows and Linux, Electron uses `breakpad` for crash collection and reporting.
Crashes can be collected from the main and renderer process, but not from the child processes Crashes can be collected from the main and renderer process, but not from the child processes
created via `child_process` module. created via the `child_process` module.
**Note:** On macOS, Electron uses a new `crashpad` client for crash collection and reporting. **Note:** On macOS, Electron uses a new `crashpad` client for crash collection and reporting.
Crashes can be collected from the main, renderer and any of the child processes created via the `child_process` module. Crashes can be collected from the main, renderer and any of the child processes created via the `child_process` module.
If you want to enable crash reporting, initializing `crashpad` from the main process using `crashReporter.start` is mandatory If you want to enable crash reporting, initializing `crashpad` from the main process using `crashReporter.start` is required
regardless of which process you want to collect crashes from. Once initialized this way, the crashpad handler collects regardless of which process you want to collect crashes from. Once initialized this way, the crashpad handler collects
crashes from all processes. You still have to call `crashReporter.start` from the renderer process, otherwise crashes from crashes from all processes. You still have to call `crashReporter.start` from the renderer process, otherwise crashes from
renderer processes will get reported without `companyName`, `productName` or any of the `extra` information. renderer processes will get reported without `companyName`, `productName` or any of the `extra` information.