JSON 跟踪配置文件

报告问题 查看源代码

JSON 轨迹配置文件非常有助于快速了解 Bazel 在调用期间花了多长时间。

默认情况下,对于所有类似 build 的命令和查询,Bazel 会将此类配置文件写入 command.profile.gz。您可以使用 --generate_json_trace_profile 标志来配置是否向配置文件写入数据,以及使用 --profile 标志将其写入的位置。以 .gz 结尾的位置使用 GZIP 进行压缩。使用 --experimental_announce_profile_path 标志可将此文件的路径输出到日志。

工具

您可以将此配置文件加载到 chrome://tracing 中,也可以使用其他工具对其进行分析和后处理。

chrome://tracing

如需直观呈现配置文件,请在 Chrome 浏览器标签页中打开 chrome://tracing,点击“加载”,然后选择(可能经过压缩的)配置文件。如需查看更详细的结果,请点击左下角的复选框。

个人资料示例:

个人资料示例

图 1. 个人资料示例。

您可以使用以下键盘控件进行导航:

  • 1 可进入“选择”模式。在此模式下,您可以选择特定复选框以检查事件详细信息(参见左下角)。选择多个事件即可获取摘要和汇总统计信息。
  • 2 可进入“平移”模式。然后拖动鼠标来移动视图。您还可以使用 a/d 向左/向右移动。
  • 3 可进入“缩放”模式。然后拖动鼠标进行缩放。您也可以使用 w/s 进行缩放。
  • 4 进入“计时”模式,在该模式下,您可以测量两个事件之间的距离。
  • ? 以了解所有控件。

bazel analyze-profile

Bazel 子命令 analyze-profile 使用配置文件格式,并输出每个构建阶段不同任务类型的累计统计信息以及关键路径分析结果。

例如,命令

$ bazel build --profile=/tmp/profile.gz //path/to:target
...
$ bazel analyze-profile /tmp/profile.gz

可能会生成如下输出:

INFO: Profile created on Tue Jun 16 08:59:40 CEST 2020, build ID: 0589419c-738b-4676-a374-18f7bbc7ac23, output base: /home/johndoe/.cache/bazel/_bazel_johndoe/d8eb7a85967b22409442664d380222c0

=== PHASE SUMMARY INFORMATION ===

Total launch phase time         1.070 s   12.95%
Total init phase time           0.299 s    3.62%
Total loading phase time        0.878 s   10.64%
Total analysis phase time       1.319 s   15.98%
Total preparation phase time    0.047 s    0.57%
Total execution phase time      4.629 s   56.05%
Total finish phase time         0.014 s    0.18%
------------------------------------------------
Total run time                  8.260 s  100.00%

Critical path (4.245 s):
       Time Percentage   Description
    8.85 ms    0.21%   _Ccompiler_Udeps for @local_config_cc// compiler_deps
    3.839 s   90.44%   action 'Compiling external/com_google_protobuf/src/google/protobuf/compiler/php/php_generator.cc [for host]'
     270 ms    6.36%   action 'Linking external/com_google_protobuf/protoc [for host]'
    0.25 ms    0.01%   runfiles for @com_google_protobuf// protoc
     126 ms    2.97%   action 'ProtoCompile external/com_google_protobuf/python/google/protobuf/compiler/plugin_pb2.py'
    0.96 ms    0.02%   runfiles for //tools/aquery_differ aquery_differ

Bazel 调用分析器

开源的 Bazel 调用分析器使用配置文件格式,并输出有关如何提升构建性能的建议。此分析可以使用其 CLI 或 https://analyzer.engflow.com 执行。

jq

对于 JSON 数据,jq 类似于 sed。以下示例演示了如何使用 jq 提取本地操作执行过程中沙盒创建步骤的所有时长:

