2.1 KiB
2.1 KiB
crash-reporter
An example of automatically submitting crash reporters to remote server:
crashReporter = require('crash-reporter');
crashReporter.start({
productName: 'YourName',
companyName: 'YourCompany',
submitUrl: 'https://your-domain.com/url-to-submit',
autoSubmit: true
});
crashReporter.start(options)
options
ObjectproductName
String, default: ElectroncompanyName
String, default: GitHub, IncsubmitUrl
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: falseextra
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.
Note: On OS X, electron uses a new crashpad
client, which is different
with the breakpad
on Windows and Linux. To enable crash collection feature,
you are required to call crashReporter.start
API to initiliaze crashpad
in Browser Process, even you only collect crash report in Renderer Process.
crashReporter.getLastCrashReport()
Returns the date and ID of last crash report, when there was no crash report
sent or the crash reporter is not started, null
will be returned.
crash-reporter payload
The crash reporter will send the following data to the submitUrl
as POST
:
rept
String - e.g. 'electron-crash-service'ver
String - The version of Electronplatform
String - e.g. 'win32'process_type
String - e.g. 'renderer'ptime
Number_version
String - The version inpackage.json
_productName
String - The product name in the crashReporteroptions
objectprod
String - Name of the underlying product. In this case Electron_companyName
String - The company name in the crashReporteroptions
objectupload_file_minidump
File - The crashreport as file- All level one properties of the
extra
object in the crashReporteroptions
object