Skip to content

Configuration Reference

Top-level options

OptionTypeDefaultDescription
enabledbooleantrueMaster on/off switch
maxLogsnumber1000Maximum entries kept in memory. Oldest are evicted when the limit is reached
devOnlybooleanfalseWhen true, the plugin is a no-op in production (import.meta.env.PROD)
persistToStoragebooleanfalsePersist logs to localStorage and restore them on page reload
routerRouterVue Router instance. Required for route context enrichment (see Vue Router Integration)
enrichWithRoutebooleanfalseAttach router.currentRoute.value.fullPath to every log entry as entry.route

interceptors

OptionTypeDefaultDescription
interceptors.fetchbooleantrueIntercept window.fetch
interceptors.xhrbooleantrueIntercept XMLHttpRequest
interceptors.websocketbooleantrueIntercept WebSocket
interceptors.ssebooleantrueIntercept EventSource (SSE)

filters

Pre-filter events before they are stored. Entries that do not match are discarded.

OptionTypeDescription
filters.urlPatternRegExpOnly store entries whose URL matches
filters.excludeUrlPatternRegExpDiscard entries whose URL matches
filters.methodsstring[]Only store entries with these HTTP methods (e.g. ['GET','POST'])
filters.statusCodesnumber[]Only store entries with these exact status codes
filters.bodySizeThresholdnumberOnly store entries whose body is at least this many bytes

sanitization

OptionTypeDescription
sanitization.sensitiveHeadersstring[]Header names to redact entirely ([REDACTED]). Merged with built-in defaults
sanitization.sensitiveFieldsstring[]Body field names to remove entirely. Merged with built-in defaults
sanitization.maskFieldsstring[]Body field names to partially mask (e.g. us***@example.com). Merged with built-in defaults

metrics

OptionTypeDefaultDescription
metrics.calculateTTFBbooleantrueTrack Time To First Byte for HTTP requests
metrics.trackRetriesbooleantrueIncrement metadata.retryCount on repeated requests to the same URL

callbacks

OptionTypeDescription
callbacks.onLog(entry: UnifiedLogEntry) => voidCalled after every log entry is stored
callbacks.onError(error: Error) => voidCalled when an internal plugin error occurs
callbacks.onFlush(logs: UnifiedLogEntry[]) => voidCalled 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.

OptionTypeDefaultDescription
ui.hotkeystring'd'Key character for the toggle shortcut
ui.hotkeyModifiers.ctrlbooleantrueRequire Ctrl key
ui.hotkeyModifiers.altbooleanRequire Alt key
ui.hotkeyModifiers.shiftbooleantrueRequire Shift key
ui.hotkeyModifiers.metabooleanRequire Meta (⌘ / Win) key