跳转到主要内容

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 Object (可选)
    • captureMode 字符串(可选)- 要捕获的数据类型。默认情况下,只捕获请求的元数据。将其设置为 includeSensitive 会包含 cookie 和身份验证数据。将其设置为 everything 会包含在套接字上传输的所有字节。可以是 defaultincludeSensitiveeverything
    • maxFileSize 数字(可选)- 当日志大小超过此值时,日志记录将自动停止。默认为无限制。

返回 Promise<void> - net log 开始记录时解析。

开始将网络事件记录到 path

netLog.stopLogging()

返回 Promise<void> - net log 已刷新到磁盘时解析。

停止记录网络事件。如果未调用,net logging 将在应用程序退出时自动结束。

属性

netLog.currentlyLogging 只读

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