跳到主要内容

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 字符串 - 记录网络日志的文件路径。
  • options 对象 (可选)
    • captureMode 字符串 (可选) - 应捕获何种数据。 默认情况下，仅捕获有关请求的元数据。 将此设置为 includeSensitive 将包括 Cookie 和身份验证数据。 将其设置为 everything 将包括套接字上所有传输的字节。 可以是 default，includeSensitive 或 everything。
    • maxFileSize 数字 (可选) - 当日志增长超过此大小时，日志记录将自动停止。 默认为无限制。

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

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

netLog.stopLogging()​

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

停止记录网络事件。 如果未调用，则网络日志记录将在应用程序退出时自动结束。

属性​

netLog.currentlyLogging 只读​

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