Updating template: plz latest + cleanup
1 file changed
tree: 8bbfbe44f66068749469f7368a14ada0376c0168
  1. .buildscript/
  2. .github/
  3. gradle/
  4. leakcanary-analyzer/
  5. leakcanary-android/
  6. leakcanary-android-instrumentation/
  7. leakcanary-android-no-op/
  8. leakcanary-sample/
  9. leakcanary-support-fragment/
  10. leakcanary-watcher/
  11. .gitignore
  12. .travis.yml
  13. build.gradle
  14. CHANGELOG.md
  15. checkstyle.xml
  16. gradle.properties
  17. gradlew
  18. LICENSE.txt
  19. README.md
  20. settings.gradle
README.md

LeakCanary

A memory leak detection library for Android and Java.

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

Getting started

In your build.gradle:

dependencies {
  debugImplementation 'com.squareup.leakcanary:leakcanary-android:1.6.1'
  releaseImplementation 'com.squareup.leakcanary:leakcanary-android-no-op:1.6.1'
  // Optional, if you use support library fragments:
  debugImplementation 'com.squareup.leakcanary:leakcanary-support-fragment:1.6.1'
}

In your Application class:

public class ExampleApplication extends Application {

  @Override public void onCreate() {
    super.onCreate();
    if (LeakCanary.isInAnalyzerProcess(this)) {
      // This process is dedicated to LeakCanary for heap analysis.
      // You should not init your app in this process.
      return;
    }
    LeakCanary.install(this);
    // Normal app init code...
  }
}

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

What's next? You could watch a live investigation then customize LeakCanary to your needs.

FAQ

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.