KtorMonitor - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #golang #android #machine-learning #linux #docker #nodejs #java #cli #security #ios #openai

KtorMonitor

(★ 228)

Powerful tool to monitor Ktor Client, OkHttp and http4k requests and responses, making it easier to debug and analyze network communication.

파일 탐색기

최종 버전 다운로드 (.zip)

- - build.yml
  - docs.yml
  - publish.yml
- FUNDING.yml
- icon.svg
- android-http4k.run.xml
- android-ktor.run.xml
- android-okhttp.run.xml
- ios.run.xml
- ☕jvm-http4k-compose.run.xml
- ☕jvm-http4k-swing.run.xml
- ☕jvm-ktor-compose.run.xml
- ☕jvm-ktor-swing.run.xml
- ☕jvm-okhttp-compose.run.xml
- ☕jvm-okhttp-swing.run.xml
- ✅api check.run.xml
- 🌍web wasm.run.xml
- 🌐web js.run.xml
- - build.gradle.kts
- - build.gradle.kts
- - contributing.md
  - getting_started.md
  - index.md
  - integration.md
- - main.html
- - 404.html
  - index.html
  - sitemap.xml
  - sitemap.xml.gz
- mkdocs.yml
- - ktormonitor.png
- - sample-ktor-monitor.jks
  - sample_ic_launcher-playstore.png
  - sample_ic_launcher.svg
