跳到主要内容

crashReporter

将崩溃报告提交给远程服务器。

进程: 主进程, 渲染进程

以下是如何配置 Electron 自动将崩溃报告提交给远程服务器的示例

const { crashReporter } = require('electron')

crashReporter.start({ submitURL: 'https://your-domain.com/url-to-submit' })

要搭建一个服务器来接收和处理崩溃报告，可以使用以下项目

注意: Electron 使用 Crashpad 而不是 Breakpad 收集和上传崩溃报告，但目前 上传协议是一样的。

或者使用第三方托管解决方案

崩溃报告在上传前会临时存储在应用程序用户数据目录下的一个名为 'Crashpad' 的目录中。在启动崩溃报告器之前，可以通过调用 app.setPath('crashDumps', '/path/to/crashes') 来覆盖此目录。

Electron 使用 crashpad 来监控和报告崩溃。

方法​

`crashReporter` 模块具有以下方法

crashReporter.start(options)​

  • options 对象
    • submitURL string (可选) - 崩溃报告将通过 POST 发送到的 URL。除非 uploadToServer 为 false，否则必需。
    • productName string (可选) - 默认为 app.name。
    • companyName string (可选) 已弃用 - 已弃用的 { globalExtra: { _companyName: ... } } 别名。
    • uploadToServer boolean (可选) - 崩溃报告是否应发送到服务器。如果为 false，崩溃报告将被收集并存储在崩溃目录中，但不会上传。默认为 true。
    • ignoreSystemCrashHandler boolean (可选) - 如果为 true，在主进程中生成的崩溃将不会转发给系统崩溃处理程序。默认为 false。
    • rateLimit boolean (可选) macOS Windows - 如果为 true，则限制每小时上传的崩溃次数为 1 次。默认为 false。
    • compress boolean (可选) - 如果为 true，崩溃报告将被压缩并使用 Content-Encoding: gzip 上传。默认为 true。
    • extra Record<string, string> (可选) - 将随主进程生成的崩溃报告一起发送的额外字符串键/值注解。仅支持字符串值。子进程生成的崩溃报告将不包含这些额外参数，要为子进程生成的崩溃报告添加参数，请从子进程调用 addExtraParameter。
    • globalExtra Record<string, string> (可选) - 将随任何进程生成的任何崩溃报告一起发送的额外字符串键/值注解。这些注解一旦崩溃报告器启动后便无法更改。如果全局额外参数和特定进程额外参数中都存在某个键，则全局参数优先。默认情况下，包含 productName、应用版本以及 Electron 版本。

在使用任何其他 crashReporter API 之前必须调用此方法。一旦以此方式初始化，crashpad 处理程序将从所有后续创建的进程中收集崩溃报告。崩溃报告器启动后无法禁用。

应在应用启动时尽早调用此方法，最好在 app.on('ready') 之前。如果在创建渲染进程时未初始化崩溃报告器，则该渲染进程将不会被崩溃报告器监控。

注意: 你可以通过使用 process.crash() 生成崩溃来测试崩溃报告器。

注意: 如果在首次调用 start 后需要发送额外的/更新的 extra 参数，可以调用 addExtraParameter。

注意: 传递给 extra、globalExtra 或通过 addExtraParameter 设置的参数对键和值的长度有限制。键名必须最多 39 字节长，值必须最多 127 字节长。键名超过最大长度的将被静默忽略。键值超过最大长度的将被截断。

注意: 此方法仅在主进程中可用。

crashReporter.getLastCrashReport()​

返回 CrashReport | null - 最新崩溃报告的日期和 ID。仅返回已上传的崩溃报告；即使磁盘上存在崩溃报告，也只有在上传后才会返回。如果没有已上传的报告，则返回 null。

注意: 此方法仅在主进程中可用。

crashReporter.getUploadedReports()​

返回 CrashReport[]

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

注意: 此方法仅在主进程中可用。

crashReporter.getUploadToServer()​

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

注意: 此方法仅在主进程中可用。

crashReporter.setUploadToServer(uploadToServer)​

  • uploadToServer boolean - 报告是否应提交到服务器。

这通常由用户偏好设置控制。如果在调用 start 之前调用此方法则无效。

注意: 此方法仅在主进程中可用。

crashReporter.addExtraParameter(key, value)​

  • key string - 参数键，长度不能超过 39 字节。
  • value string - 参数值，长度不能超过 127 字节。

设置一个额外参数，随崩溃报告一起发送。此处指定的值将随调用 start 时通过 extra 选项设置的任何值一起发送。

以此方式添加的参数（或通过 crashReporter.start 的 extra 参数添加的参数）仅限于调用进程。在主进程中添加额外参数不会导致这些参数随渲染进程或其他子进程的崩溃报告一起发送。同样，在渲染进程中添加额外参数也不会导致这些参数随其他渲染进程或主进程中发生的崩溃一起发送。

注意: 参数对键和值的长度有限制。键名不能超过 39 字节，值不能超过 20320 字节。键名超过最大长度的将被静默忽略。键值超过最大长度的将被截断。

crashReporter.removeExtraParameter(key)​

  • key string - 参数键，长度不能超过 39 字节。

从当前参数集中移除一个额外参数。未来的崩溃将不再包含此参数。

crashReporter.getParameters()​

返回 Record<string, string> - 崩溃报告器当前的 'extra' 参数。

在 Node 子进程中​

由于 require('electron') 在 Node 子进程中不可用，以下 API 在 Node 子进程的 process 对象上可用。

process.crashReporter.start(options)​

参见 crashReporter.start()。

请注意，如果在主进程中启动了崩溃报告器，它将自动监控子进程，因此不应在子进程中启动。仅当主进程未初始化崩溃报告器时才使用此方法。

process.crashReporter.getParameters()​

参见 crashReporter.getParameters()。

process.crashReporter.addExtraParameter(key, value)​

参见 crashReporter.addExtraParameter(key, value)。

process.crashReporter.removeExtraParameter(key)​

参见 crashReporter.removeExtraParameter(key)。

崩溃报告载荷​

崩溃报告器将以下数据通过 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 格式的崩溃报告。
  • crashReporter options 对象中 extra 对象的所有一级属性。