blockcanary
blockcanary copied to clipboard
A transparent ui-block detection library for Android.
BlockCanary ![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.moduth/blockcanary/badge.svg?style=flat)
A transparent ui-block detection library for Android. App only needs one-line-code to setup and provide application context.
Getting started
dependencies {
// or you can use compile directly if want to enable it in release package and upload log file to server
// compile 'com.github.moduth:blockcanary:1.0.1'
debugCompile 'com.github.moduth:blockcanary:1.0.1'
releaseCompile 'com.github.moduth:blockcanary-no-op:1.0.1'
}
Usage
public class DemoApplication extends Application {
@Override
public void onCreate() {
...
// Do it on main process
BlockCanary.install(this, new AppBlockCanaryContext()).start();
}
}
Implement BlockCanaryContext context:
public class AppBlockCanaryContext extends BlockCanaryContext {
// override to provide context like app qualifier, uid, network type, block threshold, log save path
// this is default block threshold, you can set it by phone's performance
@Override
public int getConfigBlockThreshold() {
return 500;
}
// if set true, notification will be shown, else only write log file
@Override
public boolean isNeedDisplay() {
return BuildConfig.DEBUG;
}
// path to save log file
@Override
public String getLogPath() {
return "/blockcanary/performance";
}
}
How does it work?
See BlockCanary.
-
BlockCanary.install()
initializes context and internal data structures. -
BlockCanary.start()
starts monitor byLooper.getMainLooper().setMessageLogging(mMainLooperPrinter);
-
ThreadStackSampler
andCpuSampler
start catching thread stack and cpu data. - Each time a message dispatch costs time over that set by
BlockCanaryContext.getConfigBlockThreshold
, it triggers a block notify. - Write log file with data for analysis.
- If
BlockCanaryContext.isNeedDisplay
is true, a notification is shown, developer can click and check directly.
Screenshot