Tips praktis flag Bazel

Melaporkan masalah Lihat sumber

Nightly · 9.1 · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 8.1

Menavigasi daftar flag command line Bazel yang luas bisa menjadi tantangan. Halaman ini berfokus pada flag paling penting yang perlu Anda ketahui.

Tips: Pilih nama flag dalam tabel untuk membuka entri di referensi command line.

Opsi umum yang berguna

Flag berikut dimaksudkan untuk ditetapkan secara eksplisit di command line.

Bendera	Deskripsi
--config	Anda dapat mengatur flag dalam file .bazelrc ke dalam konfigurasi, seperti untuk proses debug atau build rilis. Grup konfigurasi tambahan dapat dipilih dengan --config=<group>.
--keep_going	Bazel harus mencoba semaksimal mungkin untuk melanjutkan eksekusi build dan pengujian. Secara default, Bazel akan gagal dengan cepat.
--remote_download_outputs	Saat menggunakan eksekusi atau caching jarak jauh (baik disk maupun jarak jauh), Anda dapat memberi sinyal kepada Bazel bahwa Anda ingin mendownload semua artefak build (perantara) sebagai berikut: --remote_download_outputs=all Secara default, Bazel hanya mendownload artefak tingkat atas, seperti biner akhir, dan artefak perantara yang diperlukan untuk tindakan lokal.
--stamp	Menambahkan info build (pengguna, stempel waktu) ke biner. Catatan: Karena hal ini meningkatkan waktu build, hal ini hanya ditujukan untuk build rilis.

Mengungkap Masalah Build &Pengujian

Flag berikut dapat membantu Anda memahami error build atau pengujian Bazel dengan lebih baik.

Bendera	Deskripsi
--announce_rc	Menampilkan flag yang ditetapkan secara implisit melalui file .bazelrc yang ditentukan pengguna, ditentukan mesin, atau ditentukan project.
--auto_output_filter	Secara default, Bazel mencoba mencegah spam log dan hanya mencetak peringatan compiler dan output debug Starlark untuk paket dan subpaket yang diminta di command line. Untuk menonaktifkan semua pemfilteran, tetapkan --auto_output_filter=none.
--sandbox_debug	Memungkinkan Anda mempelajari error sandbox. Untuk mengetahui detail alasan Bazel melakukan sandbox build secara default dan apa yang di-sandbox, lihat dokumentasi sandbox kami. Tips: Jika Anda merasa error mungkin disebabkan oleh sandbox, coba nonaktifkan sandbox untuk sementara. Untuk melakukannya, tambahkan --spawn_strategy=standalone ke perintah Anda.
--subcommands (-s)	Menampilkan daftar lengkap setiap perintah yang dijalankan Bazel selama build, terlepas dari apakah berhasil atau gagal

Startup

Perhatian: Flag startup harus diteruskan sebelum perintah dan menyebabkan server dimulai ulang. Aktifkan/nonaktifkan flag ini dengan hati-hati.

Bendera	Deskripsi
--bazelrc	Anda dapat menentukan opsi Bazel default dalam file .bazelrc. Jika ada beberapa file .bazelrc, Anda dapat memilih file .bazelrc yang akan digunakan dengan menambahkan --bazelrc=<path to the .bazelrc file>. Tips: --bazelrc=dev/null menonaktifkan penelusuran file .bazelrc. Hal ini ideal untuk skenario saat Anda ingin memastikan lingkungan build yang bersih, seperti build rilis, dan mencegah perubahan konfigurasi yang tidak diinginkan dari file .bazelrc
--host_jvm_args	Membatasi jumlah RAM yang digunakan server Bazel. Misalnya, berikut ini membatasi ukuran heap Bazel ke 3GB: --host_jvm_args=-Xmx3g Catatan: -Xmx digunakan untuk menetapkan ukuran heap maksimum untuk Java Virtual Machine (JVM). Heap adalah area memori tempat objek dialokasikan. Format yang benar untuk opsi ini adalah -Xmx<size> , dengan <size> adalah ukuran heap maksimum, yang ditentukan dengan unit seperti: m untuk megabyte g untuk gigabyte k untuk kilobyte
--output_base	Mengontrol hierarki output Bazel. Bazel tidak menyimpan output build, termasuk log, dalam hierarki sumber itu sendiri. Sebagai gantinya, Bazel menggunakan hierarki output yang berbeda untuk tujuan ini. Tips: Menggunakan beberapa basis output dalam satu ruang kerja Bazel memungkinkan Anda menjalankan beberapa server Bazel secara serentak. Hal ini dapat berguna saat mencoba menghindari thrashing analisis. Untuk mengetahui informasi selengkapnya, lihat Memilih basis output.

