Electron 中文文档 Electron crashReporter 模块

2024-02-26 开发教程 Electron 中文文档 匿名 3

crash-reporter模块开启发送应用崩溃报告.

下面是一个自动提交崩溃报告给服务器的例子 :

const crashReporter = require('electron').crashReporter;
crashReporter.start({
productName: 'YourName',
companyName: 'YourCompany',
submitURL: 'https://your-domain.com/url-to-submit',
autoSubmit: true
});

可以使用下面的项目来创建一个服务器,用来接收和处理崩溃报告 :

  • socorro
  • mini-breakpad-server

方法

crash-reporter模块有如下方法:

crashReporter.start(options)

  • optionsObject
    • companyNameString
    • submitURLString - 崩溃报告发送的路径,以post方式.
    • productNameString (可选) - 默认为 Electron.
    • autoSubmitBoolean - 是否自动提交. 默认为 true.
    • ignoreSystemCrashHandlerBoolean - 默认为 false.
    • extraObject - 一个你可以定义的对象,附带在崩溃报告上一起发送 . 只有字符串属性可以被正确发送,不支持嵌套对象.

只可以在使用其它 crashReporterAPIs 之前使用这个方法.

注意: 在 OS X, Electron 使用一个新的 crashpad客户端, 与 Windows 和 Linux 的 breakpad不同. 为了开启崩溃点搜集,你需要在主进程和其它每个你需要搜集崩溃报告的渲染进程中调用 crashReporter.startAPI 来初始化 crashpad.

crashReporter.getLastCrashReport()

返回最后一个崩溃报告的日期和 ID.如果没有过崩溃报告发送过来,或者还没有开始崩溃报告搜集,将返回 null.

crashReporter.getUploadedReports()

返回所有上载的崩溃报告,每个报告包含了上载日期和 ID.

crash-reporter Payload

崩溃报告将发送下面 multipart/form-dataPOST型的数据给 submitURL:

  • verString - Electron 版本.
  • platformString - 例如 'win32'.
  • process_typeString - 例如 'renderer'.
  • guidString - 例如 '5e1286fc-da97-479e-918b-6bfb0c3d1c72'
  • _versionString - package.json版本.
  • _productNameString - crashReporteroptions对象中的产品名字.
  • prodString - 基础产品名字. 这种情况为 Electron.
  • _companyNameString - crashReporteroptions对象中的公司名字.
  • upload_file_minidumpFile - 崩溃报告按照 minidump的格式.
  • crashReporter中的 extra对象的所有等级和一个属性. optionsobject