- ktor_monitor_feature_graphic.png
- ktor_monitor_ic_launcher-playstore.png
- ktor_monitor_ic_launcher.svg
- ktor_monitor_kotlin_15_years.jpeg
- ktor_monitor_marketing.svg
- ktor_monitor_marketing_qr.svg
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- libs.versions.toml
- - build.gradle.kts
- - build.gradle.kts
- - yarn.lock
- yarn.lock
- - build.gradle.kts
- - build.gradle.kts
- - build.gradle.kts
- - build.gradle.kts
- - build.gradle.kts
- - build.gradle.kts
- - build.gradle.kts
- - build.gradle.kts
.gitignore
AGENTS.md
build.gradle.kts
CHANGELOG.md
CODE_OF_CONDUCT.md
context7.json
CONTRIBUTING.md
gradle.properties
gradlew
gradlew.bat
LICENSE
llms.txt
package-lock.json
package.json
README.md
SECURITY.md
settings.gradle.kts
SUPPORT.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Maven Central](https://img.shields.io/maven-central/v/ro.cosminmihu.ktor/ktor-monitor-logging?logo=apachemaven&label=Maven%20Central&link=https://search.maven.org/artifact/ro.cosminmihu.ktor/ktor-monitor-logging/)](https://search.maven.org/artifact/ro.cosminmihu.ktor/ktor-monitor-logging)
[![License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?label=Licence&logo=lintcode&logoColor=white&color=#3DA639)](https://github.com/CosminMihuMDC/KtorMonitor/blob/main/LICENSE)
[![Platforms](https://img.shields.io/badge/Platforms-Android%20+%20iOS%20+%20JVM%20+%20Wasm%20+%20Js-brightgreen?logo=kotlin&logoColor=white&color=8d69e0)](https://cosminmihumdc.github.io/KtorMonitor)
[![Slack](https://img.shields.io/badge/Slack-kotlinlang-4A164B?logo=sololearn&logoColor=white)](https://kotlinlang.slack.com/archives/C0AB9GA32H0)
[![JetBrains Klibs.io](https://img.shields.io/badge/JetBrains-klibs.io-4284F3?logo=jetbrains&logoColor=white)](https://klibs.io/project/CosminMihuMDC/KtorMonitor)
[![Documentation](https://img.shields.io/badge/Docs-gray?logo=readthedocs&logoColor=white)](https://cosminmihumdc.github.io/KtorMonitor)
[![API](https://img.shields.io/badge/API-gray?logo=codersrank&logoColor=white)](https://cosminmihumdc.github.io/KtorMonitor/api)
[![AI Skill](https://img.shields.io/badge/AI%20Skill-gray?logo=anthropic&logoColor=white)](https://raw.githubusercontent.com/CosminMihuMDC/KtorMonitor/main/ai/skill.md)
[![GitHub stars](https://img.shields.io/github/stars/CosminMihuMDC/KtorMonitor)](https://github.com/CosminMihuMDC/KtorMonitor)
[![GitHub forks](https://img.shields.io/github/forks/CosminMihuMDC/KtorMonitor)](https://github.com/CosminMihuMDC/KtorMonitor/fork)

# <img src="./extra/ktor_monitor_ic_launcher.svg" width="35"/> KtorMonitor
Powerful tool to monitor [Ktor Client](https://ktor.io/), [OkHttp](https://square.github.io/okhttp/) and [http4k](https://www.http4k.org/) requests and responses, making it easier to debug and analyze network communication.

<img src="extra/readme/ktormonitor.png" alt="ktormonitor"/>

## ✨ Features

*   🌐**Ktor Network Monitoring**: Real-time interception and logging of [Ktor Client](https://ktor.io/) traffic.
*   🌐**OkHttp Network Monitoring**: Real-time interception and logging of [OkHttp](https://square.github.io/okhttp/) traffic.
*   🌐**http4k Network Monitoring**: Real-time interception and logging of [http4k](https://www.http4k.org/) traffic.
*   📱**Kotlin Multiplatform (KMP)**: Full support for **Android**, **iOS**, **Desktop (JVM)**, **Wasm**, and **JS**.
*   🛠️**Highly Configurable**: Customize retention periods, content length limits, and notification behavior.
*   🔒**Security First**: Redact sensitive headers (e.g., *Authorization*).
*   📂**Data Export**: Save request/response details to local files for easier debugging or sharing.
*   🎨**Rich Previews**: Built-in viewers for *JSON*, *XML*, *HTML*, *CSS*, *YAML*, *MARKDOWN*, *Form Data*, *Image* (*JPG*, *PNG*, *SVG*, *GIF*, *WEBP*).
*   📡**SSE & WebSockets**: Track one-way streams (*SSE*) and bidirectional traffic (*WebSockets*).
*   🛡️**Production Safe**: No-Op version to ensure monitoring code is excluded from your production builds.

## 📦 Setup (Kotlin Multiplatform) for [Ktor Client](https://ktor.io/)

### <img src="https://upload.wikimedia.org/wikipedia/commons/6/6b/Gradle_logo.svg" width="100"/>

```kotlin
kotlin {
    sourceSets {
        commonMain.dependencies {
            implementation("ro.cosminmihu.ktor:ktor-monitor-logging:1.14.4")
        }
    }
}
```

**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
kotlin {
    sourceSets {
        commonMain.dependencies {
            implementation("ro.cosminmihu.ktor:ktor-monitor-logging-no-op:1.14.4")
        }
    }
}
```

## 📦 Setup (Android) for [Ktor Client](https://ktor.io/)

### <img src="https://upload.wikimedia.org/wikipedia/commons/6/6b/Gradle_logo.svg" width="100"/>

```kotlin
dependencies {
    debugImplementation("ro.cosminmihu.ktor:ktor-monitor-logging:1.14.4")
    releaseImplementation("ro.cosminmihu.ktor:ktor-monitor-logging-no-op:1.14.4")
}
```

For ***Android minSdk < 26***, [Core Library Desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring) is required.

### <img src="https://resources.jetbrains.com/storage/products/company/brand/logos/Ktor_icon.png" width="30"/> 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```.

## 📦 Setup (Android & JVM) for [OkHttp](https://square.github.io/okhttp/)

### <img src="https://upload.wikimedia.org/wikipedia/commons/6/6b/Gradle_logo.svg" width="100"/>

```kotlin
dependencies {
    debugImplementation("`ro.cosminmihu.ktor:ktor-monitor-okhttp-interceptor:1.14.4")
    releaseImplementation("ro.cosminmihu.ktor:ktor-monitor-okhttp-interceptor-no-op:1.14.4")
}
```

For ***Android minSdk < 26***, [Core Library Desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring) is required.

### <img src="https://pw-renderer-production-c.squarecdn.com/6d6a21f1ace5b8a7c93127a6f77087418f6ac596/_svelte/favicon.ico" width="30" style="background:#eee;"/> Install OkHttp Interceptor

```kotlin
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()
```

- ```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```.

## 📦 Setup (Android & JVM) for [http4k](https://www.http4k.org/)

### <img src="https://upload.wikimedia.org/wikipedia/commons/6/6b/Gradle_logo.svg" width="100"/>

```kotlin
dependencies {
    debugImplementation("ro.cosminmihu.ktor:ktor-monitor-http4k-filter:1.14.4")
    releaseImplementation("ro.cosminmihu.ktor:ktor-monitor-http4k-filter-no-op:1.14.4")
}
```

For ***Android minSdk < 26***, [Core Library Desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring) is required.

### <img src="https://images.opencollective.com/http4k/4b91f7a/logo/256.png" width="30" style="background:#eee;"/> Install http4k Filter

```kotlin
KtorMonitorFilter {
    sanitizeHeader { header -> header == "Authorization" }
    filter { request -> !request.uri.host.contains("cosminmihu.ro") }
    showNotification = true
    retentionPeriod = RetentionPeriod.OneHour
    maxContentLength = ContentLength.Default
}.then(JavaHttpClient())
```

- ```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 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

Add the UI component to your application based on your targeted platform.

<details>
<summary><b>Compose Multiplatform (Common)</b></summary>

* Use ```KtorMonitor``` Composable

```kotlin
@Composable
fun Composable() {
    KtorMonitor()
}
```
</details>

<details>
<summary><b>Android</b></summary>

- 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.
- For ***Android minSdk < 26***, [Core Library Desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring) is required.
</details>

<details>
<summary><b>iOS</b></summary>

* 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()
    }
}
```
</details>

<details>
<summary><b>Desktop (Compose)</b></summary>

* 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 }
    )

}
```
</details>

<details>
<summary><b>Desktop (Swing)</b></summary>

* Use ```KtorMonitorPanel``` Swing Panel

```kotlin
fun main() = application {

SwingUtilities.invokeLater {
        val frame = JFrame()
        frame.add(KtorMonitorPanel, BorderLayout.CENTER)
        frame.isVisible = true
    }

}
```
</details>

<details>
<summary><b>Wasm / Js</b></summary>

* Web targets require a few additional webpack steps.

```kotlin
kotlin {
    sourceSets {
        webMain.dependencies {
            implementation(devNpm("copy-webpack-plugin", "9.1.0"))
        }
    }
}
```

```javascript
// {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'
        ]
    })
);
```

```kotlin
ComposeViewport {
    App()
}
```
</details>

## ✍️ Feedback

Found a bug or have a feature request? [File an issue](https://github.com/CosminMihuMDC/KtorMonitor/issues/new).

## 🙌 Acknowledgments

[![Kotlin](https://img.shields.io/badge/2.4.10-white?logo=kotlin&logoColor=white&color=7F52FF)](http://kotlinlang.org)
[![Compose Multiplatform](https://img.shields.io/badge/1.11.1-white?logo=jetpackcompose&logoColor=white&color=4284F3)](https://www.jetbrains.com/lp/compose-multiplatform)
[![Android](https://img.shields.io/badge/Android%2017-white?logo=android&logoColor=white&color=34A853)](https://developer.android.com/about/versions/16)
[![Ktor](https://img.shields.io/badge/3.5.1-white?logo=ktor&logoColor=white&color=087CFA)](https://ktor.io)
[![OkHttp](https://img.shields.io/badge/5.4.0-white?logo=square&logoColor=white&color=003B57)](https://square.github.io/okhttp/)
[![http4k](https://img.shields.io/badge/6.55.0.0-white?logo=httpie&logoColor=white&color=087CFA)](https://www.http4k.org/)
[![SQLDelight](https://img.shields.io/badge/2.3.2-white?logo=sqlite&logoColor=white&color=003B57)](https://sqldelight.github.io/sqldelight)

Community discussions on Slack — join us in the [#ktormonitor](https://kotlinlang.slack.com/archives/C0AB9GA32H0) channel.
<br>
Documentation is available at [KtorMonitor Documentation](https://cosminmihumdc.github.io/KtorMonitor).
<br>
API is available at [KtorMonitor API](https://cosminmihumdc.github.io/KtorMonitor/api).
<br>
KtorMonitor is available also on JetBrains' [klibs.io](https://klibs.io/project/CosminMihuMDC/KtorMonitor).
<br>
KtorMonitor on [Context7](https://context7.com/cosminmihumdc/ktormonitor).
<br>
AI Skill (for Copilot, Claude, Cursor, ChatGPT and others) is available at [skill.md](https://github.com/CosminMihuMDC/KtorMonitor/blob/main/.agents/skills/ktormonitor/skill.md).
<br>
<br>
Some parts of this project are reusing ideas that are originally coming from [Chucker](https://github.com/ChuckerTeam/chucker).
<br>
Thanks to ChuckerTeam for Chucker!
<br>
Thanks to JetBrains for Ktor and Kotlin!
<br>
<br>
Medium article: [Ktor Monitor](https://medium.com/@cosmin.mihu/ktormonitor-debug-and-analyze-ktor-client-network-traffic-411c66061baf)

## 💸 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 [<span style="color:#bf3989">♥ Sponsor</span>](https://github.com/sponsors/CosminMihuMDC).
<br>
<a href="https://www.buymeacoffee.com/cosminmihu" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>

## 🙏🏻 Credits

KtorMonitor is brought to you by these [contributors](https://github.com/CosminMihuMDC/KtorMonitor/graphs/contributors).