crashReporter

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

进程： Main, Renderer

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

  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. })

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

或者使用第三方托管的解决办法：

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

方法

crashReporter 模块具有以下方法:

crashReporter.start(options)

  • options Object
    • compannyame 字符串
    • submitURL 字符串 - 崩溃日志将以POST的方式发送给此URL.
    • productName String (optional) - Defaults to app.name.
    • uploadToServer Boolean (optional) - Whether crash reports should be sent to the server. 默认值为 true。
    • ignoreSystemCrashHandler 布尔型(可选) - 默认为false.
    • extra Record (optional) - An object you can define that will be sent along with the report. 只有字符串属性能够被正确发送. Nested objects are not supported. When using Windows, the property names and values must be fewer than 64 characters.
    • crashesDirectory String (optional) - Directory to store the crash reports temporarily (only used when the crash reporter is started via process.crashReporter.start).

在你调用任何其他的crashReporter API之前，您必须调用此方法. 在每个需要收集崩溃日志的进程 (主进程 / 渲染器进程) 中，也必须先调用此方法. 从不同的进程调用时, 可以传不同的配置给 crashReporter. start。

Note Child processes created via the child_process module will not have access to the Electron modules. 因此, 要收集它们的故障报告, 请用 process.crashReporter.start代替。 传递与上面相同的选项以及一个名为 crashesDirectory 的附加项, 它应指向一个目录, 以便临时存储崩溃报告。 你可以调用 process.crash() 使子进程崩溃，来测试结果。

Note: If you need send additional/updated extra parameters after your first call start you can call addExtraParameter on macOS or call start again with the new/updated extra parameters on Linux and Windows.

Note: On macOS and windows, Electron uses a new crashpad client for crash collection and reporting. 如果要启用崩溃报告，则需要在主进程使用crashReporter.start初始化crashpad， 不管你想收集哪个进程的报告。 使用这种方式初始化后，crashpad将处理从所有进程收集的崩溃报告。 你仍然需要从渲染器进程或子进程中调用crashReporter.start ，否则崩溃报告将不包含companyName, productName和任何extra信息。

crashReporter.getLastCrashReport()

返回 CrashReport:

返回上次崩溃报告的日期和ID。 只有已上传的崩溃报告将被返回；在磁盘上存在崩溃报告，除非上传，不然不会返回。 如果没有上传的报告，则返回null

crashReporter.getUploadedReports()

返回 CrashReport[]:

Returns all uploaded crash reports. Each report contains the date and uploaded ID.

crashReporter.getUploadToServer()

Returns Boolean - Whether reports should be submitted to the server. Set through the start method or setUploadToServer.

Note: This API can only be called from the main process.

crashReporter.setUploadToServer(uploadToServer)

  • uploadToServer Boolean macOS - Whether reports should be submitted to the server.

This would normally be controlled by user preferences. This has no effect if called before start is called.

Note: This API can only be called from the main process.

crashReporter.addExtraParameter(key, value) macOS Windows

  • key String - 参数键，长度必须小于64个字符
  • value String - 参数值, 长度必须小于64个字符

设置一个在发送崩溃报告时将额外包含的参数。 当调用 start 时, 除了通过 extra 选项设置的值之外, 此处指定值也将被发送。 This API is only available on macOS and windows, if you need to add/update extra parameters on Linux after your first call to start you can call start again with the updated extra options.

crashReporter.removeExtraParameter(key) macOS Windows

  • key String - 参数键，长度必须小于64个字符

从当前设定的参数中移除一个额外的参数, 以便它不会与崩溃报告一起发送。

crashReporter.getParameters()

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

crashReporter.getCrashesDirectory()

Returns String - The directory where crashes are temporarily stored before being uploaded.

崩溃报告内容

崩溃报告将发送下面 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 - Name of the underlying product. In this case Electron.
  • _companyName String - crashReporter options 对象中的公司名称
  • upload_file_minidump File - minidump 格式的崩溃报告
  • All level one properties of the extra object in the crashReporter options object.