การแก้ไขข้อบกพร่องของ Hit แคชระยะไกลสำหรับการดำเนินการระยะไกล

หน้านี้อธิบายวิธีตรวจสอบอัตราการเข้าถึงแคชและวิธีตรวจสอบการไม่พบแคชในบริบทของการดำเนินการจากระยะไกล

หน้านี้จะถือว่าคุณมีการสร้างและ/หรือการทดสอบที่ใช้การดำเนินการจากระยะไกลได้สำเร็จ และคุณต้องการตรวจสอบว่าคุณใช้แคชจากระยะไกลอย่างมีประสิทธิภาพ

การตรวจสอบอัตราการพบแคช

ในเอาต์พุตมาตรฐานของการเรียกใช้ Bazel ให้ดูบรรทัด INFO ที่แสดงรายการกระบวนการ ซึ่งโดยประมาณจะสอดคล้องกับการดำเนินการของ Bazel บรรทัดดังกล่าวจะแสดงรายละเอียดตำแหน่งที่ดำเนินการ มองหาป้ายกำกับ remote ซึ่งบ่งบอกถึงการดำเนินการจากระยะไกล, linux-sandbox สำหรับการดำเนินการในแซนด์บ็อกซ์ในเครื่อง และค่าอื่นๆ สำหรับกลยุทธ์การดำเนินการอื่นๆ การดำเนินการที่มีผลลัพธ์มาจากแคชจากระยะไกลจะแสดงเป็น remote cache hit

เช่น

INFO: 11 processes: 6 remote cache hit, 3 internal, 2 remote.

ในตัวอย่างนี้ มีการเข้าถึงแคชจากระยะไกล 6 ครั้ง และการดำเนินการ 2 รายการไม่มีการเข้าถึงแคชและดำเนินการจากระยะไกล คุณสามารถละเว้นส่วนภายใน 3 ได้ โดยปกติแล้วจะเป็นการดำเนินการภายในขนาดเล็ก เช่น การสร้างลิงก์สัญลักษณ์ การเข้าถึงแคชในเครื่องจะไม่รวมอยู่ในสรุปนี้ หากคุณได้รับ 0 กระบวนการ (หรือจำนวนที่ต่ำกว่าที่คาดไว้) ให้เรียกใช้ bazel clean ตามด้วยคำสั่งสร้าง/ทดสอบ

การแก้ปัญหาการเข้าถึงแคช

หากอัตราการพบแคชไม่เป็นไปตามที่คาดไว้ ให้ทำดังนี้

ตรวจสอบว่าการเรียกใช้คำสั่งสร้าง/ทดสอบเดิมซ้ำจะทำให้เกิดการเข้าถึงแคช

1. เรียกใช้บิลด์และ/หรือการทดสอบที่คุณคาดว่าจะป้อนข้อมูลในแคช เมื่อเรียกใช้บิลด์ใหม่เป็นครั้งแรกในสแต็กหนึ่งๆ คุณจะคาดหวังได้ว่าจะไม่มีการพบแคชจากระยะไกล การดำเนินการจากระยะไกลจะจัดเก็บผลลัพธ์ของการดำเนินการไว้ในแคช และการเรียกใช้ครั้งถัดไปควรดึงผลลัพธ์เหล่านั้นขึ้นมา

2. วิ่ง bazel clean คำสั่งนี้จะล้างแคชในเครื่อง ซึ่งช่วยให้คุณตรวจสอบการพบแคชจากระยะไกลได้โดยไม่ต้องให้ผลลัพธ์ถูกซ่อนไว้ด้วยการพบแคชในเครื่อง

3. เรียกใช้การสร้างและการทดสอบที่คุณกำลังตรวจสอบอีกครั้ง (ในเครื่องเดียวกัน)

4. ตรวจสอบบรรทัด INFO สำหรับอัตราการพบแคช หากไม่เห็นกระบวนการใดๆ ยกเว้น remote cache hit และ internal แสดงว่าระบบกำลังเติมข้อมูลและเข้าถึงแคชอย่างถูกต้อง ในกรณีดังกล่าว ให้ข้ามไปยังส่วนถัดไป

5. แหล่งที่มาของความคลาดเคลื่อนที่น่าจะเป็นไปได้คือสิ่งที่ไม่เป็นไปตามข้อกำหนดในการบิลด์ ซึ่งทำให้การดำเนินการได้รับปุ่มดำเนินการที่แตกต่างกันในการเรียกใช้ทั้ง 2 ครั้ง หากต้องการค้นหาการดำเนินการเหล่านั้น ให้ทำดังนี้

   ก. เรียกใช้บิลด์หรือการทดสอบที่เป็นปัญหาอีกครั้งเพื่อรับบันทึกการดำเนินการ

     bazel clean
     bazel --optional-flags build //your:target --execution_log_binary_file=/tmp/exec1.log

   ข. เปรียบเทียบบันทึกการดำเนินการระหว่างการเรียกใช้ทั้ง 2 ครั้ง ตรวจสอบว่าการดำเนินการเหมือนกันในไฟล์บันทึกทั้ง 2 ไฟล์ ความคลาดเคลื่อนจะให้ข้อมูลเกี่ยวกับสิ่งที่เปลี่ยนแปลงระหว่างการเรียกใช้ อัปเดตบิลด์ของคุณเพื่อขจัดความคลาดเคลื่อนเหล่านั้น

   หากคุณแก้ปัญหาการแคชได้แล้ว และตอนนี้การเรียกใช้ซ้ำทำให้เกิดการเข้าถึงแคชทั้งหมด ให้ข้ามไปยังส่วนถัดไป

   หากรหัสการดำเนินการเหมือนกันแต่ไม่มีการเข้าถึงแคช แสดงว่ามีบางอย่างในการกำหนดค่าที่ป้องกันการแคช ทำตามส่วนนี้เพื่อตรวจสอบปัญหาที่พบบ่อย

