Monitors network requests and responses, enhancing debugging and analysis of client-server interactions. Features include header sanitization, log retention, and content length management with platform-specific integrations.
KtorMonitorPowerful tool to monitor Ktor Client, OkHttp and http4k requests and responses, making it easier to debug and analyze network communication.
kotlin {
sourceSets {
commonMain.dependencies {
implementation("ro.cosminmihu.ktor:ktor-monitor-logging:1.14.1")
}
}
}
For Release Builds (No-Op)
To isolate KtorMonitor from release builds, use the ktor-monitor-logging-no-op variant. This ensures the monitor code is not included in production artifact.
kotlin {
sourceSets {
commonMain.dependencies {
implementation("ro.cosminmihu.ktor:ktor-monitor-logging-no-op:1.14.1")
}
}
}
dependencies {
debugImplementation("ro.cosminmihu.ktor:ktor-monitor-logging:1.14.1")
releaseImplementation("ro.cosminmihu.ktor:ktor-monitor-logging-no-op:1.14.1")
}
For Android minSdk < 26, Core Library Desugaring is required.
Install Ktor Client PluginHttpClient {
install(KtorMonitorLogging) {
sanitizeHeader { header -> header == "Authorization" }
filter { request -> !request.url.host.contains("cosminmihu.ro") }
showNotification = true
retentionPeriod = RetentionPeriod.OneHour
maxContentLength = ContentLength.Default
}
}
dependencies {
debugImplementation("`ro.cosminmihu.ktor:ktor-monitor-okhttp-interceptor:1.14.1")
releaseImplementation("ro.cosminmihu.ktor:ktor-monitor-okhttp-interceptor-no-op:1.14.1")
}
For Android minSdk < 26, Core Library Desugaring is required.
OkHttpClient.Builder()
.addNetworkInterceptor(
KtorMonitorInterceptor {
sanitizeHeader { header -> header == "Authorization" }
filter { request -> !request.url.host.contains("cosminmihu.ro") }
showNotification = true
retentionPeriod = RetentionPeriod.OneHour
maxContentLength = ContentLength.Default
}
)
.build()
dependencies {
debugImplementation("ro.cosminmihu.ktor:ktor-monitor-http4k-filter:1.14.1")
releaseImplementation("ro.cosminmihu.ktor:ktor-monitor-http4k-filter-no-op:1.14.1")
}
For Android minSdk < 26, Core Library Desugaring is required.
Install http4k FilterKtorMonitorFilter {
sanitizeHeader { header -> header == "Authorization" }
filter { request -> !request.uri.host.contains("cosminmihu.ro") }
showNotification = true
retentionPeriod = RetentionPeriod.OneHour
maxContentLength = ContentLength.Default
}.then(JavaHttpClient())
Add the UI component to your application based on your targeted platform.
KtorMonitor Composable@Composable
fun Composable() {
KtorMonitor()
}
KtorMonitorPanel Swing Panelfun main() = application {
SwingUtilities.invokeLater {
val frame = JFrame()
frame.add(KtorMonitorPanel, BorderLayout.CENTER)
frame.isVisible = true
}
}
Found a bug or have a feature request? File an issue.
Community discussions on Slack — join us in the channel. Documentation is available at . API is available at . KtorMonitor is available also on JetBrains' . KtorMonitor on . Some parts of this project are reusing ideas that are originally coming from . Thanks to ChuckerTeam for Chucker! Thanks to JetBrains for Ktor and Kotlin! Medium article:
KtorMonitor is maintained and improved during nights, weekends and whenever team has free time. If you use KtorMonitor in your project, please consider sponsoring us.
You can sponsor us by clicking ♥ Sponsor.
KtorMonitor is brought to you by these contributors.
sanitizeHeaderfilter - filter logs for calls matching a predicate.showNotification - Keep track of latest requests and responses into notification. Default is true. Android and iOS only. Notifications permission needs to be granted.retentionPeriod - The retention period for the logs. Default is 1h.maxContentLength - The maximum length of the content that will be logged. After this, body will be truncated. Default is 250_000. To log the entire body use ContentLength.Full.sanitizeHeaderfilter - filter logs for calls matching a predicate.showNotification - Keep track of latest requests and responses into notification. Default is true. Android and iOS only. Notifications permission needs to be granted.retentionPeriod - The retention period for the logs. Default is 1h.maxContentLength - The maximum length of the content that will be logged. After this, body will be truncated. Default is 250_000. To log the entire body use ContentLength.Full.sanitizeHeaderfilter - filter logs for calls matching a predicate.showNotification - Keep track of latest requests and responses into notification. Default is true. Android only. Notifications permission needs to be granted.retentionPeriod - The retention period for the logs. Default is 1h.maxContentLength - The maximum length of the content that will be logged. After this, body will be truncated. Default is 250_000. To log the entire body use ContentLength.Full.showNotifcation = trueKtorMonitorKtorMonitor() Composable directly into own Composable code.If showNotifcation = true and notification permission is granted, the library will display a notification showing a summary of ongoing KTOR activity.
Use KtorMonitorViewController
fun MainViewController() = KtorMonitorViewController()
struct KtorMonitorView: UIViewControllerRepresentable {
func makeUIViewController(context: Context) -> UIViewController {
MainViewControllerKt.MainViewController()
}
func updateUIViewController(_ uiViewController: UIViewController, context: Context) {}
}
struct ContentView: View {
var body: some View {
KtorMonitorView()
.ignoresSafeArea()
}
}
KtorMonitorWindow Composablefun main() = application {
var showKtorMonitor by rememberSaveable { mutableStateOf(false) }
KtorMonitorWindow(
onCloseRequest = { showKtorMonitor = false },
show = showKtorMonitor
)
}
KtorMonitorWindow Composable with KtorMonitorMenuItemfun main() = application {
var showKtorMonitor by rememberSaveable { mutableStateOf(false) }
Tray(
icon = painterResource(Res.drawable.ic_launcher),
menu = {
KtorMonitorMenuItem { showKtorMonitor = true }
}
)
KtorMonitorWindow(
show = showKtorMonitor,
onCloseRequest = { showKtorMonitor = false }
)
}
kotlin {
sourceSets {
webMain.dependencies {
implementation(devNpm("copy-webpack-plugin", "9.1.0"))
}
}
}
// {project}/webpack.config.d/sqljs.js
config.resolve = {
fallback: {
fs: false,
path: false,
crypto: false,
}
};
const CopyWebpackPlugin = require('copy-webpack-plugin');
config.plugins.push(
new CopyWebpackPlugin({
patterns: [
'../../node_modules/sql.js/dist/sql-wasm.wasm'
]
})
);
ComposeViewport {
App()
}
Surfaced from shared tags and platforms — no rankings paid for.