Skip to content

WiretapHttpConfig

WiretapHttpConfig is the shared configuration class used by both Ktor and OkHttp plugins.

Properties

enabled

Type: Boolean — Default: true

Master switch. When false, the plugin passes requests through without any logging, rule evaluation, or overhead.

install(WiretapKtorHttpPlugin) {
    enabled = BuildConfig.DEBUG
}

consoleLogging

Type: Boolean — Default: true

Whether this plugin prints its captured traffic to the console — logcat on Android, the Xcode console on iOS, stdout on JVM Desktop.

install(WiretapKtorHttpPlugin) {
    consoleLogging = false
}

Set it to false if you already have your own HTTP logging, or if one client is too noisy. Each client decides for itself — a chatty polling client can stay quiet while your main client keeps printing.

Traffic Console output
HTTP [Wiretap] GET https://api.example.com/users -> 200 (42ms) [Network] h2
WebSocket [Wiretap] WS OPEN wss://…, plus one line per frame: [Wiretap] WS ▲ "ping" (4 B)
SSE [Wiretap] SSE OPEN https://api.example.com/stream, plus one line per event: [Wiretap] SSE ▼ [ping] "tick" (4 B)

The WebSocket and SSE configs carry the same flag — see Ktor WebSockets and OkHttp WebSockets.

Note

Only console output is affected. Every request, frame and event is still captured and browsable in the inspector — notifications and search included.

shouldLog

Type: (url: String, method: String) -> Boolean — Default: { _, _ -> true }

Filter which requests are captured in the log database. Evaluated before any DB write.

shouldLog = { url, method ->
    url.contains("/api/") && method != "OPTIONS"
}

Note

Requests that don't pass shouldLog are still subject to mock/throttle rules — they just won't appear in the inspector.

headerAction

Type: (key: String) -> HeaderAction — Default: { HeaderAction.Keep }

Controls how each header is treated in logged data. Called for every header key in both requests and responses. See Header Actions for details.

headerAction = { key ->
    when {
        key.equals("Authorization", ignoreCase = true) -> HeaderAction.Mask()
        key.equals("Cookie", ignoreCase = true) -> HeaderAction.Skip
        else -> HeaderAction.Keep
    }
}

logRetention

Type: LogRetention — Default: LogRetention.Forever

Controls how long log entries are retained. See Log Retention for details.

logRetention = LogRetention.Days(7)

maxContentLength

Type: Int — Default: 512000 (500 KB)

Maximum number of characters to store for request and response bodies. Bodies exceeding this limit are truncated before being saved to the database. Capped at 500 * 1024 (500 KB). Set to 0 to skip body logging entirely.

maxContentLength = 100 * 1024 // 100 KB

Usage by Plugin

install(WiretapKtorHttpPlugin) {
    enabled = true
    shouldLog = { url, _ -> url.contains("/api/") }
    headerAction = { key -> HeaderAction.Keep }
    logRetention = LogRetention.AppSession
    maxContentLength = 100 * 1024
}

WiretapOkHttpInterceptor {
    enabled = true
    shouldLog = { url, _ -> url.contains("/api/") }
    headerAction = { key -> HeaderAction.Keep }
    logRetention = LogRetention.AppSession
    maxContentLength = 100 * 1024
}