ab24a1e36d
* Introduce `net.{start|stop}Logging()`
- Slight regression right now as Electron won't automatically start logging net-logs at launch, will soon be fixed
- To implement callback for async controls
* Add `net.isLogging` & optional callback param for `net.stopLogging()`
* Fix small regression on --log-net-log
--log-net-log should work again
* Error on empty file path
* Only start with valid file path
* Remove unused var
* Allow setting log file path before URLRequestContextGetter starts logging
* Add net log tests
* Remove redundant checks
* Use brightray::NetLog
* Clean up code
* Should automatically stop listening
* 🎨 Attempt to fix styles
* Only run non-null callback
* Dump file to tmpdir
* Simplify net log spec
Spawned Electron process on Linux CI can fail to launch
* Separate netLog module
* Remove net logging test from net spec
* Add tests for netLog
* Fix header guard
* Clean up code
* Add netLog.currentlyLoggingPath
* Callback with filepath
* Add test for case when only .stopLogging() is called
* Add docs
* Reintroduce error on invalid arg
* Update copyright
* Update error message
* Juggle file path string types
42 lines
1 KiB
Markdown
42 lines
1 KiB
Markdown
# netLog
|
|
|
|
> Logging network events.
|
|
|
|
Process: [Main](../glossary.md#main-process)
|
|
|
|
```javascript
|
|
const {netLog} = require('electron')
|
|
console.log('Start recording net-logs')
|
|
netLog.startLogging('/path/to/net-log')
|
|
// After some network events
|
|
netLog.stopLogging(path => {
|
|
console.log('Net-logs written to', path)
|
|
})
|
|
```
|
|
|
|
See [`--log-net-log`](chrome-command-line-switches.md#--log-net-logpath) to log network events throughout the app's lifecycle.
|
|
|
|
## Methods
|
|
|
|
### `netLog.startLogging(path)`
|
|
|
|
* `path` String - File path to record network logs.
|
|
|
|
Starts recording network events to `path`.
|
|
|
|
### `netLog.stopLogging([callback])`
|
|
|
|
* `callback` Function (optional)
|
|
* `path` String - File path to which network logs were recorded.
|
|
|
|
Stops recording network events. If not called, net logging will automatically end when app quits.
|
|
|
|
## Properties
|
|
|
|
### `netLog.currentlyLogging`
|
|
|
|
A `Boolean` property that indicates whether network logs are recorded.
|
|
|
|
### `netLog.currentlyLoggingPath`
|
|
|
|
A `String` property that returns the path to the current log file.
|