JSON Trace プロファイル

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 を使用してズームイン / ズームアウトすることもできます。
2 つのイベント間の距離を測定できる「タイミング」モードの場合は、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: 実行中の同時アクションの数を表示します。これをクリックすると実際の値が表示されます。クリーンビルドでは --jobs の値に達するはずです。
CPU usage (Bazel): ビルドの 1 秒ごとに Bazel が使用する CPU の量を表示します（値 1 は 1 コアが 100% ビジー状態）。
Critical Path: クリティカルパスでのアクションごとに 1 つのブロックを表示します。
Main Thread: Bazel のメインスレッド。「Launch Blaze」、「evaluateTargetPatterns」、「runAnalysisPhase」など、Bazel の動作の概要を把握するのに便利です。
Garbage Collector: マイナーコレクションとメジャーガベージコレクション（GC）の一時停止を表示します。

パフォーマンスに関する一般的な問題

パフォーマンスプロファイルを分析する際は、次の点をご確認ください。

特に増分ビルドの場合、予想される分析フェーズ（runAnalysisPhase）よりも遅くなります。これは、デプスをフラット化するなど、ルール実装が不適切である可能性を示しています。パッケージの読み込みは、過剰なターゲット、複雑なマクロ、再帰的な Glob 処理によって遅くなることがあります。
特にクリティカルパス上の個々の遅いアクション。大規模なアクションを複数の小さなアクションに分割したり、（推移的な）依存関係を減らして高速化することもできます。また、異常な高 PROCESS_TIME（REMOTE_SETUP や FETCH など）がないかチェックします。
ボトルネック（少数のスレッドがビジー状態、他のすべてのスレッドがアイドル状態または結果を待機している状態）（図 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 の列挙値の 1 つです。一部のイベントが非常に短く、互いに近接している場合は、マージされます。イベントの統合を防ぐには、--noslim_json_profile を渡します。

Chrome Trace イベント形式の仕様もご覧ください。