Configuration Reference
Top-level options
| Option | Type | Default | Description |
|---|---|---|---|
enabled | boolean | true | Master on/off switch |
maxLogs | number | 1000 | Maximum entries kept in memory. Oldest are evicted when the limit is reached |
devOnly | boolean | false | When true, the plugin is a no-op in production (import.meta.env.PROD) |
persistToStorage | boolean | false | Persist logs to localStorage and restore them on page reload |
router | Router | — | Vue Router instance. Required for route context enrichment (see Vue Router Integration) |
enrichWithRoute | boolean | false | Attach router.currentRoute.value.fullPath to every log entry as entry.route |
interceptors
| Option | Type | Default | Description |
|---|---|---|---|
interceptors.fetch | boolean | true | Intercept window.fetch |
interceptors.xhr | boolean | true | Intercept XMLHttpRequest |
interceptors.websocket | boolean | true | Intercept WebSocket |
interceptors.sse | boolean | true | Intercept EventSource (SSE) |
filters
Pre-filter events before they are stored. Entries that do not match are discarded.
| Option | Type | Description |
|---|---|---|
filters.urlPattern | RegExp | Only store entries whose URL matches |
filters.excludeUrlPattern | RegExp | Discard entries whose URL matches |
filters.methods | string[] | Only store entries with these HTTP methods (e.g. ['GET','POST']) |
filters.statusCodes | number[] | Only store entries with these exact status codes |
filters.bodySizeThreshold | number | Only store entries whose body is at least this many bytes |
sanitization
| Option | Type | Description |
|---|---|---|
sanitization.sensitiveHeaders | string[] | Header names to redact entirely ([REDACTED]). Merged with built-in defaults |
sanitization.sensitiveFields | string[] | Body field names to remove entirely. Merged with built-in defaults |
sanitization.maskFields | string[] | Body field names to partially mask (e.g. us***@example.com). Merged with built-in defaults |
metrics
| Option | Type | Default | Description |
|---|---|---|---|
metrics.calculateTTFB | boolean | true | Track Time To First Byte for HTTP requests |
metrics.trackRetries | boolean | true | Increment metadata.retryCount on repeated requests to the same URL |
callbacks
| Option | Type | Description |
|---|---|---|
callbacks.onLog | (entry: UnifiedLogEntry) => void | Called after every log entry is stored |
callbacks.onError | (error: Error) => void | Called when an internal plugin error occurs |
callbacks.onFlush | (logs: UnifiedLogEntry[]) => void | Called after clear() with the entries that were removed |
ui
Controls the built-in <NetworkDebugger> panel. These values act as defaults and can be overridden by component props.
| Option | Type | Default | Description |
|---|---|---|---|
ui.hotkey | string | 'd' | Key character for the toggle shortcut |
ui.hotkeyModifiers.ctrl | boolean | true | Require Ctrl key |
ui.hotkeyModifiers.alt | boolean | — | Require Alt key |
ui.hotkeyModifiers.shift | boolean | true | Require Shift key |
ui.hotkeyModifiers.meta | boolean | — | Require Meta (⌘ / Win) key |