หน้านี้อธิบายวิธีตรวจสอบอัตราการเข้าถึงแคชและวิธีตรวจสอบ การไม่พบแคชในบริบทของการดำเนินการจากระยะไกล
หน้านี้ถือว่าคุณมีบิลด์และ/หรือการทดสอบที่ใช้การดำเนินการจากระยะไกลได้สำเร็จ และคุณต้องการตรวจสอบว่าคุณใช้แคชระยะไกลอย่างมีประสิทธิภาพ
ตรวจสอบอัตราการเข้าชมแคช
ในเอาต์พุตมาตรฐานของการเรียกใช้ Bazel ให้ดูบรรทัด INFO
ที่แสดงรายการ
กระบวนการ ซึ่งสอดคล้องกับการดำเนินการของ Bazel โดยประมาณ บรรทัดนั้นจะแสดงรายละเอียด
ตำแหน่งที่เรียกใช้การดำเนินการ มองหาป้ายกำกับ remote
ซึ่งระบุการดำเนินการ
ที่ดำเนินการจากระยะไกล linux-sandbox
สำหรับการดำเนินการที่ดำเนินการในแซนด์บ็อกซ์ในเครื่อง
และค่าอื่นๆ สำหรับกลยุทธ์การดำเนินการอื่นๆ การดำเนินการที่มีผลลัพธ์มาจากแคชระยะไกลจะแสดงเป็น remote cache hit
เช่น
INFO: 11 processes: 6 remote cache hit, 3 internal, 2 remote.
ในตัวอย่างนี้ มีการเข้าถึงแคชระยะไกล 6 ครั้ง และการดำเนินการ 2 รายการไม่มี
การเข้าถึงแคชและดำเนินการจากระยะไกล คุณสามารถละเว้นส่วนที่ 3 ภายในได้
โดยปกติแล้วจะเป็นการดำเนินการภายในเล็กๆ น้อยๆ เช่น การสร้างลิงก์สัญลักษณ์ การเข้าชมแคชในเครื่องจะไม่รวมอยู่ในข้อมูลสรุปนี้ หากคุณได้รับ 0 processes
(หรือตัวเลขที่ต่ำกว่าที่คาดไว้) ให้เรียกใช้ bazel clean
ตามด้วยคำสั่งบิลด์/ทดสอบ
การแก้ปัญหาการเข้าชมแคช
หากอัตราการเข้าชมแคชไม่เป็นไปตามที่คาดไว้ ให้ทำดังนี้
ตรวจสอบว่าการเรียกใช้คำสั่งบิลด์/ทดสอบเดียวกันอีกครั้งจะทำให้แคชทำงาน
เรียกใช้บิลด์และ/หรือการทดสอบที่คุณคาดว่าจะสร้างแคช ครั้งแรกที่เรียกใช้บิลด์ใหม่ในสแต็กหนึ่งๆ คุณจะคาดหวังได้ว่าจะไม่มีแคชระยะไกล ที่ตรงกัน ผลลัพธ์ของการดำเนินการจะจัดเก็บไว้ในแคชและควรมีการเรียกใช้ในภายหลัง
เรียกใช้
bazel clean
คำสั่งนี้จะล้างแคชในเครื่อง ซึ่งช่วยให้คุณตรวจสอบการเข้าชมแคชระยะไกลได้โดยไม่ต้องให้ผลลัพธ์ถูกปิดบังโดยการเข้าชมแคชในเครื่องเรียกใช้บิลด์และการทดสอบที่คุณกำลังตรวจสอบอีกครั้ง (ในเครื่องเดียวกัน)
ตรวจสอบ
INFO
สำหรับอัตราการเข้าชมแคช หากไม่เห็นกระบวนการใดๆ ยกเว้นremote cache hit
และinternal
แสดงว่าระบบกำลังป้อนข้อมูลและเข้าถึงแคชอย่างถูกต้อง ในกรณีนี้ ให้ข้ามไปยังส่วนถัดไปแหล่งที่มาของความคลาดเคลื่อนที่อาจเกิดขึ้นคือสิ่งที่ไม่ใช่แบบปิดในบิลด์ ซึ่งทำให้การดำเนินการได้รับคีย์การดำเนินการที่แตกต่างกันในการเรียกใช้ 2 ครั้ง หากต้องการค้นหาการดำเนินการเหล่านั้น ให้ทำดังนี้
ก. เรียกใช้บิลด์หรือการทดสอบที่เป็นปัญหาอีกครั้งเพื่อรับบันทึกการดำเนินการ
bazel clean
bazel --optional-flags build //your:target --execution_log_binary_file=/tmp/exec1.log
ข. เปรียบเทียบบันทึกการดำเนินการระหว่างการเรียกใช้ 2 ครั้ง ตรวจสอบว่าการดำเนินการเหมือนกันในไฟล์บันทึกทั้ง 2 ไฟล์ ความคลาดเคลื่อนจะให้ข้อมูลเบาะแสเกี่ยวกับการเปลี่ยนแปลงที่เกิดขึ้นระหว่างการเรียกใช้ อัปเดตบิลด์เพื่อขจัดความคลาดเคลื่อนดังกล่าว
หากแก้ปัญหาการแคชได้แล้วและตอนนี้การเรียกใช้ซ้ำ ทำให้เกิดการเข้าชมแคชทั้งหมด ให้ข้ามไปยังส่วนถัดไป
หากรหัสการกระทำเหมือนกัน แต่ไม่มีการเข้าชมที่แคช แสดงว่ามีบางอย่าง ในการกำหนดค่าที่ป้องกันไม่ให้แคช ดำเนินการต่อในส่วนนี้เพื่อ ตรวจสอบปัญหาที่พบบ่อย
ตรวจสอบว่าการดำเนินการทั้งหมดในบันทึกการดำเนินการมี
cacheable
ตั้งค่าเป็น "จริง" หากcacheable
ไม่ปรากฏในบันทึกการดำเนินการสำหรับการดำเนินการที่กำหนด แสดงว่ากฎที่เกี่ยวข้องอาจมีแท็กno-cache
ในคำจำกัดความในไฟล์BUILD
ดูฟิลด์mnemonic
และtarget_label
ในบันทึกการดำเนินการเพื่อช่วยระบุว่าการดำเนินการมาจากที่ใดหากการดำเนินการเหมือนกันและ
cacheable
แต่ไม่มีแคชฮิต แสดงว่าบรรทัดคำสั่งอาจมี--noremote_accept_cached
ซึ่งจะปิดใช้การค้นหาแคชสำหรับการสร้างหากการหาบรรทัดคำสั่งจริงเป็นเรื่องยาก ให้ใช้บรรทัดคำสั่งที่ถูกต้อง จาก Build Event Protocol ดังนี้
ก. เพิ่ม
--build_event_text_file=/tmp/bep.txt
ลงในคำสั่ง Bazel เพื่อรับ บันทึกเวอร์ชันข้อความข. เปิดบันทึกเวอร์ชันข้อความแล้วค้นหา
structured_command_line
ข้อความที่มีcommand_line_label: "canonical"
โดยจะแสดงตัวเลือกทั้งหมดหลังจากขยายค. ค้นหา
remote_accept_cached
และตรวจสอบว่าได้ตั้งค่าเป็นfalse
หรือไม่ง. หาก
remote_accept_cached
เป็นfalse
ให้พิจารณาว่ามีการตั้งค่าเป็นfalse
ที่ใด ไม่ว่าจะในบรรทัดคำสั่งหรือในไฟล์ bazelrc
ตรวจสอบว่ามีการแคชในเครื่องต่างๆ
หลังจากที่แคชฮิตเกิดขึ้นตามที่คาดไว้ในเครื่องเดียวกันแล้ว ให้เรียกใช้ บิลด์/การทดสอบเดียวกันในเครื่องอื่น หากสงสัยว่าการแคช ไม่เกิดขึ้นในเครื่องต่างๆ ให้ทำดังนี้
แก้ไขบิลด์เล็กน้อยเพื่อหลีกเลี่ยงการเข้าถึงแคชที่มีอยู่
เรียกใช้บิลด์ในเครื่องแรก
bazel clean
bazel ... build ... --execution_log_binary_file=/tmp/exec1.log
เรียกใช้บิลด์ในเครื่องที่ 2 โดยตรวจสอบว่ามีการแก้ไขจากขั้นตอนที่ 1 รวมอยู่ด้วย
bazel clean
bazel ... build ... --execution_log_binary_file=/tmp/exec2.log
เปรียบเทียบบันทึกการดำเนินการของการเรียกใช้ 2 ครั้ง หากบันทึกไม่เหมือนกัน ให้ตรวจสอบการกำหนดค่าบิลด์เพื่อหาความคลาดเคลื่อน รวมถึงพร็อพเพอร์ตี้จากสภาพแวดล้อมโฮสต์ที่รั่วไหลไปยังบิลด์ใดบิลด์หนึ่ง
การเปรียบเทียบบันทึกการดำเนินการ
บันทึกการดำเนินการมีบันทึกการดำเนินการทั้งหมดที่ดำเนินการระหว่างการสร้าง สําหรับแต่ละการกระทําจะมีองค์ประกอบ SpawnExec ซึ่งมีข้อมูลทั้งหมดจากคีย์การกระทํา ดังนั้นหากบันทึกเหมือนกัน คีย์แคชการกระทําก็จะเหมือนกัน
หากต้องการเปรียบเทียบบันทึกของ 2 บิลด์ที่ไม่ได้แชร์แคชฮิตตามที่คาดไว้ ให้ทำดังนี้
รับบันทึกการดำเนินการจากแต่ละบิลด์และจัดเก็บเป็น
/tmp/exec1.log
และ/tmp/exec2.log
ดาวน์โหลดซอร์สโค้ด Bazel แล้วไปที่โฟลเดอร์ Bazel โดยใช้คำสั่งด้านล่าง คุณต้องมีซอร์สโค้ดเพื่อแยกวิเคราะห์ บันทึกการดำเนินการด้วย ตัวแยกวิเคราะห์ execlog
git clone https://github.com/bazelbuild/bazel.git cd bazel
ใช้โปรแกรมแยกวิเคราะห์บันทึกการดำเนินการเพื่อแปลงบันทึกเป็นข้อความ การเรียกใช้ต่อไปนี้จะจัดเรียงการดำเนินการในบันทึกที่ 2 ให้ตรงกับลำดับการดำเนินการในบันทึกแรกเพื่อให้เปรียบเทียบได้ง่าย
bazel build src/tools/execlog:parser bazel-bin/src/tools/execlog/parser \ --log_path=/tmp/exec1.log \ --log_path=/tmp/exec2.log \ --output_path=/tmp/exec1.log.txt \ --output_path=/tmp/exec2.log.txt
ใช้เครื่องมือเปรียบเทียบข้อความที่คุณชื่นชอบเพื่อเปรียบเทียบ
/tmp/exec1.log.txt
และ/tmp/exec2.log.txt