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

Merge pull request #8072 from ramya-rao-a/doc-update

Browse source 
Clarifying crash reporter behviour in Mac
This commit is contained in:
Kevin Sawicki 2016-11-28 15:37:21 -08:00 • committed by GitHub
commit 4aa2b093ff
1 changed files with 13 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -47,14 +47,20 @@ 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` You are required to call this method before using any other `crashReporter` APIs
APIs. and in each process (main/renderer) from which you want to collect crash reports.
You can pass different options to `crashReporter.start` when calling from different processes.
**Note:** On macOS, Electron uses a new `crashpad` client, which is different **Note:** On Windows and Linux, Electron uses `breakpad` for crash collection and reporting.
from `breakpad` on Windows and Linux. To enable the crash collection feature, Crashes can be collected from the main and renderer process, but not from the child processes
you are required to call the `crashReporter.start` API to initialize `crashpad` created via the `child_process` module.
in the main process and in each renderer process from which you wish to collect
crash reports. **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.
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
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.
### `crashReporter.getLastCrashReport()` ### `crashReporter.getLastCrashReport()`