跳到主要内容

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 Object
    • 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> - 崩溃报告器当前的“额外”参数。

在 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 对象的所有一级属性。