Men-debug Hit Cache Jarak Jauh untuk Eksekusi Jarak Jauh

Laporkan masalah Lihat sumber 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Halaman ini menjelaskan cara memeriksa rasio cache ditemukan dan cara menyelidiki cache tidak ditemukan dalam konteks eksekusi jarak jauh.

Halaman ini mengasumsikan bahwa Anda memiliki build dan/atau pengujian yang berhasil menggunakan eksekusi jarak jauh, dan Anda ingin memastikan bahwa Anda secara efektif menggunakan cache jarak jauh.

Memeriksa rasio hit cache

Pada output standar dari proses Bazel, lihat baris INFO yang mencantumkan proses, yang kurang lebih sesuai dengan tindakan Bazel. Baris tersebut menjelaskan tempat tindakan dijalankan. Cari label remote, yang menunjukkan tindakan yang dijalankan dari jarak jauh, linux-sandbox untuk tindakan yang dijalankan di sandbox lokal, dan nilai lainnya untuk strategi eksekusi lainnya. Tindakan yang hasilnya berasal dari cache jarak jauh ditampilkan sebagai remote cache hit.

Contoh:

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

Dalam contoh ini, ada 6 hit cache jarak jauh, dan 2 tindakan tidak memiliki hit cache dan dieksekusi dari jarak jauh. Tiga bagian internal dapat diabaikan. Biasanya, ini adalah tindakan internal kecil, seperti membuat link simbolis. Hit cache lokal tidak disertakan dalam ringkasan ini. Jika Anda mendapatkan 0 proses (atau angka yang lebih rendah dari yang diharapkan), jalankan bazel clean diikuti dengan perintah build/test Anda.

Memecahkan masalah hit cache

Jika Anda tidak mendapatkan rasio hit cache yang diharapkan, lakukan hal berikut:

Memastikan menjalankan kembali perintah build/test yang sama akan menghasilkan hit cache

Jalankan build dan/atau pengujian yang Anda harapkan untuk mengisi cache. Saat pertama kali build baru dijalankan pada stack tertentu, Anda mungkin tidak akan menemui cache jarak jauh. Sebagai bagian dari eksekusi jarak jauh, hasil tindakan disimpan dalam cache dan proses berikutnya akan mendeteksinya.
Jalankan bazel clean. Perintah ini akan membersihkan cache lokal, yang memungkinkan Anda menyelidiki hit cache jarak jauh tanpa hasil yang disamarkan oleh hit cache lokal.
Jalankan build dan pengujian yang Anda selidiki lagi (di mesin yang sama).
Periksa baris INFO untuk melihat rasio cache ditemukan. Jika Anda tidak melihat proses selain remote cache hit dan internal, berarti cache Anda telah diisi dan diakses dengan benar. Jika demikian, lanjutkan ke bagian berikutnya.
Sumber perbedaan yang mungkin terjadi adalah sesuatu yang tidak hermetis dalam build yang menyebabkan tindakan menerima kunci tindakan yang berbeda di kedua operasi. Untuk menemukan tindakan tersebut, lakukan langkah berikut:

a. Jalankan kembali build atau pengujian yang dimaksud untuk mendapatkan log eksekusi:
```
  bazel clean
  bazel --optional-flags build //your:target --execution_log_compact_file=/tmp/exec1.log
```
b. Bandingkan log eksekusi antara kedua operasi. Pastikan tindakan di kedua file log tersebut sama. Perbedaan memberikan petunjuk tentang perubahan yang terjadi di antara operasi. Update build Anda untuk menghilangkan perbedaan tersebut.

Jika Anda dapat menyelesaikan masalah penyimpanan dalam cache dan sekarang pengulangan proses menghasilkan semua hit cache, lanjutkan ke bagian berikutnya.

