Systrace 和 RheaTrace 的使用方法

不管是应用开发，还是性能优化，都需要借助Systrace工具。

今天我们主要从Systrace工具入手，介绍一款字节开源的RheaTrace库（又名btrace，下文简称btrace）的使用。

Systrace

systrace是Google官方提供的，用于检测Android系统组件随时间运行状态的工具。

监控方法

Systrace的原理特别简单，就是在方法的开始和结束处，分别调用traceBegin和traceEnd方法。

将运行的结果组成Trace Event格式，借助Google提供Trace Viewer解析工具，呈现出以时间为横轴的方法调用堆栈图。

Android源码里，可以看到很多相关的代码。

Java层代码：

import android.os.Trace;
Trace.traceBegin(long traceTag, String methodName)
Trace.traceEnd(long traceTag)

Native层代码：

#include<utils/Trace.h>
ATRACE_CALL();

我们也可以在应用代码中，手动调用Trace的方法增加对应用方法的监控。

import android.os.Trace;
Trace.beginSection(String sectionName)
Trace.EndSection()

抓trace

1. 通过adb连接手机。

2. 进入本地的systrace目录：/Users/${user_name}/Library/Android/sdk/platform-tools/systrace，执行如下命令：

python systrace.py -b 32768 -t 5 -o mytrace.html gfx input view webview wm am sm audio video camera hal app res dalvik rs bionic power sched irq freq idle disk mmc load sync workq memreclaim regulators

为了后续操作方便，可以将systrace的路径加入环境变量，也可以设置alias。

systrace的缺点

默认只有Android系统的源码里添加了Trace相关的代码，应用代码如果想要加入监控，需要手动添加，效率太低。

btrace

btrace是字节开源的基于Systrace的Android trace工具，可以在编译期间自动注入自定义事件。

下面介绍一下，如何使用btrace来对应用进行更完整的监控。

其实btrace的文档已经写得很清楚了，大家可以直接去看文档，我在这里也给大家简单列一下。

1. 编译前

要使用btrace的插桩能力，需要在app工程中进行一些修改。

操作非常简单，只需要引入plugin，进行相应的配置即可。

首先，在根目录的build.gradle中增加rhea-gradle-plugin依赖。

buildscript {
    repositories {
        ...
        mavenCentral()
        ...
    }
    dependencies {
        classpath 'com.bytedance.btrace:rhea-gradle-plugin:1.0.1'
    }
}

allprojects {
    repositories {
        ...
        mavenCentral()
        ...
    }
}

然后在app/build.gradle文件中增加对应的插件和依赖，进行一些自定义的配置。

dependencies {
    //rheatrace core lib
    implementation "com.bytedance.btrace:rhea-core:1.0.1"
}
...
rheaTrace {
   compilation {
      //为减少 APK 体积, 你可以为 App 中需要跟踪的方法设置 id 以此来跟踪此自定义事件, 默认值 false。
      traceWithMethodID = false 
      //该文件配置决定哪些方法您不希望跟踪, 默认值 null。
      traceFilterFilePath = "${project.rootDir}/rhea-trace/traceFilter.txt"
      //用特指定方法 id 来设置自定义事件名称, 默认值 null。
      applyMethodMappingFilePath = "${project.rootDir}/rhea-trace/keep-method-id.txt"
  }

   runtime {
      //仅在主线程抓取跟踪事件, 默认值 false。
      mainThreadOnly true 
      //在 App 启动之初开始抓取跟踪事件, 默认值 true。
      startWhenAppLaunch true
      //指定内存存储 atrace 数据 ring buffer 的大小。
      atraceBufferSize "500000"
   }
}
// 增加插件
apply plugin: 'com.bytedance.rhea-trace'

2. 配置脚本环境

1. 确认python版本

目前btrace只支持python2.7，所以在使用之前，先确认一下当前使用的python版本号。

python --version

2. 配置systrace环境变量

因为btrace需要依赖systrace，所以必须配置systrace的环境变量，让我们可以任何目录访问到systrace。

export PATH=${PATH}:/Users/${user_name}/Library/Android/sdk/platform-tools/systrace

这里有一个问题，高版本的Android sdk移除了systrace，可以从30.0.0以下的版本下载systrace，拷贝到Android sdk目录下。

3. 抓trace

和systrace差不多，也是将手机通过adb连接，执行一个python脚本。

进入目录btrace/scripts/python/rheatrace，执行如下命令。

python rheatrace.py -a rhea.sample.android -t 5 -o ./output/mynewtrace.html sched freq idle am wm gfx view binder_driver hal dalvik camera input res

各个参数的含义，可以查阅文章最后附带的btrace官方README，如果使用过systrace的同学应该对这里的参数很熟悉。

执行完脚本后，在手机上执行你要监控的操作，等时间到了会自动生成trace文件。

4. 通过文件修改配置

支持通过文件修改配置，是我觉得btrace做得特别好的地方。

大概是因为字节的app也都比较重，编译一次很耗时，所以才有了这个方案，正好击中了开发大型app的同学们的痛点。

方法是创建名字为rheatrace.config的 Properties格式文件，写入如下配置，再push到sdcard/rhea-trace/${应用包名}下，重启即可让配置生效。

io=true
classLoad=true
memory=true
mainThreadOnly=true
atraceBufferSize=100000
startWhenAppLaunch=true

具体的字段含义，可以到btrace的github README上找，链接贴在文章最后。

5. 用Perfetto打开

Perfetto是Google新开发的性能调试工作，比Trace ViewerUI更好看，操作更快更便捷，且支持protobuf编码格式。

Perfetto是兼容Trace Event格式的，所以systrace抓取到的文件可以直接用Perfetto打开。perfetto

参考文章

bytedance btrace github trace-viewer格式 Perfetto Quickstart