xref: /aosp_15_r20/external/leakcanary2/docs/getting_started.md (revision d9e8da70d8c9df9a41d7848ae506fb3115cae6e6)
1*d9e8da70SAndroid Build Coastguard Worker# Getting started
2*d9e8da70SAndroid Build Coastguard Worker
3*d9e8da70SAndroid Build Coastguard WorkerTo use LeakCanary, add the `leakcanary-android` dependency to your app's `build.gradle` file:
4*d9e8da70SAndroid Build Coastguard Worker
5*d9e8da70SAndroid Build Coastguard Worker```groovy
6*d9e8da70SAndroid Build Coastguard Workerdependencies {
7*d9e8da70SAndroid Build Coastguard Worker  // debugImplementation because LeakCanary should only run in debug builds.
8*d9e8da70SAndroid Build Coastguard Worker  debugImplementation 'com.squareup.leakcanary:leakcanary-android:{{ leak_canary.release }}'
9*d9e8da70SAndroid Build Coastguard Worker}
10*d9e8da70SAndroid Build Coastguard Worker```
11*d9e8da70SAndroid Build Coastguard Worker
12*d9e8da70SAndroid Build Coastguard Worker**That's it, there is no code change needed!**
13*d9e8da70SAndroid Build Coastguard Worker
14*d9e8da70SAndroid Build Coastguard WorkerConfirm that LeakCanary is running on startup by filtering on the `LeakCanary` tag in [Logcat](https://developer.android.com/studio/command-line/logcat):
15*d9e8da70SAndroid Build Coastguard Worker
16*d9e8da70SAndroid Build Coastguard Worker```
17*d9e8da70SAndroid Build Coastguard WorkerD LeakCanary: LeakCanary is running and ready to detect leaks
18*d9e8da70SAndroid Build Coastguard Worker```
19*d9e8da70SAndroid Build Coastguard Worker
20*d9e8da70SAndroid Build Coastguard Worker!!! info
21*d9e8da70SAndroid Build Coastguard Worker    LeakCanary automatically detects leaks of the following objects:
22*d9e8da70SAndroid Build Coastguard Worker
23*d9e8da70SAndroid Build Coastguard Worker    * destroyed `Activity` instances
24*d9e8da70SAndroid Build Coastguard Worker    * destroyed `Fragment` instances
25*d9e8da70SAndroid Build Coastguard Worker    * destroyed fragment `View` instances
26*d9e8da70SAndroid Build Coastguard Worker    * cleared `ViewModel` instances
27*d9e8da70SAndroid Build Coastguard Worker    * destroyed `Service` instance
28*d9e8da70SAndroid Build Coastguard Worker
29*d9e8da70SAndroid Build Coastguard WorkerWhat's next? Learn the [Fundamentals](fundamentals.md)!
30