https://github.com/cosminmihumdc/ktormonitor
Powerful tool to monitor Ktor Client requests and responses, making it easier to debug and analyze network communication.
https://github.com/cosminmihumdc/ktormonitor
android android-library client http ios jvm jvm-library kotlin kotlin-multiplatform ktor ktor-client ktor-plugin linux macos proxy windows
Last synced: about 2 months ago
JSON representation
Powerful tool to monitor Ktor Client requests and responses, making it easier to debug and analyze network communication.
- Host: GitHub
- URL: https://github.com/cosminmihumdc/ktormonitor
- Owner: CosminMihuMDC
- License: apache-2.0
- Created: 2025-01-26T16:29:25.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-05-03T10:39:44.000Z (about 2 months ago)
- Last Synced: 2025-05-03T11:31:13.156Z (about 2 months ago)
- Topics: android, android-library, client, http, ios, jvm, jvm-library, kotlin, kotlin-multiplatform, ktor, ktor-client, ktor-plugin, linux, macos, proxy, windows
- Language: Kotlin
- Homepage:
- Size: 84.9 MB
- Stars: 79
- Watchers: 1
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://search.maven.org/artifact/ro.cosminmihu.ktor/ktor-monitor-logging)
[](https://github.com/CosminMihuMDC/KtorMonitor/blob/main/LICENSE)
[](http://makeapullrequest.com)
[](https://github.com/CosminMihuMDC/KtorMonitor)
[](https://github.com/CosminMihuMDC/KtorMonitor/fork)
# 
KtorMonitor
Powerful tool to monitor [Ktor Client](https://ktor.io/) requests and responses, making it easier to debug and analyze network communication.
By default, **```KtorMonitor```**:
- **android** -> is enabled for ```debug``` builds and disabled for ```release``` builds
- **ios** -> is enabled for ```debug``` builds and disabled for ```release``` builds
- **desktop** -> is enabled for all builds
## Setup
### 
```kotlin
kotlin {
sourceSets {
commonMain.dependencies {
implementation("ro.cosminmihu.ktor:ktor-monitor-logging:1.6.1")
}
}
}
```
In order to isolate KtorMonitor from release builds, use `ktor-monitor-logging-no-op` variant:
```kotlin
kotlin {
sourceSets {
commonMain.dependencies {
implementation("ro.cosminmihu.ktor:ktor-monitor-logging-no-op:1.6.1")
}
}
}
```
### 
Install Ktor Client Plugin
```kotlin
HttpClient {
install(KtorMonitorLogging) {
sanitizeHeader { header -> header == "Authorization" }
filter { request -> !request.url.host.contains("cosminmihu.ro") }
showNotification = true
retentionPeriod = RetentionPeriod.OneHour
maxContentLength = ContentLength.Default
}
}
```
- ```sanitizeHeader``` - sanitize sensitive headers to avoid their values appearing in the logs
- ```filter``` - 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```.
## 🧩 Integration
Check out below how to integrate Ktor Monitor for different platforms.
Compose Multiplatform (all platforms)
* Use ```KtorMonitor``` Composable
```kotlin
@Composable
fun Composable() {
KtorMonitor()
}
```
Android
- If ```showNotifcation = true``` and **android.permission.POST_NOTIFICATIONS** is granted, the library will display a notification showing a summary of ongoing KTOR activity. Tapping on the notification launches the full ```KtorMonitor```.
- Apps can optionally use the ```KtorMonitor()``` Composable directly into own Composable code.
Desktop Compose
* Use ```KtorMonitorWindow``` Composable
```kotlin
fun main() = application {
var showKtorMonitor by rememberSaveable { mutableStateOf(false) }
KtorMonitorWindow(
onCloseRequest = { showKtorMonitor = false },
show = showKtorMonitor
)
}
```
* Use ```KtorMonitorWindow``` Composable with ```KtorMonitorMenuItem```
```kotlin
fun 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 }
)
}
```
Desktop Swing
* Use ```KtorMonitorPanel``` Swing Panel
```kotlin
fun main() = application {
SwingUtilities.invokeLater {
val frame = JFrame()
frame.add(KtorMonitorPanel, BorderLayout.CENTER)
frame.isVisible = true
}
}
```
iOS
* If ```showNotifcation = true``` and notification permission is granted, the library will display a notification showing a summary of ongoing KTOR activity.
* Use ```KtorMonitorViewController```
```kotlin
fun MainViewController() = KtorMonitorViewController()
```
```swift
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()
}
}
```
## ✍️ Feedback
Feel free to send feedback or [file an issue](https://github.com/CosminMihuMDC/KtorMonitor/issues/new).
## 🙌 Acknowledgments
[](http://kotlinlang.org)
[](https://www.jetbrains.com/lp/compose-multiplatform)
[](https://developer.android.com/about/versions/15)
[](https://ktor.io)
[](https://sqldelight.github.io/sqldelight)
Some parts of this project are reusing ideas that are originally coming from [Chucker](https://github.com/ChuckerTeam/chucker).
KtorMonitor is available also on JetBrains' [klibs.io](https://klibs.io/project/CosminMihuMDC/KtorMonitor).
Thanks to ChuckerTeam for Chucker!
Thanks to JetBrains for Ktor and Kotlin!
## 💸 Sponsors
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 Button.
## 🙏🏻 Credits
KtorMonitor is brought to you by these [contributors](https://github.com/CosminMihuMDC/KtorMonitor/graphs/contributors).