Mengelompokkan performa build

Laporkan masalah Lihat sumber Nightly · 8.0 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bazel bersifat kompleks dan melakukan banyak hal yang berbeda selama build, beberapa di antaranya dapat memengaruhi performa build. Halaman ini mencoba memetakan beberapa konsep Bazel ini dengan implikasinya terhadap performa build. Meskipun tidak luas, kami telah menyertakan beberapa contoh cara mendeteksi masalah performa build melalui mengekstrak metrik dan tindakan yang dapat Anda lakukan untuk memperbaikinya. Dengan demikian, kami harap Anda dapat menerapkan konsep ini saat menyelidiki regresi performa build.

Build Bersih vs Inkremental

Build bersih adalah build yang mem-build semuanya dari awal, sedangkan build inkremental menggunakan kembali beberapa pekerjaan yang sudah selesai.

Sebaiknya lihat build bersih dan inkremental secara terpisah, terutama saat Anda mengumpulkan / menggabungkan metrik yang bergantung pada status cache Bazel (misalnya metrik ukuran permintaan build ). Build tersebut juga mewakili dua pengalaman pengguna yang berbeda. Dibandingkan dengan memulai build bersih dari awal (yang memerlukan waktu lebih lama karena cache dingin), build inkremental terjadi jauh lebih sering saat developer melakukan iterasi pada kode (biasanya lebih cepat karena cache biasanya sudah hangat).

Anda dapat menggunakan kolom CumulativeMetrics.num_analyses di BEP untuk mengklasifikasikan build. Jika num_analyses <= 1, ini adalah build bersih; jika tidak, kita dapat secara luas mengkategorikannya sebagai build inkremental - pengguna mungkin telah beralih ke flag atau target yang berbeda yang menyebabkan build bersih yang efektif. Definisi incrementalitas yang lebih ketat kemungkinan harus berupa heuristic, misalnya melihat jumlah paket yang dimuat (PackageMetrics.packages_loaded).

Metrik build deterministik sebagai proxy untuk performa build

Mengukur performa build dapat menjadi sulit karena sifat non-deterministik metrik tertentu (misalnya waktu CPU atau waktu antrean Bazel di cluster jarak jauh). Dengan demikian, sebaiknya gunakan metrik deterministik sebagai proxy untuk jumlah pekerjaan yang dilakukan oleh Bazel, yang pada akhirnya memengaruhi performanya.

Ukuran permintaan build dapat memiliki implikasi yang signifikan terhadap performa build. Build yang lebih besar dapat mewakili lebih banyak pekerjaan dalam menganalisis dan membuat grafik build. Pertumbuhan organik build terjadi secara alami seiring dengan pengembangan, karena semakin banyak dependensi yang ditambahkan/dibuat, sehingga kompleksitasnya meningkat dan menjadi lebih mahal untuk dibuat.

Kita dapat membagi masalah ini menjadi berbagai fase build, dan menggunakan metrik berikut sebagai metrik proxy untuk pekerjaan yang dilakukan di setiap fase:

