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

Merge pull request #347 from SeriousM/patch-2

Browse source 
Add information about the crash-reporter payload
This commit is contained in:
Cheng Zhao 2014-05-23 22:48:31 +08:00
commit 2565a4e71b
1 changed files with 27 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -15,8 +15,30 @@ crashReporter.start({
## crashReporter.start(options)
* `options` Object
* `productName` String
* `companyName` String
* `submitUrl` String - URL that crash reports would be sent to
* `autoSubmit` Boolean - Send the crash report without user interaction
* `ignoreSystemCrashHandler` Boolean
* `productName` String, default: Atom-Shell
* `companyName` String, default: GitHub, Inc
* `submitUrl` String, default: http://54.249.141.255:1127/post
* URL that crash reports would be sent to as POST
* `autoSubmit` Boolean, default: true
* Send the crash report without user interaction
* `ignoreSystemCrashHandler` Boolean, default: false
* `extra` Object
* An object you can define which content will be send along with the report.
* Only string properties are send correctly.
* Nested objects are not supported.
# crash-reporter payload
The crash reporter will send the following data to the `submitUrl` as `POST`:
* `rept` String - eg. atom-shell-crash-service
* `ver` String - The version of atom-shell
* `platform` String - eg. win32
* `process_type` String - eg. browser
* `ptime` Number
* `_version` String - The version in `package.json`
* `_productName` String - The product name in the crashReporter `options` object
* `prod` String - Name of the underlying product. In this case Atom-Shell
* `_companyName` String - The company name in the crashReporter `options` object
* `upload_file_minidump` File - The crashreport as file
* All level one properties of the `extra` object in the crashReporter `options` object