flipper/docs/leak-canary-plugin.md

id, title

id	title
leak-canary-plugin	LeakCanary

The LeakCanary plugin provides developers with Flipper support for LeakCanary, an open source memory leak detection library.

Setup

Note: this plugin is only available for Android.

Android

First, add the plugin to your Flipper client instance:

import com.facebook.sonar.plugins.leakcanary.LeakCanaryFlipperPlugin;

client.addPlugin(new LeakCanaryFlipperPlugin());

Next, build a custom RefWatcher using RecordLeakService: (see LeakCanary docs for more information on RefWatcher)

import com.facebook.sonar.plugins.leakcanary.RecordLeakService;

RefWatcher refWatcher = LeakCanary.refWatcher(this)
    .listenerServiceClass(RecordLeakService.class);
    .buildAndInstall();

Usage

Leaks detected by LeakCanary will appear automatically in Flipper. Each leak will display a hierarchy of objects, beginning from the garbage collector root and ending at the leaked class. Selecting any object in this list will display contents of the object's various fields.