PackageMetrics.packages_loaded: jumlah paket yang berhasil dimuat. Regresi di sini mewakili lebih banyak pekerjaan yang perlu dilakukan untuk membaca dan mengurai setiap file BUILD tambahan dalam fase pemuatan.
- Hal ini sering kali disebabkan oleh penambahan dependensi dan harus memuat penutupan transitifnya.
- Gunakan query / cquery untuk menemukan tempat dependensi baru mungkin telah ditambahkan.
TargetMetrics.targets_configured: mewakili jumlah target dan aspek yang dikonfigurasi dalam build. Regresi mewakili lebih banyak pekerjaan dalam membuat dan menjelajahi grafik target yang dikonfigurasi.
- Hal ini sering kali disebabkan oleh penambahan dependensi dan harus membuat grafik penutupan transitifnya.
- Gunakan cquery untuk menemukan tempat dependensi baru mungkin telah ditambahkan.
ActionSummary.actions_created: mewakili tindakan yang dibuat dalam build, dan regresi mewakili lebih banyak pekerjaan dalam membuat grafik tindakan. Perhatikan bahwa hal ini juga mencakup tindakan yang tidak digunakan yang mungkin belum dieksekusi.
- Gunakan aquery untuk men-debug regresi; sebaiknya mulai dengan --output=summary sebelum merinci lebih lanjut dengan --skyframe_state.
ActionSummary.actions_executed: jumlah tindakan yang dijalankan, regresi secara langsung mewakili lebih banyak pekerjaan dalam menjalankan tindakan ini.
- BEP menulis statistik tindakan ActionData yang menunjukkan jenis tindakan yang paling banyak dijalankan. Secara default, jenis tindakan ini mengumpulkan 20 jenis tindakan teratas, tetapi Anda dapat meneruskan --experimental_record_metrics_for_all_mnemonics untuk mengumpulkan data ini untuk semua jenis tindakan yang dijalankan.
- Hal ini akan membantu Anda mengetahui jenis tindakan yang dijalankan (selain itu).
BuildGraphSummary.outputArtifactCount: jumlah artefak yang dibuat oleh tindakan yang dieksekusi.
- Jika jumlah tindakan yang dijalankan tidak meningkat, kemungkinan implementasi aturan telah diubah.

Semua metrik ini terpengaruh oleh status cache lokal, sehingga Anda harus memastikan bahwa build yang Anda ekstrak dari metrik ini adalah build bersih.

Kami telah mencatat bahwa regresi dalam salah satu metrik ini dapat disertai dengan regresi dalam waktu proses, waktu CPU, dan penggunaan memori.

Penggunaan resource lokal

Bazel menggunakan berbagai resource di komputer lokal Anda (baik untuk menganalisis grafik build dan mendorong eksekusi, maupun untuk menjalankan tindakan lokal), hal ini dapat memengaruhi performa / ketersediaan mesin Anda dalam melakukan build, dan juga tugas lainnya.

Waktu yang dihabiskan

Mungkin metrik yang paling rentan terhadap derau (dan dapat sangat bervariasi dari build ke build) adalah waktu; khususnya - waktu wall, waktu CPU, dan waktu sistem. Anda dapat menggunakan bazel-bench untuk mendapatkan benchmark untuk metrik ini, dan dengan jumlah --runs yang memadai, Anda dapat meningkatkan signifikansi statistik pengukuran.

Waktu dinding adalah waktu dunia nyata yang berlalu.
- Jika hanya waktu tunggu yang mengalami regresi, sebaiknya kumpulkan profil rekaman aktivitas JSON dan cari perbedaannya. Jika tidak, sebaiknya Anda menyelidiki metrik lain yang mengalami regresi karena metrik tersebut dapat memengaruhi waktu proses.
Waktu CPU adalah waktu yang dihabiskan oleh CPU untuk mengeksekusi kode pengguna.
- Jika waktu CPU mengalami regresi di dua commit project, sebaiknya kumpulkan profil CPU Starlark. Anda mungkin juga harus menggunakan --nobuild untuk membatasi build ke fase analisis karena di sanalah sebagian besar pekerjaan berat CPU dilakukan.
Waktu sistem adalah waktu yang dihabiskan oleh CPU di kernel.
- Jika waktu sistem mengalami regresi, hal ini sebagian besar berkorelasi dengan I/O saat Bazel membaca file dari sistem file Anda.

Pembuatan profil beban seluruh sistem

Dengan menggunakan flag --experimental_collect_load_average_in_profiler yang diperkenalkan di Bazel 6.0, profiler rekaman aktivitas JSON mengumpulkan rata-rata beban sistem selama pemanggilan.

Gambar 1. Profil yang menyertakan rata-rata beban sistem.