$ zcat $(../bazel-6.0.0rc1-linux-x86_64 info output_base)/command.profile.gz | jq '.traceEvents | .[] | select(.name == "sandbox.createFileSystem") | .dur'
6378
7247
11850
13756
6555
7445
8487
15520
[...]

资料信息

配置文件包含多行。通常,大量行表示 Bazel 线程及其对应的事件,但也包括一些特殊行。

其中包含的特殊行取决于创建配置文件时调用的 Bazel 版本,并且可以根据不同的标志进行自定义。

图 1 显示了使用 Bazel v5.3.1 创建的配置文件,并包含以下行:

  • action count:显示正在执行的并发操作数量。点击即可查看实际值。在干净 build 中,应上升到 --jobs 的值。
  • CPU usage (Bazel):在构建过程中的每一秒内,显示 Bazel 使用的 CPU 数量(值为 1 表示一个核心 100% 繁忙)。
  • Critical Path:为关键路径上的每项操作显示一个块。
  • Main Thread:Bazel 的主线程。有助于大致了解 Bazel 正在执行的操作,例如“启动 Blaze”“评估 TargetPatterns”和“runAnalysisPhase”。
  • Garbage Collector:显示次要和主要垃圾回收 (GC) 暂停。

常见的性能问题

分析效果概况时,请注意以下几点:

  • 比预期分析阶段 (runAnalysisPhase) 慢,尤其是在增量 build 上。这可能表明规则实现不当,例如扁平化依赖项的实现。过多的目标、复杂的宏或递归 glob 可能会导致软件包加载变慢。
  • 个别缓慢操作,尤其是关键路径上的操作。或许可以将大型操作拆分为多个较小的操作,或减少(传递)依赖项集合以加快这些操作的速度。此外,还要检查是否存在异常高的非 PROCESS_TIME(例如 REMOTE_SETUPFETCH)。
  • 瓶颈,即少量线程处于忙碌状态,而所有其他线程处于空闲状态 / 等待结果(请参阅图 1 中约 22 秒和 29 秒)。 为优化此目标,很可能需要处理规则实现或 Bazel 本身,以引入更多的并行性。当 GC 数量异常时,也可能会发生这种情况。

配置文件格式

顶级对象包含元数据 (otherData) 和实际跟踪数据 (traceEvents)。元数据包含额外的信息,例如调用 ID 和 Bazel 调用的日期。

例如:

{
  "otherData": {
    "build_id": "101bff9a-7243-4c1a-8503-9dc6ae4c3b05",
    "date": "Wed Oct 26 08:22:35 CEST 2022",
    "profile_finish_ts": "1677666095162000",
    "output_base": "/usr/local/google/_bazel_johndoe/573d4be77eaa72b91a3dfaa497bf8cd0"
  },
  "traceEvents": [
    {"name":"thread_name","ph":"M","pid":1,"tid":0,"args":{"name":"Critical Path"}},
    ...
    {"cat":"build phase marker","name":"Launch Blaze","ph":"X","ts":-1306000,"dur":1306000,"pid":1,"tid":21},
    ...
    {"cat":"package creation","name":"foo","ph":"X","ts":2685358,"dur":784,"pid":1,"tid":246},
    ...
    {"name":"thread_name","ph":"M","pid":1,"tid":11,"args":{"name":"Garbage Collector"}},
    {"cat":"gc notification","name":"minor GC","ph":"X","ts":825986,"dur":11000,"pid":1,"tid":11},
    ...
    {"cat":"action processing","name":"Compiling foo/bar.c","ph":"X","ts":54413389,"dur":357594,"pid":1,"args":{"mnemonic":"CppCompile"},"tid":341},
 ]
}

轨迹事件中的时间戳 (ts) 和时长 (dur) 以微秒为单位。类别 (cat) 是 ProfilerTask 的枚举值之一。请注意,如果某些事件非常短且彼此靠近,则会合并在一起;如果您想阻止事件合并,请传递 --noslim_profile

另请参阅 Chrome 跟踪事件格式规范