commit	742746cb3de15b91d00f18a5d82cd5c50b8c1948	[log] [tgz]
author	Pierre-Yves Ricau <py@squareup.com>	Sat May 04 17:51:23 2019
committer	Pierre-Yves Ricau <py@squareup.com>	Sat May 04 17:51:23 2019
tree	4955811b54be504091484847e5d95268dd74586b
parent	c28128bea0232511496bf6a59149c2e46d09618d [diff]

tree: 4955811b54be504091484847e5d95268dd74586b

README.md

LeakCanary

A memory leak detection library for Android and Kotlin.

“A small leak will sink a great ship.” - Benjamin Franklin

Getting started

Add LeakCanary to your build.gradle:

dependencies {
  debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.0-alpha-1'
}

You're good to go! LeakCanary will automatically show a notification when an activity or fragment memory leak is detected in your debug build.

Note: LeakCanary 2 is in alpha.

Check out the migration guide.
Here is the change log.
To set up LeakCanary 1.6, go to the 1.6 Readme.

Presentations

LeakCanary, then what? Nuking Nasty Memory Leaks
Memory Leak Hunt, a live investigation.

Recipes

Watching custom objects

class MyService : Service {

  // ...

  override fun onDestroy() {
    super.onDestroy()
    LeakSentry.refWatcher.watch(this)
  }

}

Configuring LeakSentry & LeakCanary

LeakSentry is in charge of detecting memory leaks. Its configuration can be updated at any time by replacing LeakSentry.config:

class DebugExampleApplication : ExampleApplication() {

  override fun onCreate() {
    super.onCreate()
    LeakSentry.config = LeakSentry.config.copy(watchFragmentViews = false)
  }
}

LeakCanary is in charge of taking heap dumps and analyzing them. Its configuration can be updated at any time by replacing LeakCanary.config:

disableLeakCanaryButton.setOnClickListener {
  LeakCanary.config = LeakCanary.config.copy(dumpHeap = false)
}

Counting retained instances in production

In your build.gradle:

dependencies {
  implementation 'com.squareup.leakcanary:leaksentry:2.0-alpha-1'
}

In your leak reporting code:

val retainedInstanceCount = LeakSentry.refWatcher.retainedKeys.size

Alternate setup with the old perflib heap parser

If you want to try LeakCanary 2.0 features with the battle tested perflib heap parser, use a different dependency:

dependencies {
  // debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.0-alpha-1'
  debugImplementation 'com.squareup.leakcanary:leakcanary-android-perflib:2.0-alpha-1'
}

In your debug Application class:

class DebugExampleApplication : ExampleApplication() {

  override fun onCreate() {
    if (LeakCanary.isInAnalyzerProcess(this)) {
      // This process is dedicated to Perflib for heap analysis.
      // You should not init your app in this process.
      return
    }
    super.onCreate()
  }
}

FAQ

Note: the entries in this FAQ have not been updated for LeakCanary 2 yet.

License

Copyright 2015 Square, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.