commit | 7db368d8798e649a08f8ffed2a9295868f60da1f | [log] [tgz] |
---|---|---|
author | PY <pyricau@users.noreply.github.com> | Thu Apr 25 11:17:19 2019 |
committer | GitHub <noreply@github.com> | Thu Apr 25 11:17:19 2019 |
tree | e9e8d2e0699c5ae1f7f5b96cc2018acd2b8cc71b | |
parent | 1cb0d21cb1bdc851e98dcf69c5e109b6bae71329 [diff] |
Extract multi process out (#1307) * Remove perflib android artifact, keep analyzer * merge new heap dump back into main module * Recreate leakcanary-android which provides the single process manifest * New module for running leakcanary in a separate process
A memory leak detection library for Android and Kotlin.
“A small leak will sink a great ship.” - Benjamin Franklin
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. To set up LeakCanary 1.6, go to the 1.6 Readme.
class MyService : Service { // ... override fun onDestroy() { super.onDestroy() LeakSentry.refWatcher.watch(this) } }
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) }
In your build.gradle
:
dependencies { implementation 'com.squareup.leakcanary:leakcanary-sentry:2.0-alpha-1' }
In your leak reporting code:
val retainedInstanceCount = LeakSentry.refWatcher.retainedKeys.size
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() } }
Note: the entries in this FAQ have not been updated for LeakCanary 2 yet.
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.