Jika ID tindakan Anda sama tetapi tidak ada hit cache, berarti ada sesuatu dalam konfigurasi Anda yang mencegah penyimpanan dalam cache. Lanjutkan ke bagian ini untuk memeriksa masalah umum.
Pastikan semua tindakan dalam log eksekusi memiliki cacheable yang ditetapkan ke benar. Jika cacheable tidak muncul dalam log eksekusi untuk tindakan tertentu, itu berarti aturan yang sesuai mungkin memiliki tag no-cache dalam definisinya di file BUILD. Lihat kolom mnemonic dan target_label dalam log eksekusi untuk membantu menentukan asal tindakan tersebut.
Jika tindakannya identik dan cacheable, tetapi tidak ada hit cache, mungkin command line Anda menyertakan --noremote_accept_cached yang akan menonaktifkan pencarian cache untuk build.

Jika sulit untuk mengetahui command line yang sebenarnya, gunakan command line kanonik dari Build Event Protocol sebagai berikut:

a. Tambahkan --build_event_text_file=/tmp/bep.txt ke perintah Bazel Anda untuk mendapatkan versi teks log.

b. Buka versi teks log dan telusuri pesan structured_command_line dengan command_line_label: "canonical". Opsi ini akan mencantumkan semua opsi setelah diperluas.

c. Telusuri remote_accept_cached dan periksa apakah setelan ini ditetapkan ke false.

d. Jika remote_accept_cached adalah false, tentukan tempatnya ditetapkan ke false: di command line atau dalam file bazelrc.

Memastikan penyimpanan dalam cache di seluruh mesin

Setelah cache ditemukan terjadi seperti yang diharapkan pada komputer yang sama, jalankan build/pengujian yang sama di mesin lain. Jika Anda mencurigai bahwa penyimpanan dalam cache tidak terjadi di seluruh komputer, lakukan hal berikut:

Lakukan sedikit modifikasi pada build Anda untuk menghindari cache yang ada.

Jalankan build di mesin pertama:

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

Jalankan build di mesin kedua, pastikan modifikasi dari langkah 1 disertakan:

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

Bandingkan log eksekusi untuk kedua proses yang berjalan. Jika log tidak identik, periksa perbedaan konfigurasi build Anda, serta properti dari lingkungan host yang bocor ke salah satu build.

Membandingkan log eksekusi

Log eksekusi berisi catatan tindakan yang dieksekusi selama build. Setiap data menjelaskan input (tidak hanya file, tetapi juga argumen command line, variabel lingkungan, dll.) dan output tindakan. Dengan demikian, pemeriksaan log dapat mengungkapkan alasan tindakan dieksekusi ulang.

Log eksekusi dapat dibuat dalam salah satu dari tiga format: ringkas (--execution_log_compact_file), biner (--execution_log_binary_file), atau JSON (--execution_log_json_file). Format ringkas direkomendasikan karena menghasilkan file yang jauh lebih kecil dengan overhead runtime yang sangat sedikit. Petunjuk berikut berfungsi untuk semua format. Anda juga dapat mengonversi di antara keduanya menggunakan alat //src/tools/execlog:converter.

Untuk membandingkan log bagi dua build yang tidak membagikan hit cache seperti yang diharapkan, lakukan hal berikut:

Dapatkan log eksekusi dari setiap build dan simpan sebagai /tmp/exec1.log dan /tmp/exec2.log.
Download kode sumber Bazel dan build alat //src/tools/execlog:parser:

git clone https://github.com/bazelbuild/bazel.git cd bazel bazel build //src/tools/execlog:parser
Gunakan alat //src/tools/execlog:parser untuk mengonversi log menjadi format teks yang dapat dibaca manusia. Dalam format ini, tindakan dalam log kedua diurutkan agar cocok dengan urutan dalam log pertama, sehingga memudahkan perbandingan.
```
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
```
Gunakan teks favorit Anda yang berbeda dengan diff /tmp/exec1.log.txt dan /tmp/exec2.log.txt.