跳到主内容

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，了解如何在应用的整个生命周期内记录网络事件。

注意：除非另有说明，所有方法只能在 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 属性，指示当前是否正在记录网络日志。