JSON トレースプロファイル

問題を報告ソースを表示 Nightly · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

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 を押して「タイミング」モードにすると、2 つのイベント間の距離を測定できます。
すべてのコントロールについて詳しくは、? を押してください。

`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 Invocation Analyzer

オープンソースの Bazel Invocation Analyzer は、プロファイル形式を使用し、ビルドのパフォーマンスを改善する方法に関する提案を出力します。この分析は、CLI を使用して実行することも、https://analyzer.engflow.com で実行することもできます。

`jq`

jq は、JSON データの 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): ビルドの各秒について、Bazel で使用された CPU の量が表示されます（値 1 は 1 つのコアが 100% ビジー状態であることを示します）。
Critical Path: クリティカルパス上のアクションごとに 1 つのブロックを表示します。
Main Thread: Bazel のメインスレッド。Bazel が何をしているのか（「Launch Blaze」、「evaluateTargetPatterns」、「runAnalysisPhase」など）を大まかに把握するのに役立ちます。
Garbage Collector: マイナーとメジャーのガベージコレクション（GC）の一時停止を表示します。

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

パフォーマンスプロファイルを分析する際は、次の点に注目します。

分析フェーズ（runAnalysisPhase）が予想よりも遅い（特に増分ビルドの場合）。これは、depsets をフラット化するルールなど、ルールの実装が不適切な兆候である可能性があります。ターゲットの数が多すぎる、マクロが複雑すぎる、グロブが再帰的であるなどの理由で、パッケージの読み込みが遅くなることがあります。
個々の遅いアクション（特にクリティカルパス上のアクション）。大きなアクションを複数の小さなアクションに分割したり、推移的な依存関係のセットを減らしたりすることで、アクションを高速化できる場合があります。また、異常に高い非 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 の列挙値のいずれかです。イベントが非常に短く、互いに近い場合、イベントが統合されることがあります。イベントの統合を防止する場合は、--noslim_json_profile を渡します。

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

JSON トレース プロファイル

ツール

chrome://tracing

bazel analyze-profile