Skip to content

Latest commit

 

History

History
91 lines (65 loc) · 4.44 KB

anr-tracer-cn.md

File metadata and controls

91 lines (65 loc) · 4.44 KB
Raw

Hawkeye - ANR Tracer

ANR Records 用于记录卡顿/卡死事件，同时采样卡顿发生时的主线程调用栈

0x00 使用

  1. 启动 App 后，点击 Hawkeye 的浮窗进入主面板
  2. 点击导航栏 title，呼出 Hawkeye 面板切换界面
  3. 点击切换界面右上角的 Setting，进入 Hawkeye 设置主界面
  4. 找到 ANR Trace, 进入开启 Trace ANR
  5. 可以通过设置ANR Threshold 来设定卡顿判断阈值。

0x01 卡顿记录

当主线程中的某项任务执行时长超过指定阈值（默认为 400ms）时，会触发生成一次卡顿记录，并记录触发时的主线程堆栈。在 ANR Records 界面可看到记录的卡顿数据列表和卡顿详情

ANR Record list ANR Record detail

如果需要更精确的卡顿时长和堆栈信息，可考虑使用 UI Time Profiler

0x02 卡死记录

每次启动时，可通过 MTHANRTracingBuffer 获取到上一次是否是卡死状态退出。

界面说明

如果上一次 Hawkeye 的 ANRTrace 模块有开启，运行时卡死，下一次运行，进入到 Hawkeye 的 ANR Records 界面，列表的最后一个 section 会展示这次卡死记录。

标题为 Previous session exit unexptected，副标题展示了卡住的时间。

接口调用说明

如果上层要在启动时统计上报卡死事件，可参考 Hawkeye 里 [MTHANRTracingBufferRunner readPreviousSessionBufferAtPath:completionHandler:] 的代码调用逻辑，根据自己需要上报记录。目前记录了以下数据：

  • 程序退出前的最后 30 次主线程 runloop activity
  • 程序退出前的最后 10 次 App 生命周期记录
  • 卡顿/卡死发生时记录到的主线程调用栈 （最多保留 500 帧)

可根据接口提供的数据，读取卡死了多长时间，卡死后捕获到的主线程的调用栈记录。

0x03 存储说明

ANR 的数据存储在 Records 文件 下。collection 为 anr，key 为卡顿时间结束的时间点（0.12.1之后的版本对它进行了优化，会拆分>16kb以上的卡顿数据再存储，key会变成卡顿时间戳_序号，当外部使用的时候需要进行数据合并，请参考readANRRecords中的合并方式）value 为 json 字符串，字段说明如下：

  • duration: 卡顿总时长（毫秒）
  • inBackground: 是否运行在后台
  • stacks: 卡顿周期内记录到的主线程堆栈
    • capturedCount: 被记录的次数，相同的记录会被去重
    • stackframes: 发生时的调用堆栈取样（未符号化）,以 , 分隔的十六进制地址字符串
    • threadCount: 当前线程数量
    • time: 这个卡顿堆栈首次记录时间戳（秒)
    • titleframe: 卡顿堆栈标题
  • startFrom: 卡顿开始的时间戳（秒）

示例：

{
    duration = "610.3181838989258";
    inBackground = 0;
    stacks = {
            capturedCount = 1;
            stackframes = "0x10d8fe55e,0x10d896497,0x108455f9a,0x108455c01,0x108455620,0x116a5d3d4,0x116a5d7b1,0x116888611,0x11687945f,0x1168a8865,0x10d8c4856,0x10d8bf2ed,0x10d8bf969,0x10d8bf055,0x10fa8fbaf,0x11687f88c,0x108460821,0x10e0084ac";
            threadCount = 6;
            time = "1565256930.870066";
            titleframe = 0x108455f9a;
        },
        {
            capturedCount = 1;
            stackframes = "0x10d90461b,0x10d8fe6f5";
            threadCount = 6;
            time = "1565256930.975193";
            titleframe = 0x10d90461b;
        }
    startFrom = "1565256930.414564";
}

0x03 符号化说明

ANR Trace 在运行过程中记录的 stack frame 为原始内存地址，需要进行符号化以便阅读。

如果是 debug 阶段或者程序包未去除符号表，则可直接使用 ANR Trace 主面板进入记录详情页查看符号化后的结果。

其他情况下，如果已经自己实现了符号化服务，并做了设置，可打开 Remote Symbolics，再查看详情记录时会切换调用远程符号化服务。

若想在程序退出运行后，从沙盒里拿到记录的数据，则需要自己进行符号化。手动操作可按以下步骤：

  1. 拿到 hawkeye 存储目录下的 dyld-images 文件
  2. 拿到待符号化的 stack-frames 数据
  3. 拿到运行包对应的符号表文件
  4. 针对每一个 stack-frame，找到所在 dyld-image, 使用 atos 命令进行符号化