Beban yang tinggi selama pemanggilan Bazel dapat menjadi indikasi bahwa Bazel menjadwalkan terlalu banyak tindakan lokal secara paralel untuk mesin Anda. Sebaiknya pertimbangkan untuk menyesuaikan --local_cpu_resources dan --local_ram_resources, terutama di lingkungan penampung (setidaknya hingga #16512 digabungkan).

Memantau penggunaan memori Bazel

Ada dua sumber utama untuk mendapatkan penggunaan memori Bazel, Bazel info dan BEP.

bazel info used-heap-size-after-gc: Jumlah memori yang digunakan dalam byte setelah panggilan ke System.gc().
- Bazel bench juga menyediakan benchmark untuk metrik ini.
- Selain itu, ada peak-heap-size, max-heap-size, used-heap-size, dan committed-heap-size (lihat dokumentasi), tetapi kurang relevan.
MemoryMetrics.peak_post_gc_heap_size BEP: Ukuran puncak ukuran heap JVM dalam byte setelah GC (memerlukan setelan --memory_profile yang mencoba memaksa GC penuh).

Regresi dalam penggunaan memori biasanya merupakan hasil dari regresi dalam metrik ukuran permintaan build, yang sering kali disebabkan oleh penambahan dependensi atau perubahan dalam penerapan aturan.

Untuk menganalisis jejak memori Bazel pada tingkat yang lebih terperinci, sebaiknya gunakan profiler memori bawaan untuk aturan.

Profiling memori pekerja persisten

Meskipun pekerja persisten dapat membantu mempercepat build secara signifikan (terutama untuk bahasa yang ditafsirkan), jejak memorinya dapat bermasalah. Bazel mengumpulkan metrik pada pekerjanya, khususnya, kolom WorkerMetrics.WorkerStats.worker_memory_in_kb yang menunjukkan jumlah memori yang digunakan pekerja (dengan mnemoni).

JSON trace profiler juga mengumpulkan penggunaan memori pekerja persisten selama pemanggilan dengan meneruskan tanda --experimental_collect_system_network_usage (baru di Bazel 6.0).

Gambar 2. Profil yang menyertakan penggunaan memori pekerja.

Menurunkan nilai --worker_max_instances (default 4) dapat membantu mengurangi jumlah memori yang digunakan oleh pekerja persisten. Kami secara aktif berupaya membuat pengelola dan penjadwal resource Bazel lebih cerdas sehingga penyesuaian seperti itu tidak akan sering diperlukan di masa mendatang.

Memantau traffic jaringan untuk build jarak jauh

Dalam eksekusi jarak jauh, Bazel mendownload artefak yang di-build sebagai hasil dari menjalankan tindakan. Dengan demikian, bandwidth jaringan dapat memengaruhi performa build Anda.

Jika menggunakan eksekusi jarak jauh untuk build, sebaiknya pertimbangkan untuk memantau traffic jaringan selama pemanggilan menggunakan proto NetworkMetrics.SystemNetworkStats dari BEP (memerlukan penerusan --experimental_collect_system_network_usage).

Selain itu, profil rekaman aktivitas JSON memungkinkan Anda melihat penggunaan jaringan seluruh sistem selama proses build dengan meneruskan flag --experimental_collect_system_network_usage (baru di Bazel 6.0).

Gambar 3. Profil yang menyertakan penggunaan jaringan di seluruh sistem.

Penggunaan jaringan yang tinggi tetapi agak datar saat menggunakan eksekusi jarak jauh dapat menunjukkan bahwa jaringan adalah bottleneck dalam build Anda. Jika Anda belum menggunakannya, pertimbangkan untuk mengaktifkan Build tanpa Byte dengan meneruskan --remote_download_minimal. Tindakan ini akan mempercepat build Anda dengan menghindari download artefak perantara yang tidak diperlukan.

Opsi lainnya adalah mengonfigurasi cache disk lokal untuk menghemat bandwidth download.