btrace

重大更新

用户体验： 我们现在支持Windows！不再依赖Python 2.7和存储权限！脚本语言已更改为Java，将脚本工具的可用性问题造成的中断几乎降至零！我们还切换到PB协议来处理跟踪文件，使存储需求减少70%，打开跟踪文件的速度提升7倍。
性能体验： 重写了方法跟踪收集逻辑，将数据从字符串转换为整数，内存使用减少80%。数据存储改为mmap模式，优化了无锁队列逻辑，提供了精确的插桩策略，在数百万方法插桩的情况下，进一步将性能损失降低到15%！
监控数据： 新增4种数据监控能力，包括渲染、Binder、线程创建以及Wait/Notify/Park/Unpark的详细数据！

集成

项目配置

在项目根目录的build.gradle文件中添加rhea-gradle-plugin作为依赖：

buildscript {
    dependencies {
        classpath 'com.bytedance.btrace:rhea-gradle-plugin:2.0.3-rc02'
    }
}

然后，在app/build.gradle文件中应用以下插件和依赖。

dependencies {
    // rheatrace核心库
    implementation "com.bytedance.btrace:rhea-core:2.0.3-rc02"
}
...
apply plugin: 'com.bytedance.rhea-trace'
...
rheaTrace {
   compilation {
      traceFilterFilePath = "${project.rootDir}/trace-filter/traceFilter.txt"
      needPackageWithMethodMap = true
      applyMethodMappingFilePath = ""
   }
}

插件配置

RheaTrace 2.0简化了编译插件配置，只需要一个编译配置来控制编译期间的行为。RheaTrace 1.0中的运行时配置已被弃用，但为了确保升级时的兼容性，我们仍然保留了运行时参数配置，尽管它不会影响行为。相反，在RheaTrace 2.0中，动态配置是通过脚本中的命令行参数实现的，这将在后面详细描述。

参数	默认值	描述
traceFilterFilePath	null	此文件决定哪些方法需要被插桩，其用法与RheaTrace 1.0一致。请参考：RheaTrace Gradle插件配置
applyMethodMappingFilePath	null	可以通过指定上一次编译输出的methodMapping.txt文件路径来指定设备的方法ID，以确保多次编译的方法ID一致。
needPackageWithMethodMap	true	是否将methodMapping.txt文件打包到apk内。

使用方法

要使用RheaTrace 2.0，请按以下步骤操作：

确保你的电脑已集成adb和Java环境。
将手机连接到电脑，并确保adb devices能识别到。
在手机上安装集成了RheaTrace 2.0的APK。
从下方的"脚本管理"下载最新脚本到电脑。
在电脑脚本所在目录执行以下命令。

java -jar rhea-trace-shell.jar -a ${你的应用包名} -t 10 -o output.pb -r rhea.all sched -fullClassName

可以通过 https://ui.perfetto.dev/ 分析跟踪文件。

脚本管理

版本	发布日期	下载	发布说明
2.0.0	2023-06-24	rhea-trace-shell-2.0.0.jar	2.0.0 首次发布

参数说明

下表描述了 RheaTrace 2.0 命令行参数：

必需参数

参数	默认值	描述
-a $applicationName	不适用	指定您的应用程序包名

可选参数

参数	默认值	描述
-o $outputPath	不适用	指定保存跟踪文件的路径。默认值根据时间戳自动生成。
-t $timeInSecond	5	指定跟踪时间长度，单位为秒。
-mode $mode	根据设备	指定跟踪模式。目前支持两种模式：1. perfetto：8.1及以上系统的默认模式，允许收集应用程序函数以及系统atrace和ftrace的跟踪。2. simple：8.1以下系统的默认模式，允许收集应用程序函数以及系统atrace的跟踪。
-maxAppTraceBufferSize $size	500000000	指定跟踪收集期间使用的缓冲区大小，单位为字节。通常不需要配置此参数，除非遇到类似以下提示：MaxAppTraceBufferSize太小。预期100515704 实际100000000。请在命令中添加-maxAppTraceBufferSize 100515704注意：maxAppTraceBufferSize仅在应用程序启动后的第一次跟踪中生效。
-threshold $ns	0	指定跟踪收集期间的函数时间阈值，单位为纳秒。此参数可在跟踪时间较长时减小跟踪文件的大小。
-s $serial		指定通过adb连接的设备。
-mainThreadOnly	不适用	仅跟踪主线程。
-r		自动重启应用程序以捕获启动跟踪。
-fullClassName		启用跟踪信息的包名。
-deeplink $deeplink	不适用	指定深链接。
rhea.binder		启用binder信息增强。
rhea.render		启用渲染监控功能。
rhea.io		启用I/O监控功能。
rhea.thread		启用线程创建监控功能。
rhea.block		启用park/unpark/wait/notify监控功能。
rhea.all		启用上述所有RheaTrace增强监控功能。
-debug		打印调试日志。
--list		显示设备支持的类别列表。

技术原理

如果您对RheaTrace 2.0的内部细节感兴趣，可以参考以下文档：RheaTrace 2.0内部原理详解！

已知问题

编号	问题	建议
1	某些自定义ROM可能在获取Perfetto跟踪时遇到失败，错误信息如下：错误：未找到systrace文件：rheatrace.workspace/systemTrace.trace 提示：您的设备可能不支持perfetto。请尝试使用 `-mode simple`。	1. 尝试重启手机并再次尝试。2. 如果问题未解决，请使用 -mode simple 重试。
2	不支持Perfetto的设备（主要是8.1之前的系统）无法收集CPU调度等系统信息。	尝试使用 -mode simple。
3	如果您使用32位APK，可能会因内存不足错误而导致崩溃。	要解决此问题，您可以切换到64位包，或者如果必须使用32位，请尝试通过降低bufferSize和配置方法收集阈值来减少虚拟内存使用。这将允许您收集更长时间的跟踪，而不会使用过多的虚拟内存。
4	如果因为methodMapping构建到APK中并依赖于mergeAssets而遇到循环依赖问题	您可以关闭内置的methodMapping功能。可以通过在Gradle插件配置中将needPackageWithMethodMap设置为false来实现。但是，如果您需要使用btrace功能，则必须使用-m选项手动提供methodMapping的路径。

反馈

我们在RheaTrace 2.0中进行了大量改进，包括更好的错误提示。可能仍然存在一些情况下提示不够准确或消息不够清晰。如果您遇到任何问题，只需在下面的飞书群中告诉我们，我们会尽最大努力帮助您。我们也非常感谢您提供的任何其他反馈或建议，谢谢！

贡献

贡献指南

许可证

Apache许可证