30K ·GitHub
What is this?
LeakCanary is a memory leak detection library for Android apps, built by Square.
LeakCanary is a memory leak detection library for Android apps, built by Square.Is this a library I add to my app, or a standalone tool?It is a library you integrate into your Android project as a debug dependency; it runs inside your app during development to watch for leaked objects, not a separate app or service.
It is a library you integrate into your Android project as a debug dependency; it runs inside your app during development to watch for leaked objects, not a separate app or service.How do I add it to my Android project?Add LeakCanary as a debugImplementation dependency in your app's build.gradle so it only ships in debug builds, then run the app normally; it automatically starts watching for leaks.
Add LeakCanary as a debugImplementation dependency in your app's build.gradle so it only ships in debug builds, then run the app normally; it automatically starts watching for leaks.Do I need a special environment to use it?You just need an Android project written in Java or Kotlin; LeakCanary itself is written in Kotlin and targets Android apps.
You just need an Android project written in Java or Kotlin; LeakCanary itself is written in Kotlin and targets Android apps.Will it slow down my release builds?No, it is meant to be added as a debug-only dependency so it is stripped out of release builds and does not affect production performance.
No, it is meant to be added as a debug-only dependency so it is stripped out of release builds and does not affect production performance.How does LeakCanary actually detect a leak?It watches objects that should be garbage collected (like destroyed Activities or Fragments) and, if they are not collected after a delay, dumps and analyzes the heap to find the retention path causing the leak.
It watches objects that should be garbage collected (like destroyed Activities or Fragments) and, if they are not collected after a delay, dumps and analyzes the heap to find the retention path causing the leak.What is the shark heap analyzer mentioned in the project's CI?Shark is the heap-analysis library LeakCanary uses internally to parse heap dumps and compute leak traces, and the repo has dedicated workflows for releasing it.
Shark is the heap-analysis library LeakCanary uses internally to parse heap dumps and compute leak traces, and the repo has dedicated workflows for releasing it.Why would I use LeakCanary instead of manually taking heap dumps in Android Studio?LeakCanary automates the whole process in-app, surfacing leak traces with a readable stack-trace-like report as soon as they happen, instead of requiring you to manually capture and inspect .hprof files.
LeakCanary automates the whole process in-app, surfacing leak traces with a readable stack-trace-like report as soon as they happen, instead of requiring you to manually capture and inspect .hprof files.What are similar projects?memray, logger, timber, butterknife, MPAndroidChart, Luban, fresco, DoKit
memray, logger, timber, butterknife, MPAndroidChart, Luban, fresco, DoKitWhich topics is it in?profiler, kotlin-android, android-library, debugging, mobile-development, kotlin, testing, java, performance, android, apache-2.0, library
profiler, kotlin-android, android-library, debugging, mobile-development, kotlin, testing, java, performance, android, apache-2.0, library