Mengekstrak metrik performa build

Laporkan masalah Lihat sumber

Mungkin setiap pengguna Bazel pernah mengalami build yang lambat atau lebih lambat dari yang diperkirakan. Meningkatkan performa setiap build memiliki nilai tertentu untuk target dengan dampak signifikan, seperti:

  1. Target developer inti yang sering diiterasi dan dibuat (ulang).

  2. Library umum sangat bergantung pada target lain.

  3. Target perwakilan dari class target (misalnya, aturan kustom), mendiagnosis dan memperbaiki masalah dalam satu build dapat membantu menyelesaikan masalah pada skala yang lebih besar.

Langkah penting untuk meningkatkan performa build adalah memahami tempat resource dihabiskan. Halaman ini mencantumkan berbagai metrik yang dapat Anda kumpulkan. Mengelompokkan performa build akan menunjukkan cara menggunakan metrik ini untuk mendeteksi dan memperbaiki masalah performa build.

Ada beberapa cara utama untuk mengekstrak metrik dari build Bazel Anda, yaitu:

Protokol Peristiwa Build (BEP)

Bazel menghasilkan berbagai buffering protokol build_event_stream.proto melalui Build Event Protocol (BEP), yang dapat digabungkan oleh backend yang Anda tentukan. Bergantung pada kasus penggunaan, Anda mungkin memutuskan untuk menggabungkan metrik dalam berbagai cara, tetapi di sini kita akan membahas beberapa konsep dan kolom proto yang secara umum berguna untuk dipertimbangkan.

Perintah query / cquery / aquery Bazel

Bazel menyediakan 3 mode kueri yang berbeda (kueri, cquery, dan aquery) yang memungkinkan pengguna membuat kueri grafik target, masing-masing grafik target yang dikonfigurasi, dan grafik tindakan. Bahasa kueri menyediakan serangkaian fungsi yang dapat digunakan di berbagai mode kueri, sehingga Anda dapat menyesuaikan kueri sesuai dengan kebutuhan.

Profil Rekaman Aktivitas JSON

Untuk setiap pemanggilan Bazel yang mirip build, Bazel akan menulis profil rekaman aktivitas dalam format JSON. Profil rekaman aktivitas JSON bisa sangat berguna untuk memahami dengan cepat waktu yang dihabiskan Bazel selama pemanggilan.

Log Eksekusi

Log eksekusi dapat membantu Anda memecahkan masalah dan memperbaiki hit cache jarak jauh yang tidak ada karena perbedaan mesin dan lingkungan atau tindakan non-deterministik. Jika Anda meneruskan flag --experimental_execution_log_spawn_metrics (tersedia dari Bazel 5.2), flag tersebut juga akan berisi metrik spawn yang mendetail, baik untuk tindakan yang dijalankan secara lokal maupun dari jarak jauh. Misalnya, Anda dapat menggunakan metrik ini untuk membuat perbandingan antara performa mesin lokal dan jarak jauh, atau untuk mengetahui bagian mana dari eksekusi spawn yang secara konsisten lebih lambat dari yang diharapkan (misalnya karena antrean).

Log Grafik Eksekusi

Meskipun profil rekaman aktivitas JSON berisi informasi jalur penting, terkadang Anda memerlukan informasi tambahan tentang grafik dependensi tindakan yang dieksekusi. Mulai dari Bazel 6.0, Anda dapat meneruskan flag --experimental_execution_graph_log dan --experimental_execution_graph_log_dep_type=all untuk menulis log tentang tindakan yang dijalankan dan dependensinya.

Informasi ini dapat digunakan untuk memahami tarik yang ditambahkan oleh node di jalur penting. Tarik adalah jumlah waktu yang berpotensi dapat dihemat dengan menghapus node tertentu dari grafik eksekusi.

Data ini membantu Anda memprediksi dampak perubahan terhadap build dan grafik tindakan sebelum Anda benar-benar melakukannya.

Membuat benchmark dengan bazel-bench

Bazel bench adalah alat benchmark bagi project Git untuk mengukur performa build dalam kasus berikut:

  • Benchmark project: Menjalankan benchmark terhadap dua commit git satu sama lain pada satu versi Bazel. Digunakan untuk mendeteksi regresi dalam build Anda (sering kali melalui penambahan dependensi).

  • Benchmark Bazel: Menjalankan benchmark terhadap dua versi Bazel satu sama lain dengan satu commit git. Digunakan untuk mendeteksi regresi dalam Bazel itu sendiri (jika Anda kebetulan memelihara / melakukan fork Bazel).

Benchmark memantau waktu proses instal, waktu CPU, dan waktu sistem serta ukuran heap yang dipertahankan Bazel.

Sebaiknya jalankan bench Bazel di mesin fisik khusus yang tidak menjalankan proses lain untuk mengurangi sumber variabilitas.