メインコンテンツへ飛ぶ

netLog

セッションのネットワークイベントをロギングします。

プロセス: メイン

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

app.whenReady().then(async () => {
  await netLog.startLogging('/path/to/net-log')
  // ネットワークイベントの後
  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 型のプロパティです。ネットワークログが現在記録されているかどうかを示します。