Files
flipper/docs/setup/leak-canary-2-plugin.mdx
John Knox b6fc2f0651 Fix duplicate route to setup/leak-canary-plugin
Summary:
Noticed this when building the site. Shame it only warns and doesn't fail the build.
Just fixing it while I'm here.

{F479009268}

Reviewed By: nikoant

Differential Revision: D26911725

fbshipit-source-id: 6440a4b8aee4a6bc053ae771a3b148fd70ffc298
2021-03-09 05:43:29 -08:00

50 lines
1.2 KiB
Plaintext

---
id: leak-canary-2-plugin
title: LeakCanary 2 Setup
sidebar_label: LeakCanary 2
---
Ensure that you already have an explicit dependency in your application's
`build.gradle` including the plugin dependency, e.g.
```groovy
dependencies {
debugImplementation 'com.facebook.flipper:flipper-leakcanary2-plugin:0.76.0'
debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.6'
}
```
Update your the `onCreate` method in you `Application` to add the LeakCanary2 plugin to Flipper and the Flipper listener to LeakCanary
```kt
import com.facebook.flipper.plugins.leakcanary2.FlipperLeakListener
import com.facebook.flipper.plugins.leakcanary2.LeakCanary2FlipperPlugin
...
override fun onCreate() {
super.onCreate()
setupFlipper()
/*
set the flipper listener in leak canary config
*/
LeakCanary.config = LeakCanary.config.copy(
onHeapAnalyzedListener = FlipperLeakListener()
)
SoLoader.init(this, false)
if (BuildConfig.DEBUG && FlipperUtils.shouldEnableFlipper(this)) {
val client = AndroidFlipperClient.getInstance(this)
/*
add leak canary plugin to flipper
*/
client.addPlugin(LeakCanary2FlipperPlugin())
client.start()
}
}
```
That's it!