English README.md    中文 README_zh.md

Android developer lack of monitoring of performance data,especially in production environment. so we need "AndroidGodEye".

AndroidGodEye is a performance monitor tool for Android(not limited to performance data) , you can easily monitor the performance of your app in real time in pc browser.

It is divided into 3 parts:

1. Core provide all performance modules and produce performance datas.
2. Debug Monitor provide a dashboard to show these performance datas.
3. Toolbox make developers easy to use this library.

AndroidGodEye prodive several modules, such as cpu, heap, block, leak memory and so on.

Demo APK

Demo Project:https://github.com/Kyson/AndroidGodEyeDemo

dependencies {
  implementation 'cn.hikyson.godeye:godeye-core:VERSION_NAME'
  debugImplementation 'cn.hikyson.godeye:godeye-monitor:VERSION_NAME'
  releaseImplementation 'cn.hikyson.godeye:godeye-monitor-no-op:VERSION_NAME'
  implementation 'cn.hikyson.godeye:godeye-toolbox:VERSION_NAME'
}

Find VERSION_NAME in Github release

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath "cn.hikyson.methodcanary:plugin:PLUGIN_VERSION_NAME"
    }
}

Find PLUGIN_VERSION_NAME in MethodCanary github release

You need to config the logic of method canary injection, create js file:MethodCanary.js in project root dir, content like following:

/**
    classInfo
        {int access
         String name
         String superName
         String[] interfaces}

     methodInfo
         {int access
         String name
         String desc}
**/
function isExclude(classInfo,methodInfo){
    return false
}

function isInclude(classInfo,methodInfo){
    return classInfo.name.startsWith('cn/hikyson/godeyedemo'))
}

More configurations reference: MethodCanary

apply plugin: 'cn.hikyson.methodcanary.plugin'

Init first in your application:

GodEye.instance().init(this);

Install modules in application onCreate, GodEye class is entrance for this step, all modules are provided by it.

if (ProcessUtils.isMainProcess(this)) {//install in main process
    GodEye.instance().install(GodEyeConfig.fromAssets("android-godeye-config/install.config"));
}

assets目录下放模块的配置文件android-godeye-config/install.config，内容如下：

<config>
    <battery />
    <cpu intervalMillis="2000" sampleMillis="1000"/>
    <crash crashProvider="cn.hikyson.godeye.core.internal.modules.crash.CrashFileProvider"/>
    <fps intervalMillis="2000"/>
    <heap intervalMillis="2000"/>
    <leakMemory debug="true" debugNotification="true" leakRefInfoProvider="cn.hikyson.godeye.core.internal.modules.leakdetector.DefaultLeakRefInfoProvider"/>
    <pageload/>
    <pss intervalMillis="2000"/>
    <ram intervalMillis="2000"/>
    <sm debugNotify="true"
        dumpIntervalMillis="500"
        longBlockThresholdMillis="300"
        shortBlockThresholdMillis="100"/>
    <thread intervalMillis="3000"
            threadFilter="cn.hikyson.godeye.core.internal.modules.thread.SimpleThreadFilter"/>
    <traffic intervalMillis="2000" sampleMillis="1000"/>
    <methodCanary maxMethodCountSingleThreadByCost="300" lowCostMethodThresholdMillis="10"/>
</config>

Uninstall modules when you don't need it(not recommend):

GodEye.instance().uninstall();

Note that network and startup module don't need install and uninstall.

When install finished, GodEye begin produce performance data, generally you can call consume of modules to get these datas, for example：

GodEye.instance().<Cpu>getModule(GodEye.ModuleName.CPU).subject().subscribe()

Just like we will mention later,Debug Monitor is one of these consumers.

GodEyeMonitor class is entrance for this step.

Start performance visualization dashboard:

GodEyeMonitor.work(context)

Stop it:

GodEyeMonitor.shutDown()

Install Android Studio plug-in(Search AndroidGodEye in Android Studio plugin setting),Then you can find AndroidGodEye in main toolbar,click it and it will open dashboard in browser.

Connect mobile phones and computers with USB, run adb forward tcp:5390 tcp:5390, then open http://localhost:port/index.html(Note that /index.html is necessary!!!) on PC. If you don't have a USB, you can also open http://mobile ip:port/index.html directly, ensure that mobile phones and PC are in the same LAN segment of course.

Default port is 5390, you can find ip in logcat output after call GodEyeMonitor.work(context,port), log is like:'Open AndroidGodEye dashboard [ http://ip:port/index.html" ] in your browser...'.

Now enjoy it!

and more...

How does AndroidGodEye work？As below:

AndroidGodEye is under Apache2.0.

• Github: Kyson
• Weibo: hikyson
• Blog: tech.hikyson.cn