崩溃日志报告

将崩溃日志提交给远程服务器

参见： process, renderer process

以下是一个自动提交崩溃日志到服务器的示例

  1. const { crashReporter } = require('electron')
  3. crashReporter.start({
  4.   productName: 'YourName',
  5.   companyName: 'YourCompany',
  6.   submitURL: 'https://your-domain.com/url-to-submit',
  7.   uploadToServer: true
  8. })

构建一个用于接受和处理崩溃日志的服务，你需要以下工程

  • socorro

  • mini-breakpad-server
    Or use a 3rd party hosted solution:

  • Backtrace I/O

  • Sentry
    崩溃日志被保存在本地的应用特有的临时文件夹中。 对于YourName对象中的productName，崩溃报日志将被储存在临时文件夹中名为YourName Crashes的文件文件夹中。 在启动崩溃报告器之前，您可以通过调用app.setPath('temp', 'my/custom/temp') API来自定义这些临时文件的保存路径

方法

crashReporter 模块具有以下方法:

crashReporter.start(options)

  • options Object

    • companyName String
    • submitURL 字符串 - 崩溃日志将以POST的方式发送给此URL.
    • productName 字符串(可选) - 默认为 app.getName().
    • uploadToServer 布尔型(可选) - 控制是否将崩溃日志发送给服务器，默认为true.
    • ignoreSystemCrashHandler 布尔型(可选) - 默认为false.
    • extra 对象(可选) - 一个随崩溃日志发送的对象. 只有字符串属性能够被正确发送. 不支持发送嵌套对象，且属性名称和属性值必须小于64个字符长度.
    • crashesDirectoryString (可选)-用于临时存储 crashreports 的目录 (仅在崩溃报告器通过 process.crashReporter.start 启动时使用).
      你需要调用任何其他的crashReporter API，您必须调用此方法. 在每个需要收集崩溃日志的进程 (主进程 / 渲染器进程) 中，也必须先调用此方法. 从不同的进程调用时, 可以传不同的配置给 crashReporter. start。

注意 由 child_process 模块创建的子进程将无法访问 Electron 模块。 因此, 要收集它们的故障报告, 请用 process.crashReporter.start代替。 传递与上面相同的选项以及一个名为 crashesDirectory 的附加项, 它应指向一个目录, 以便临时存储崩溃报告。 你可以调用 process.crash() 使子进程崩溃，来测试结果。

注意: 要从 Windows 中的子进程收集崩溃报告, 您也需要添加这样额外的代码。 这将启动一个进程来监视和发送崩溃报告。 用适当的值去替换 submitURL、productName 和 crashesDirectory。

注意: ，如果您在第一次调用 start 后需要发送 附加的/更新的 extra 参数, 在 macOS 上，你可以调用 addExtraParameter。而在 Linux 和 Windows 上，则使用 新的/更新的 extra 参数，再次调用 start即可。

  1. const args = [
  2.   `--reporter-url=${submitURL}`,
  3.   `--application-name=${productName}`,
  4.   `--crashes-directory=${crashesDirectory}`
  5. ]
  6. const env = {
  7.   ELECTRON_INTERNAL_CRASH_SERVICE: 1
  8. }
  9. spawn(process.execPath, args, {
  10.   env: env,
  11.   detached: true
  12. })

注意：在macOS上，Electron使用一个crashpad客户端来收集并报告崩溃信息。 如果要启用崩溃报告，则需要在主进程使用crashReporter.start初始化crashpad， 不管你想收集哪个进程的报告。 使用这种方式初始化后，crashpad将处理从所有进程收集的崩溃报告。 你仍然需要从渲染器进程或子进程中调用crashReporter.start ，否则崩溃报告将不包含companyName, productName和任何extra信息。

crashReporter.getLastCrashReport()

返回 CrashReport:

返回上次崩溃报告的日期和ID。如果没有崩溃报告 发送或crash reporter尚未开始，则返回null。

crashReporter.getUploadedReports()

返回 CrashReport[]:

返回所有上传的崩溃报告。每个报告都包含日期和上传ID。

crashReporter.getUploadToServer() Linux macOS

返回 Boolean - 是否已将报告提交到服务器。通过start 方法或 setUploadToServer设置。

注意： 这个API仅可从主进程调用。

crashReporter.setUploadToServer(uploadToServer) Linux macOS

  • uploadToServer Boolean macOS - 是否将报告提交到服务器.
    通常, 是否提交是由用户对系统进行偏好设置而决定的。不能在 start 之前调用该方法，否则无效.

注意： 这个API仅可从主进程调用。

crashReporter.addExtraParameter(key, value) macOS

  • key String - 参数键，长度必须小于64个字符
  • value String - 参数值, 长度必须小于64个字符
    设置一个在发送崩溃报告时将额外包含的参数。 当调用 start 时, 除了通过 extra 选项设置的值之外, 此处指定值也将被发送。 此 API 仅在 macOS 上可用, start 首次调用后, 如果您希望在在 Linux 和 Windows 上添加或更新额外参数, 您可以更新 extra 选项并再次调用 start 。

crashReporter.removeExtraParameter(key) macOS

  • key String - 参数键，长度必须小于64个字符
    从当前设定的参数中移除一个额外的参数, 以便它不会与崩溃报告一起发送。

crashReporter.getParameters()

查看传递给崩溃报告的所有当前参数。

崩溃报告内容

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

  • ver String - Electron 的版本.
  • platform String - 例如 'win32'.
  • process_type String - 例如 'renderer'.
  • guid String - 例如 '5e1286fc-da97-479e-918b-6bfb0c3d1c72'.
  • _version String - package.json 里的版本号.
  • _productName String - crashReporter options 对象中的产品名字
  • prod String - 基础产品名字. 在这种情况下为 Electron.
  • _companyName String - crashReporter options 对象中的公司名称
  • upload_file_minidump File - minidump 格式的崩溃报告
  • All level one properties of the extra object in the crashReporter options object.