跳转至

netLog

记录会话中的网络事件。

进程:主进程

const { app, netLog } = require('electron')

app.whenReady().then(async () => {
  await netLog.startLogging('/path/to/net-log')
  // After some network events
  const path = await netLog.stopLogging()
  console.log('Net-logs written to', path)
})

要记录应用整个生命周期中的网络事件,请参阅 --log-net-log。

[!NOTE] 除非另有说明,所有方法只能在 app 模块发出 ready 事件后使用。

方法

netLog.startLogging(path[, options])

  • path string - 用于记录网络日志的文件路径。
  • options Object(可选)
  • captureMode string(可选)- 应捕获哪些类型的数据。默认情况下,仅捕获请求的元数据。将其设置为 includeSensitive 将包含 cookie 和身份验证数据。将其设置为 everything 将包含套接字上传输的所有字节。可以是 default、includeSensitive 或 everything。
  • maxFileSize number(可选)- 当日志增长超过此大小时,日志记录将自动停止。默认无限制。

返回 Promise<void> - 当网络日志开始记录时解决。

开始将网络事件记录到 path。

netLog.stopLogging()

返回 Promise<void> - 当网络日志已刷新到磁盘时解决。

停止记录网络事件。如果未调用,当应用退出时,网络日志记录将自动结束。

属性

netLog.currentlyLogging 只读

一个 boolean 属性,指示当前是否正在记录网络日志。

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 el/electron