JSON トレースプロファイル

<ph type="x-smartling-placeholder"></ph> 問題を報告するソースを表示夜間 · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

JSON トレースプロファイルは、Bazel が何に費やしたかをすばやく把握するのに非常に役立ちます。呼び出すことができます。

デフォルトでは、ビルドに似たすべてのコマンドとクエリに対して、Bazel は command-$INOVCATION_ID.profile.gz という名前の出力ベースにプロファイルを書き込みます。ここで、$INOVCATION_ID はコマンドの呼び出し ID です。Bazel は、出力ベースに、プロファイルを指す command.profile.gz というシンボリックリンク確認できます。プロファイルに --generate_json_trace_profile その変数が書き込まれる場所は、 --profile フラグ。.gz で終わるロケーションは GZIP で圧縮されます。Bazel は、ビルド後の分析のために、デフォルトで出力ベースに過去 5 つのプロファイル（--profiles_to_retain で構成可能）を保持します。--profile を使用してプロファイルパスを明示的に渡すと、自動ガベージコレクションが無効になります。

ツール

このプロファイルを chrome://tracing に読み込むか、分析して他のツールで後処理します

`chrome://tracing`

プロファイルを可視化するには、Chrome ブラウザタブで chrome://tracing を開きます。 [Load]をクリックします圧縮される可能性があるプロファイルファイルを選択します。詳細情報左下のボックスをクリックします。

プロファイルの例:

図 1. プロファイルの例。

次のキーボード操作を使用して移動できます。

「選択」するには 1 を押しますモードです。このモードでは、特定のボックスを選択してイベントの詳細を調べることができます（左下を参照）。複数のイベントを選択すると、概要と集計統計情報が表示されます。
2 キーを押すと「パン」モードです。次に、マウスをドラッグしてビューを移動します。マイページ a / d を使用して左右に移動することもできます。
3 を押して「ズーム」モードにします。マウスをドラッグしてズームします。Google Chat ではまた、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: 処理中の同時実行アクションの数を表示します。クリックすると、実際の値が表示されます。クリーンビルドでは --jobs の値まで増やす必要があります。
CPU usage (Bazel): ビルドの 1 秒ごとに、Bazel によって使用された CPU の量を表示します（値 1 は、1 つのコアが 100% ビジー状態であることを意味します）。
Critical Path: クリティカルパス上のアクションごとに 1 つのブロックを表示します。
Main Thread: Bazel のメインスレッド。Bazel が実行している処理（「Launch Blaze」、「evaluateTargetPatterns」、「runAnalysisPhase」など）の概要を把握するのに役立ちます。
Garbage Collector: マイナーガベージコレクション（GC）とメジャーガベージコレクション（GC）の一時停止を表示します。

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

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

特に次の分析フェーズが予想よりも遅い（runAnalysisPhase）使用できます。これは、depset をフラット化するなど、ルールの実装が適切でないことを示す可能性があります。パッケージの読み込みは、過剰な数のターゲット、複雑なマクロ、または再帰的 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_profile イベントの統合を禁止するにはどうすればよいでしょうか。

関連ドキュメント: Chrome トレースイベント形式の仕様

JSON トレース プロファイル

ツール

chrome://tracing

bazel analyze-profile