JSON 追蹤記錄設定檔

如要快速瞭解 Bazel 在叫用期間花費的時間，JSON 追蹤設定檔非常實用。

根據預設，所有類似建構的指令，並查詢 Bazel 會將這類設定檔寫入 command.profile.gz。您可以設定是否要使用 --generate_json_trace_profile 標記寫入設定檔，以及使用 --profile 旗標寫入設定檔的位置。結尾為 .gz 的位置會使用 GZIP 壓縮。使用旗標 --experimental_announce_profile_path，在記錄檔中列印這個檔案的路徑。

工具

您可以將這個設定檔載入 chrome://tracing，或使用其他工具進行分析和後續處理。

`chrome://tracing`

如要以視覺化方式呈現設定檔，請在 Chrome 瀏覽器分頁中開啟 chrome://tracing，按一下「Load」，然後選擇可能壓縮的設定檔檔案。如要查看更詳細的結果，請按一下左下角的方塊。

個人資料範例：

圖 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 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 的值等於 100% 的忙碌程度)。
Critical Path：為重要路徑上的每個動作顯示一個區塊。
Main Thread：Bazel 的主要執行緒。有助於概略瞭解 Bazel 正在執行的作業，例如「Launch Blaze」、「valuTargetPatterns」和「runAnalysisPhase」。
Garbage Collector：顯示小型和主要垃圾收集 (GC) 暫停情形。

常見效能問題

分析成效設定檔時，請注意以下幾點：

低於預期的分析階段 (runAnalysisPhase)，尤其是漸進式建構作業。這可能表示規則實作方式不佳，例如，規則實作方式過於平滑。套件載入速度可能會因為目標數量過多、巨集或遞迴 glob 而變慢。
個別執行速度緩慢的動作，尤其是關鍵路徑上的動作。您可以將大型動作分割為多個較小的動作，或是減少一組 (遞移) 依附元件以加快執行速度。此外，請檢查是否有異常的高度非 PROCESS_TIME 值 (例如 REMOTE_SETUP 或 FETCH)。
少數執行緒忙於忙碌中，而其他執行緒都在忙碌中，而所有其他執行緒正在等候結果 (請參閱圖 1 約 22 秒和 29 秒)。最佳化這項作業很可能需要觸碰規則實作或 Bazel 本身，才能執行更多平行處理。當垃圾收集量異常時，也可能會發生這種情況。

設定檔檔案格式

頂層物件包含中繼資料 (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 追蹤事件格式規格。