Android Performance Monitor


Source link: https://github.com/markzhai/AndroidPerformanceMonitor

Chinese README

Android Performance Monitor

A transparent ui-block detection library for Android, app only needs one-line-code to setup.

The naming is to pay respect to the great library LeakCanary, ui-related codes are modified from leakcanary's ui part.

  • 1.5.0 Add context that can stop monitor in debug mode.
  • 1.4.1 Bug fix.
  • 1.4.0 Bug fix, add onBlock interceptor in context.
  • 1.3.1 Enable configuration of label and icon.
  • 1.3.0 Add white-list and concern-package feature.

Getting started

You may choose how to assemble them as you like.

dependencies {

  // most often used way, enable notification to notify block event
  compile 'com.github.markzhai:blockcanary-android:1.5.0'

// this way you only enable BlockCanary in debug package
  // debugCompile 'com.github.markzhai:blockcanary-android:1.5.0'
  // releaseCompile 'com.github.markzhai:blockcanary-no-op:1.5.0' 
}

As this library uses getMainLooper().setMessageLogging(), please check if you set it in your app (related issue https://github.com/moduth/blockcanary/issues/27)

Usage

Maximum log count is set to 500, you can rewrite it in your app int.xml.

<integer name="block_canary_max_stored_count">1000</integer>

Monitor app's label and icon can be configured by placing a block_canary_icon drawable in your xhdpi drawable directory and in strings.xml:

<string name="block_canary_display_activity_label">Blocks</string>
public class DemoApplication extends Application {

  @Override
  public void onCreate() {

// ...

// Do it on main process

BlockCanary.install(this, new AppBlockCanaryContext()).start();

  
}
 
}

Implement your application BlockCanaryContext context (strongly recommend you to check all these configs)?

public class AppBlockCanaryContext extends BlockCanaryContext {

/** 
  * Implement in your project. 
  * 
  * @return Qualifier which can specify this installation, like version + flavor. 
  */
  public String provideQualifier() {

return "unknown";
  
}

/** 
  * Implement in your project. 
  * 
  * @return user id 
  */
  public String provideUid() {

return "uid";
  
}

/** 
  * Network type 
  * 
  * @return {
@link String
}
 like 2G, 3G, 4G, wifi, etc. 
  */
  public String provideNetworkType() {

return "unknown";
  
}

/** 
  * Config monitor duration, after this time BlockCanary will stop, use 
  * with {
@code BlockCanary
}
's isMonitorDurationEnd 
  * 
  * @return monitor last duration (in hour) 
  */
  public int provideMonitorDuration() {

return -1;
  
}

/** 
  * Config block threshold (in millis), dispatch over this duration is regarded as a BLOCK. You may set it 
  * from performance of device. 
  * 
  * @return threshold in mills 
  */
  public int provideBlockThreshold() {

return 1000;
  
}

/** 
  * Thread stack dump interval, use when block happens, BlockCanary will dump on main thread 
  * stack according to current sample cycle. 
  * <p> 
  * Because the implementation mechanism of Looper, real dump interval would be longer than 
  * the period specified here (especially when cpu is busier). 
  * </p> 
  * 
  * @return dump interval (in millis) 
  */
  public int provideDumpInterval() {

return provideBlockThreshold();

  
}

/** 
  * Path to save log, like "/blockcanary/", will save to sdcard if can. 
  * 
  * @return path of log files 
  */
  public String providePath() {

return "/blockcanary/";
  
}

/** 
  * If need notification to notice block. 
  * 
  * @return true if need, else if not need. 
  */
  public boolean displayNotification() {

return true;
  
}

/** 
  * Implement in your project, bundle files into a zip file. 
  * 
  * @param src  files before compress 
  * @param dest files compressed 
  * @return true if compression is successful 
  */
  public boolean zip(File[] src, File dest) {

return false;
  
}

/** 
  * Implement in your project, bundled log files. 
  * 
  * @param zippedFile zipped file 
  */
  public void upload(File zippedFile) {

throw new UnsupportedOperationException();

  
}

 /** 
  * Packages that developer concern, by default it uses process name, 
  * put high priority one in pre-order. 
  * 
  * @return null if simply concern only package with process name. 
  */
  public List<String> concernPackages() {

return null;
  
}

/** 
  * Filter stack without any in concern package, used with @{
code concernPackages
}
. 
  * 
  * @return true if filter, false it not. 
  */
  public boolean filterNonConcernStack() {

return false;
  
}

/** 
  * Provide white list, entry in white list will not be shown in ui list. 
  * 
  * @return return null if you don't need white-list filter. 
  */
  public List<String> provideWhiteList() {

LinkedList<String> whiteList = new LinkedList<>();

whiteList.add("org.chromium");

return whiteList;
  
}

/** 
  * Whether to delete files whose stack is in white list, used with white-list. 
  * 
  * @return true if delete, false it not. 
  */
  public boolean deleteFilesInWhiteList() {

return true;
  
}

/** 
  * Block interceptor, developer may provide their own actions. 
  */
  public void onBlock(Context context, BlockInfo blockInfo) {

}
 
}

How does it work?

Blog in Chinese: BlockCanary.

Principle flow picture:

Screenshot

Donation

If you find this repository helpful, you may make a donation to me via alipay or wechat.

Contributors

This library is initially created by markzhai, and maintained under the organization moduth with nimengbo and zzz40500.

Special thanks to android-cjj, Mr.Bao, chiahaolu to contribute.

Change Log

Check CHANGELOG

Contribute

If you would like to contribute code to BlockCanary you can do so through GitHub by forking the repository and sending a pull request.

License

Copyright (C) 2016 MarkZhai (http://zhaiyifan.cn).  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. 

Resources

This library allows to create dialogs in a material designed style.

Name UI states, navigate between them, remember where you've been.

Small library for creating menus with fast settings.

An easy Android logging with Kotlin and Timber.

Simple to use library for android, Enabling to add a tooltip near any view with ease.

RxLifecycle extension methods for Groovy language.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes