In-app debugging overlay for inspecting logs, HTTP traffic, and analytics with syntax-highlighted JSON, secure header redaction, body truncation, modular plugin panels, and zero release overhead.
AELog
Extensible on-device dev tools for Kotlin Multiplatform
An in-app debugging overlay for KMP — inspect logs, network traffic, and analytics events with a beautiful Compose UI. No external tools needed.
Features • Installation • Quick Start • Plugins • Custom Plugins • Documentation
AELog provides a suite of 4 core plugins, allowing you to select and install only what you need:
AELog is fully modularized. Add only the dependencies you need. Every plugin module carries its dependencies transitively, so you never need to import ae-log-core manually.
Add the following to your gradle/libs.versions.toml:
[versions]
aelog = "1.1.7"
[libraries]
aelog-logs = { module = "io.github.abdo-essam:ae-log-logs", version.ref = "aelog" }
aelog-network-ktor = { module = , version.ref = }
= { module = , version.ref = }
= { module = , version.ref = }
= { module = , version.ref = }
Add the required dependencies to your target source sets in build.gradle.kts:
// build.gradle.kts (shared module)
kotlin {
sourceSets {
commonMain.dependencies {
// Pick only what you need (each carries core transitively)
implementation(libs.aelog.logs)
implementation(libs.aelog.network.ktor)
implementation(libs.aelog.analytics)
implementation(libs.aelog.crashes)
}
androidMain.dependencies {
// Add only if your Android target uses OkHttp
implementation(libs.aelog.network.okhttp)
}
}
}
📖 See the Full Installation Guide for direct dependency coordinates and details on transitive inclusions.
AELog features zero-config auto-initialisation on Android and iOS! Just add the Gradle dependencies for the plugins you want, and AELog automatically boots up with sensible defaults when your app launches. No setup, configuration, or initialization code is required.
Add AELogOverlay() as a sibling anywhere in your root composable — no wrapping required. By default, the floating notch trigger is enabled (showNotch = true), allowing you to tap it to open the inspector:
@Composable
fun App() {
// Renders the overlay container in the background
AELogOverlay()
MaterialTheme {
Scaffold(
floatingActionButton = {
FloatingActionButton(onClick = { AELog.show() }) {
Icon(Icons.Default.BugReport, contentDescription = "Open Inspector")
}
}
) {
YourAppContent()
}
}
}
To disable the floating notch trigger globally or locally:
AELog.showNotch = false // Disable globally (across all screens)
// or
AELogOverlay(showNotch = false) // Disable locally in this composable
To disable the library entirely in release builds, set:
AELog.isEnabled = BuildConfig.DEBUG
AELog)AELog is a discoverable object modelled after Android's built-in Log class.
Just type AELog. and the IDE lists every method — no extension hunting required:
AELog.log.v("Auth", "Token checked")
AELog.log.d("Auth", "Token refreshed")
AELog.log.i("HomeScreen", "App launched!")
AELog.log.w("Auth", "Session expiring soon")
AELog.log.e("Database", "Failed to clear cache", exception) // stack trace auto-appended
AELog.log.wtf("Auth", "Unexpected state")
All calls are silent no-ops if the library hasn't initialized yet — safe to call from shared modules before app startup.
Omit the tag and AELog derives it from the caller's class name automatically. No repetition, no overhead:
AELog.log.d("Token refreshed") // tag → "AuthViewModel"
AELog.log.i("App launched!") // tag → "HomeScreen"
AELog.log.e("Failed to clear cache", t) // tag → "Database"
// Network, Analytics & Crashes APIs
AELog.network.logRequest(method = "GET", url = "https://api.example.com/users")
AELog.network.logResponse(url = "https://api.example.com/users", statusCode = 200)
AELog.analytics.logEvent("item_added_to_cart", properties = mapOf("id" to "123"))
// Capture non-fatal exceptions manually
try {
performDangerousWork()
} catch (t: Throwable) {
AELog.crashes.recordNonFatal(t)
}
AELog provides first-class interceptors for OkHttp and Ktor.
Both interceptors are secure by default. They automatically exclude sensitive headers like Authorization and Cookie to prevent credentials from appearing in logs.
// OkHttp
val interceptor = AELogOkHttpInterceptor(
excludeHeaders = setOf("X-Sensitive-Header") // Extends default exclusions
)
// Ktor
val client = HttpClient {
install(AELogKtorInterceptor) {
excludeHeaders = setOf("X-Api-Key")
}
}
To prevent memory issues when inspecting large payloads (e.g., file uploads), bodies are automatically truncated (default 250 KB).
AELogOkHttpInterceptor(
maxRequestBodyBytes = 500_000, // 500 KB limit
maxResponseBodyBytes = 1_000_000 // 1 MB limit
)
By default, Ktor response streams can only be read once. To enable non-destructive inspection of response bodies:
DoubleReceive plugin in your HttpClient.DoubleReceive is not installed, this may consume the stream—ensure your app logic is compatible or use the recommended plugin.val client = HttpClient {
install(DoubleReceive) // Recommended for Network Plugin
install(AELogKtorInterceptor)
}
Three ways to open the inspector:
AELog.show() / AELog.hide()Create your own debug panel (e.g., a Database Inspector or Feature Flags toggler) in 3 steps:
class FeatureFlagsPlugin : UIPlugin {
override val name = "Flags"
@Composable
override fun Content(modifier: Modifier) {
// Your Compose UI here (owns the entire panel layout)
LazyColumn(modifier = modifier) {
items(flags) { flag ->
FlagRow(flag)
}
}
}
}
// Install your custom plugin alongside the auto-registered ones
AELog.install(FeatureFlagsPlugin())
📖 See the Custom Plugins Guide for the full API reference.
AELog works with any logging library. Just forward logs to the static AELog.log methods:
// Forward logs using the static shorthands directly
AELog.log.i("MyTag", "Something happened")
AELog.log.e("Database", "Failed to clear cache", exception)
📖 See the Logging Integrations Guide for adapter examples (Kermit, Napier, Timber, SLF4J).
Contributions are welcome! Please read the Contributing Guide first.
git clone https://github.com/abdo-essam/AELog.git
cd AELog
./gradlew build
./gradlew allTests
Copyright 2026 Abdo Essam
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
| Plugin | Purpose | Key Capabilities |
|---|
| 🔍 Log Inspector | On-Device Log Viewer | Search queries, filter by severity level/tag, and copy or share logs easily. |
| 🌐 Network Viewer | HTTP Traffic Inspector | Inspect HTTP requests and responses, full headers, status codes, and JSON payloads with automatic sensitive credential redaction. |
| 📊 Analytics Tracker | Analytics Event Tracker | Verify custom properties, event dispatches, and screen views instantly as they trigger in your app. |
| 💥 Crash Reporter | Local Exception Manager | Intercept fatal exceptions and record non-fatal errors on-device so they survive app restarts and are viewable in the UI. |
Surfaced from shared tags and platforms — no rankings paid for.