github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-01-27 16:28:23 -05:00
Code Issues Packages Projects Releases Wiki Activity

feat: crashReporter: expose rateLimit and compress options (#23062)

Browse Source
This commit is contained in:
Jeremy Apthorp
2020-04-14 10:36:31 -07:00
committed by GitHub
parent fdf7e288bb
commit aeaccd00a2
10 changed files with 58 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/api/crash-reporter.md
View File

@@ -48,6 +48,11 @@ The `crashReporter` module has the following methods:
* `productName` String (optional) - Defaults to `app.name`.
* `uploadToServer` Boolean (optional) - Whether crash reports should be sent to the server. Default is `true`.
* `ignoreSystemCrashHandler` Boolean (optional) - Default is `false`.
* `rateLimit` Boolean (optional) _macOS_ _Windows_ - If true, limit the
number of crashes uploaded to 1/hour. Default is `false`.
* `compress` Boolean (optional) _macOS_ _Windows_ - If true, crash reports
will be compressed and uploaded with `Content-Encoding: gzip`. Not all
collection servers support compressed payloads. Default is `false`.
* `extra` Record<String, String> (optional) - An object you can define that will be sent along with the
report. Only string properties are sent correctly. Nested objects are not
supported. When using Windows, the property names and values must be fewer than 64 characters.