Pengujian Bazel

Flag berikut terkait dengan pengujian Bazel

Bendera	Deskripsi
--java_debug	Menyebabkan pengujian Java menunggu koneksi debugger sebelum dieksekusi.
--runs_per_test	Jumlah pengujian yang akan dijalankan. Misalnya, untuk menjalankan pengujian N kali, tambahkan --runs_per_test=N. Hal ini dapat berguna untuk men-debug pengujian yang tidak stabil dan melihat apakah perbaikan menyebabkan pengujian lulus secara konsisten.
--test_output	Menentukan mode output. Secara default, Bazel menangkap output pengujian dalam file log lokal. Saat melakukan iterasi pada pengujian yang rusak, biasanya Anda ingin menggunakan --test_output=streamed untuk melihat output pengujian secara real time.

Bazel run

Flag berikut terkait dengan Bazel run.

Bendera	Deskripsi
--run_under	Mengubah cara pemanggilan file yang dapat dieksekusi. Misalnya, --run_under="strace -c" adalah biasanya digunakan untuk proses debug.

Opsi bazelrc khusus pengguna

Flag berikut terkait dengan opsi .bazelrc khusus pengguna.

Bendera	Deskripsi
--disk_cache	Jalur ke direktori tempat Bazel dapat membaca dan menulis tindakan serta output tindakan. Jika direktori tidak ada, direktori akan dibuat. Anda dapat membagikan artefak build di antara beberapa cabang atau ruang kerja dan mempercepat build Bazel dengan menambahkan --disk_cache=<path> ke perintah Anda.
--jobs	Jumlah tugas serentak yang akan dijalankan. Hal ini biasanya hanya diperlukan saat menggunakan eksekusi jarak jauh ketika cluster build jarak jauh menjalankan lebih banyak tugas daripada core yang Anda miliki secara lokal.
--local_resources	Membatasi jumlah CPU atau RAM yang digunakan oleh tindakan yang berjalan secara lokal. Catatan: Hal ini tidak memengaruhi jumlah CPU atau RAM yang digunakan oleh server Bazel itu sendiri untuk tugas seperti analisis dan orkestrasi build.
--sandbox_base	Memungkinkan sandbox membuat direktori sandbox di bawah jalur ini. Secara default, Bazel menjalankan tindakan lokal yang di-sandbox yang menambahkan overhead ke build. Tips: Tentukan jalur di tmpfs, misalnya /run/shm, untuk kemungkinan meningkatkan performa secara signifikan saat build atau pengujian Anda memiliki banyak file input.

Opsi bazelrc khusus project

Flag berikut terkait dengan opsi .bazelrc khusus project.

Bendera	Deskripsi
--flaky_test_attempts	Coba lagi setiap pengujian hingga jumlah yang ditentukan jika terjadi kegagalan pengujian. Hal ini sangat berguna di Continuous Integration. Pengujian yang memerlukan lebih dari satu upaya untuk lulus ditandai sebagai FLAKY dalam ringkasan pengujian.
--remote_cache	URI endpoint caching. Menyiapkan caching jarak jauh dapat menjadi cara yang bagus untuk mempercepat build Bazel. Hal ini dapat digabungkan dengan cache disk lokal.
--remote_download_regex	Memaksa output build jarak jauh yang jalurnya cocok dengan pola ini untuk didownload, terlepas dari setelan --remote_download_outputs. Beberapa pola dapat ditentukan dengan mengulangi flag ini.
--remote_executor	HOST atau HOST:PORT endpoint eksekusi jarak jauh. Teruskan hal ini jika Anda menggunakan layanan eksekusi jarak jauh. Anda sering kali perlu Menambahkan --remote_instance_name=<name>.
--remote_instance_name	Nilai yang akan diteruskan sebagai instance_name di API eksekusi jarak jauh.
--show-timestamps	Jika ditentukan, stempel waktu akan ditambahkan ke setiap pesan yang dihasilkan oleh Bazel yang menentukan waktu pesan ditampilkan. Hal ini berguna pada sistem CI untuk memahami dengan cepat langkah mana yang memerlukan waktu berapa lama.
--spawn_strategy	Bahkan dengan eksekusi jarak jauh, menjalankan beberapa tindakan build secara lokal mungkin lebih cepat. Hal ini bergantung pada faktor-faktor seperti kapasitas cluster build, kecepatan jaringan, dan penundaan jaringan. Tips: Untuk menjalankan tindakan secara lokal dan jarak jauh serta menerima hasil yang lebih cepat, tambahkan --spawn_strategy=dynamic ke perintah build Anda.