6. ตรวจสอบว่าการดำเนินการทั้งหมดในบันทึกการดำเนินการมีการตั้งค่า cacheable เป็น "จริง" หาก cacheable ไม่ปรากฏในบันทึกการดำเนินการสำหรับการดำเนินการหนึ่งๆ แสดงว่ากฎที่เกี่ยวข้องอาจมีแท็ก no-cache ในคำจำกัดความในไฟล์ BUILD ดูช่อง mnemonic และ target_label ในบันทึกการดำเนินการเพื่อช่วยระบุที่มาของการดำเนินการ

7. หากการดำเนินการเหมือนกันและ cacheable แต่ไม่มีการเข้าถึงแคช แสดงว่าบรรทัดคำสั่งอาจมี --noremote_accept_cached ซึ่งจะปิดใช้การค้นหาแคชสำหรับการสร้าง

   หากการระบุบรรทัดคำสั่งจริงเป็นเรื่องยาก ให้ใช้บรรทัดคำสั่งมาตรฐานจาก โปรโตคอลเหตุการณ์การสร้าง ดังนี้

   ก. เพิ่ม --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

ตรวจสอบว่ามีการแคชในเครื่องต่างๆ

หลังจากที่การเข้าถึงแคชเกิดขึ้นตามที่คาดไว้ในเครื่องเดียวกันแล้ว ให้เรียกใช้การสร้าง/การทดสอบเดียวกันในเครื่องอื่น หากสงสัยว่าไม่มีการแคชในเครื่องต่างๆ ให้ทำดังนี้

1. แก้ไขบิลด์เล็กน้อยเพื่อหลีกเลี่ยงการเข้าถึงแคชที่มีอยู่

2. เรียกใช้การสร้างในเครื่องแรก

    bazel clean
    bazel ... build ... --execution_log_binary_file=/tmp/exec1.log

3. เรียกใช้บิลด์ในเครื่องที่ 2 โดยตรวจสอบว่ามีการแก้ไขจากขั้นตอนที่ 1 แล้ว

    bazel clean
    bazel ... build ... --execution_log_binary_file=/tmp/exec2.log

4. เปรียบเทียบบันทึกการดำเนินการสำหรับการเรียกใช้ทั้งสอง ครั้ง หากบันทึกไม่เหมือนกัน ให้ตรวจสอบการกำหนดค่าบิลด์เพื่อดูความคลาดเคลื่อน รวมถึงพร็อพเพอร์ตี้จากสภาพแวดล้อมโฮสต์ที่รั่วไหลไปยังบิลด์ใดบิลด์หนึ่ง

การเปรียบเทียบบันทึกการดำเนินการ

บันทึกการดำเนินการจะมีบันทึกของการดำเนินการทั้งหมดที่ดำเนินการระหว่างบิลด์ สำหรับการดำเนินการแต่ละรายการจะมีองค์ประกอบ SpawnExec ที่มีข้อมูลทั้งหมดจากปุ่มดำเนินการ ดังนั้นหากบันทึกเหมือนกัน คีย์แคชการดำเนินการก็จะเหมือนกันด้วย

หากต้องการเปรียบเทียบบันทึกสำหรับการสร้าง 2 รายการที่ไม่ได้แชร์การเข้าถึงแคชตามที่คาดไว้ ให้ทำดังนี้

1. รับบันทึกการดำเนินการจากการสร้างแต่ละรายการและจัดเก็บเป็น /tmp/exec1.log และ /tmp/exec2.log

2. ดาวน์โหลดซอร์สโค้ดของ Bazel แล้วไปที่โฟลเดอร์ Bazel โดยใช้คำสั่งด้านล่าง คุณต้องใช้ซอร์สโค้ดเพื่อแยกวิเคราะห์บันทึกการดำเนินการด้วยตัวแยกวิเคราะห์ execlog

   git clone https://github.com/bazelbuild/bazel.git
   cd bazel
   

3. ใช้ตัวแยกวิเคราะห์บันทึกการดำเนินการเพื่อแปลงบันทึกเป็นข้อความ การเรียกใช้ต่อไปนี้จะจัดเรียงการดำเนินการในบันทึกที่ 2 ให้ตรงกับลำดับการดำเนินการในบันทึกที่ 1 เพื่อให้เปรียบเทียบได้ง่าย

   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
   

4. ใช้เครื่องมือเปรียบเทียบข้อความที่คุณชื่นชอบเพื่อเปรียบเทียบ /tmp/exec1.log.txt และ /tmp/exec2.log.txt