How square/leakcanary works
LeakCanary is an Android memory-leak detection library. Its principal workflow watches objects after lifecycle events, waits for retained objects, captures a heap dump, analyzes it, and exposes the result for inspection. The repository also includes Shark heap-analysis tools and the separate Dive heap-dump application. The sampled sources show WorkManager dispatch, event delivery, and analysis-result handling; several connections to unsampled analyzer and UI internals are omitted or marked unverified.
Main entry points: HeapAnalyzerWorker.kt Analysis worker · EventListener.kt Event listener API · InternalLeakCanary.kt Runtime coordinator · HeapAnalyzer.kt Shark analyzer
Components 22
Object watching
- App watcher
object-watcher/object-watcher-android-core/src/main/java/leakcanary/AppWatcher.kt - Service watcher
object-watcher/object-watcher-android-core/src/main/java/leakcanary/ServiceWatcher.kt - Object reporter
object-watcher/object-watcher/src/main/java/leakcanary/DeletableObjectReporter.kt
LeakCanary runtime
- LeakCanary config
leakcanary/leakcanary-android-core/src/main/java/leakcanary/LeakCanary.kt - Runtime coordinator
leakcanary/leakcanary-android-core/src/main/java/leakcanary/internal/InternalLeakCanary.kt - Dump control
leakcanary/leakcanary-android-core/src/main/java/leakcanary/internal/HeapDumpControl.kt - Dump trigger
leakcanary/leakcanary-android-core/src/main/java/leakcanary/internal/HeapDumpTrigger.kt - Dump directory
leakcanary/leakcanary-android-core/src/main/java/leakcanary/internal/LeakDirectoryProvider.kt - Event listener API
leakcanary/leakcanary-android-core/src/main/java/leakcanary/EventListener.kt
Heap analysis
- WorkManager dispatch
leakcanary/leakcanary-android-core/src/main/java/leakcanary/WorkManagerHeapAnalyzer.kt - Remote dispatch
leakcanary/leakcanary-android-core/src/main/java/leakcanary/RemoteWorkManagerHeapAnalyzer.kt - Analysis worker
leakcanary/leakcanary-android-core/src/main/java/leakcanary/internal/HeapAnalyzerWorker.kt - Android analyzer
leakcanary/leakcanary-android-core/src/main/java/leakcanary/internal/AndroidDebugHeapAnalyzer.kt - Shark analyzer
shark/shark/src/main/java/shark/HeapAnalyzer.kt - Analysis result
shark/shark/src/main/java/shark/HeapAnalysis.kt
Result inspection
- Leak database
leakcanary/leakcanary-android-core/src/main/java/leakcanary/internal/activity/db/LeakTable.kt - Leak viewer
leakcanary/leakcanary-android-core/src/main/java/leakcanary/internal/activity/LeakActivity.kt - UI app service
leakcanary/leakcanary-app/src/main/java/org/leakcanary/service/LeakUiAppService.kt - Heap repository
leakcanary/leakcanary-app/src/main/java/org/leakcanary/data/HeapRepository.kt
Heap tools
- Shark CLI
shark/shark-cli/src/main/java/shark/Main.kt - Dive desktop app
shark/shark-dive/shark-dive-app/src/main/java/shark/dive/app/Main.kt
Other components
- Android app
Connections 18
- Android app → App watcher: installs watchers
- Service watcher → Object reporter: reports destruction
object-watcher/object-watcher-android-core/src/main/java/leakcanary/ServiceWatcher.kt - Runtime coordinator → Event listener API: dispatches events
leakcanary/leakcanary-android-core/src/main/java/leakcanary/internal/InternalLeakCanary.kt - Runtime coordinator → Dump control: updates eligibility
leakcanary/leakcanary-android-core/src/main/java/leakcanary/internal/InternalLeakCanary.kt - Dump control → Dump trigger: triggers capture
- Dump trigger → Dump directory: stores dumps
- Event listener API → WorkManager dispatch: receives dump events
leakcanary/leakcanary-android-core/src/main/java/leakcanary/WorkManagerHeapAnalyzer.kt - Event listener API → Remote dispatch: receives dump events
leakcanary/leakcanary-android-core/src/main/java/leakcanary/RemoteWorkManagerHeapAnalyzer.kt - WorkManager dispatch → Analysis worker: enqueues worker
leakcanary/leakcanary-android-core/src/main/java/leakcanary/WorkManagerHeapAnalyzer.kt - Remote dispatch → Analysis worker: serializes input
leakcanary/leakcanary-android-core/src/main/java/leakcanary/RemoteWorkManagerHeapAnalyzer.kt - Analysis worker → Android analyzer: runs analysis
leakcanary/leakcanary-android-core/src/main/java/leakcanary/internal/HeapAnalyzerWorker.kt - Android analyzer → Shark analyzer: delegates analysis
leakcanary/leakcanary-android-core/src/main/java/leakcanary/internal/AndroidDebugHeapAnalyzer.kt - Shark analyzer → Analysis result: produces result
- Analysis worker → Runtime coordinator: sends events
leakcanary/leakcanary-android-core/src/main/java/leakcanary/internal/HeapAnalyzerWorker.kt - UI app service → Heap repository: inserts analysis
leakcanary/leakcanary-app/src/main/java/org/leakcanary/service/LeakUiAppService.kt - Leak viewer → Leak database: reads leak data
- Shark CLI → Shark analyzer: offers analysis commands
- Dive desktop app → Analysis result: opens heap dumps