โปรไฟล์การติดตาม JSON จะมีประโยชน์มากในการทำความเข้าใจสิ่งที่ Bazel ใช้เวลานานในระหว่างการเรียกใช้
โดยค่าเริ่มต้น คำสั่งที่เหมือนบิลด์และคำค้นหาทั้งหมด Bazel จะเขียนโปรไฟล์ดังกล่าวไปยัง command.profile.gz คุณสามารถกำหนดค่าได้ว่าจะให้เขียนโปรไฟล์ด้วยแฟล็ก --generate_json_trace_profile หรือไม่ รวมถึงตำแหน่งที่จะเขียนโปรไฟล์ด้วยแฟล็ก --profile สถานที่ตั้งที่ลงท้ายด้วย .gz จะได้รับการบีบอัดด้วย GZIP ใช้แฟล็ก --experimental_announce_profile_path เพื่อพิมพ์เส้นทางไปยังไฟล์นี้ลงในบันทึก
เครื่องมือ
คุณสามารถโหลดโปรไฟล์นี้ลงใน chrome://tracing หรือวิเคราะห์และ
หลังประมวลผลด้วยเครื่องมืออื่นๆ
chrome://tracing
หากต้องการแสดงภาพโปรไฟล์ ให้เปิด chrome://tracing ในแท็บเบราว์เซอร์ Chrome คลิก "โหลด" แล้วเลือกไฟล์โปรไฟล์ (ที่อาจบีบอัด) หากต้องการดูผลลัพธ์ที่ละเอียดยิ่งขึ้น ให้คลิกช่องที่มุมล่างซ้าย
โปรไฟล์ตัวอย่าง:
รูปที่ 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
เครื่องมือวิเคราะห์การเรียกใช้ Bazel แบบโอเพนซอร์สจะใช้รูปแบบโปรไฟล์และพิมพ์คำแนะนำวิธีปรับปรุงประสิทธิภาพของบิลด์ การวิเคราะห์นี้สามารถดำเนินการโดยใช้ CLI หรือใน https://analyzer.engflow.com
jq
jq มีลักษณะเหมือน sed สำหรับข้อมูล JSON ตัวอย่างการใช้ 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): สำหรับแต่ละวินาทีของบิลด์ จะแสดงจำนวน CPU ที่ Bazel ใช้ (ค่า 1 เท่ากับ 1 แกนหมายถึงไม่ว่าง 100%)Critical Path: แสดง 1 บล็อกสำหรับการดำเนินการแต่ละรายการในเส้นทางวิกฤติMain Thread: ชุดข้อความหลักของ Bazel การดูภาพรวมกว้างๆ ว่า Bazel กำลังทำอะไรอยู่ เช่น "เปิดใช้ Blaze", "impressionTargetPatterns" และ "runAnalysisPhase"Garbage Collector: แสดงการหยุดเก็บขยะ (GC) เพียงเล็กน้อยและใหญ่
ปัญหาด้านประสิทธิภาพที่พบบ่อย
เมื่อวิเคราะห์โปรไฟล์ประสิทธิภาพ ให้มองหาข้อมูลต่อไปนี้
- ช้ากว่าระยะการวิเคราะห์ที่คาดไว้ (
runAnalysisPhase) โดยเฉพาะในบิลด์ที่เพิ่มขึ้น นี่อาจเป็นสัญญาณของการใช้กฎที่ไม่มีประสิทธิภาพ เช่น กฎที่ค่อยๆ ลดค่าที่กำหนด การโหลดแพ็กเกจอาจช้าลงเนื่องจากมีเป้าหมายมากเกินไป มาโครที่ซับซ้อน หรือบอลลูนที่เกิดซ้ำ - การดำเนินการที่ช้าแต่ละรายการ โดยเฉพาะการดำเนินการที่อยู่ในเส้นทางสำคัญ คุณอาจสามารถแบ่งการดำเนินการขนาดใหญ่ออกเป็นการดำเนินการย่อยหลายๆ การดำเนินการ หรือลดชุดของทรัพยากร Dependency (ชั่วคราว) เพื่อให้ทำงานได้เร็วขึ้น และตรวจหาค่าที่ไม่ใช่
PROCESS_TIMEสูงผิดปกติ (เช่นREMOTE_SETUPหรือFETCH) - จุดคอขวด คือชุดข้อความจำนวนเล็กน้อยที่ยุ่งเหยิงอยู่ ขณะที่คนอื่นๆ ทั้งหมดไม่มีการใช้งาน / กำลังรอผลลัพธ์ (ดูประมาณ 22 และ 29 ในรูปที่ 1) ในการเพิ่มประสิทธิภาพ ก็เป็นไปได้ว่าจะต้องมีการใช้กฎ หรือตัว Bazel เองเพื่อให้ทำงานพร้อมกันได้มากขึ้น กรณีนี้อาจเกิดขึ้นได้เช่นกัน เมื่อมีจำนวน GC มากผิดปกติ
รูปแบบไฟล์โปรไฟล์
ออบเจ็กต์ระดับบนสุดมีข้อมูลเมตา (otherData) และข้อมูลการติดตามจริง (traceEvents) ข้อมูลเมตาจะมีข้อมูลเพิ่มเติม เช่น รหัสคำขอและวันที่ของการเรียกใช้ 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) เป็นหนึ่งในค่า enum ของ ProfilerTask
โปรดทราบว่าระบบจะรวมบางเหตุการณ์เข้าด้วยกันหากสั้นมากและอยู่ใกล้กัน ดังนั้นให้ข้าม --noslim_profile หากไม่ต้องการรวมเหตุการณ์เข้าด้วยกัน
โปรดดูข้อกำหนดรูปแบบเหตุการณ์ของ Chrome Trace ด้วย