Hồ sơ dấu vết JSON có thể rất hữu ích để nhanh chóng hiểu được thời gian Bazel đã sử dụng trong quá trình gọi.
Theo mặc định, đối với tất cả các lệnh và truy vấn giống như bản dựng, Bazel sẽ ghi một hồ sơ vào cơ sở đầu ra có tên là command-$INVOCATION_ID.profile.gz, trong đó $INVOCATION_ID là giá trị nhận dạng lệnh gọi của lệnh. Bazel cũng tạo một liên kết tượng trưng có tên là command.profile.gz trong cơ sở đầu ra trỏ đến hồ sơ của lệnh mới nhất. Bạn có thể định cấu hình xem một hồ sơ có được ghi bằng cờ
--generate_json_trace_profile
hay không và vị trí mà hồ sơ được ghi bằng cờ
--profile. Các vị trí kết thúc bằng .gz được nén bằng GZIP. Theo mặc định, Bazel giữ lại 5 hồ sơ gần đây nhất (có thể định cấu hình bằng
--profiles_to_retain,
) trong cơ sở đầu ra để phân tích sau bản dựng. Việc truyền rõ ràng đường dẫn hồ sơ bằng --profile sẽ tắt tính năng tự động thu thập rác.
Công cụ
Bạn có thể tải hồ sơ này vào chrome://tracing hoặc phân tích và xử lý sau bằng các công cụ khác.
chrome://tracing
Để trực quan hoá hồ sơ, hãy mở chrome://tracing trong một thẻ trình duyệt Chrome, nhấp vào "Tải" rồi chọn tệp hồ sơ (có thể được nén). Để xem kết quả chi tiết hơn, hãy nhấp vào các hộp ở góc dưới bên trái.
Hồ sơ ví dụ:
Hình 1. Hồ sơ ví dụ.
Bạn có thể sử dụng các nút điều khiển trên bàn phím sau để di chuyển:
- Nhấn
1để chuyển sang chế độ "chọn". Ở chế độ này, bạn có thể chọn các hộp cụ thể để kiểm tra thông tin chi tiết về sự kiện (xem góc dưới bên trái). Chọn nhiều sự kiện để xem bản tóm tắt và số liệu thống kê tổng hợp. - Nhấn
2để chuyển sang chế độ "di chuyển". Sau đó, kéo chuột để di chuyển chế độ xem. Bạn cũng có thể sử dụnga/dđể di chuyển sang trái/phải. - Nhấn
3để chuyển sang chế độ "thu phóng". Sau đó, kéo chuột để thu phóng. Bạn cũng có thể sử dụngw/sđể phóng to/thu nhỏ. - Nhấn
4để chuyển sang chế độ "thời gian", trong đó bạn có thể đo khoảng cách giữa hai sự kiện. - Nhấn
?để tìm hiểu về tất cả các nút điều khiển.
Trình phân tích lệnh gọi Bazel
Trình phân tích lệnh gọi Bazel nguồn mở sử dụng định dạng hồ sơ và in các đề xuất về cách cải thiện hiệu suất của bản dựng. Bạn có thể thực hiện phân tích này bằng CLI hoặc trên https://analyzer.engflow.com.
jq
jq giống như sed đối với dữ liệu JSON. Ví dụ về cách sử dụng jq để trích xuất tất cả thời lượng của bước tạo hộp cát trong quá trình thực thi hành động cục bộ:
$ 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
[...]
Thông tin hồ sơ
Hồ sơ chứa nhiều hàng. Thông thường, phần lớn các hàng đại diện cho các luồng Bazel và các sự kiện tương ứng, nhưng một số hàng đặc biệt cũng được đưa vào.
Các hàng đặc biệt được đưa vào phụ thuộc vào phiên bản Bazel được gọi khi hồ sơ được tạo và có thể được tuỳ chỉnh bằng các cờ khác nhau.
Hình 1 cho thấy một hồ sơ được tạo bằng Bazel phiên bản 5.3.1 và bao gồm các hàng sau:
action count: Hiển thị số lượng hành động đồng thời đang được thực hiện. Nhấp vào đó để xem giá trị thực tế. Phải tăng lên đến giá trị của--jobstrong các bản dựng sạch.CPU usage (Bazel): Đối với mỗi giây của bản dựng, hãy hiển thị lượng CPU mà Bazel đã sử dụng (giá trị 1 tương đương với một lõi đang bận 100%).Critical Path: Hiển thị một khối cho mỗi hành động trên đường dẫn quan trọng.Main Thread: Luồng chính của Bazel. Hữu ích để có được bức tranh tổng quan về những gì Bazel đang làm, ví dụ: "Launch Blaze", "evaluateTargetPatterns" và "runAnalysisPhase".Garbage Collector: Hiển thị các lần tạm dừng Thu thập rác (GC) nhỏ và lớn.
Các vấn đề thường gặp về hiệu suất
Khi phân tích hồ sơ hiệu suất, hãy tìm:
- Giai đoạn phân tích chậm hơn dự kiến (
runAnalysisPhase), đặc biệt là trên các bản dựng gia tăng. Đây có thể là dấu hiệu cho thấy việc triển khai quy tắc kém, ví dụ: một quy tắc làm phẳng depsets. Quá trình tải gói có thể chậm do số lượng mục tiêu quá nhiều, macro phức tạp hoặc glob đệ quy. - Các hành động riêng lẻ chậm, đặc biệt là những hành động trên đường dẫn quan trọng. Bạn có thể chia các hành động lớn thành nhiều hành động nhỏ hơn hoặc giảm tập hợp các phần phụ thuộc (bắc cầu) để tăng tốc độ. Ngoài ra, hãy kiểm tra xem có giá trị
PROCESS_TIMEcao bất thường (chẳng hạn nhưREMOTE_SETUPhoặcFETCH) hay không. - Các nút thắt cổ chai, tức là một số ít luồng đang bận trong khi tất cả các luồng khác đang ở trạng thái rảnh / chờ kết quả (xem khoảng 22 giây và 29 giây trong Hình 1). Để tối ưu hoá điều này, rất có thể bạn sẽ phải chạm vào việc triển khai quy tắc hoặc chính Bazel để tăng tính song song. Điều này cũng có thể xảy ra khi có một lượng GC bất thường.
Định dạng tệp hồ sơ
Đối tượng cấp cao nhất chứa siêu dữ liệu (otherData) và dữ liệu theo dõi thực tế (traceEvents). Siêu dữ liệu chứa thông tin bổ sung, ví dụ: mã lệnh gọi và ngày của lệnh gọi Bazel.
Ví dụ:
{
"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},
]
}
Dấu thời gian (ts) và thời lượng (dur) trong các sự kiện dấu vết được tính bằng phần triệu giây. Danh mục (cat) là một trong các giá trị enum của ProfilerTask.
Xin lưu ý rằng một số sự kiện được hợp nhất với nhau nếu chúng rất ngắn và gần nhau; hãy truyền --noslim_profile nếu bạn muốn ngăn việc hợp nhất sự kiện.
Hãy xem thêm Thông số kỹ thuật về định dạng sự kiện dấu vết của Chrome.