JSON 跟踪配置文件

<ph type="x-smartling-placeholder"></ph> 报告问题 查看来源 敬上 每晚 · 7.3。 · 7.2 条 · 7.1。 · 7.0。 · 6.5

JSON 跟踪记录配置文件对于快速了解 Bazel 所花的时间非常有用 在调用期间有效

默认情况下,对于所有类似构建的命令和查询,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 线程及其对应的事件,但也包含一些特殊行。

包含的特殊行取决于 配置文件已创建,并可通过不同的标志进行自定义。

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

  • action count:显示正在执行的并发操作数。点击 以查看实际值。应最高为 清理完毕:--jobs build。
  • CPU usage (Bazel):在构建过程中的每一秒,显示 Bazel 使用的 CPU(值为 1 表示一个核心处于 100% 繁忙状态)。
  • Critical Path:为关键路径上的每个操作显示一个块。
  • Main Thread:Bazel 的主线程。有助于您简要了解 Bazel 正在执行的操作,例如“Launch Blaze”“assessTargetPatterns”、 和“runAnalysisPhase”
  • Garbage Collector:显示次要和主要垃圾回收 (GC) 暂停。

常见的性能问题

分析效果概况时,请注意查看以下内容:

  • 比预期分析阶段 (runAnalysisPhase) 慢,尤其是在 增量构建。这可能表明规则实施效果不佳, 软件包加载可能会 过多的目标、复杂的宏或递归的 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_json_profile

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