Bazel es complejo y realiza muchas tareas diferentes durante la compilación, algunas de las cuales pueden afectar el rendimiento de la compilación. En esta página, se intenta asignar algunos de estos conceptos de Bazel a sus implicaciones en el rendimiento de la compilación. Si bien no son exhaustivos, incluimos algunos ejemplos de cómo detectar problemas de rendimiento de compilación mediante la extracción de métricas y lo que puedes hacer para corregirlos. De esta manera, esperamos que puedas aplicar estos conceptos cuando investigues las regresiones de rendimiento de la compilación.
Compilaciones incrementales y limpias
Una compilación limpia es aquella que compila todo desde cero, mientras que una compilación incremental reutiliza un trabajo ya completado.
Te sugerimos que observes las compilaciones incrementales y limpias por separado, en especial cuando recopilas o agregas métricas que dependen del estado de las cachés de Bazel (por ejemplo, las métricas de tamaño de la solicitud de compilación). También representan dos experiencias del usuario diferentes. En comparación con iniciar una compilación limpia desde cero (que tarda más debido a una caché fría), las compilaciones incrementales ocurren con mucha más frecuencia a medida que los desarrolladores iteran en el código (por lo general, más rápido, debido a que la caché ya suele estar caliente).
Puedes usar el campo CumulativeMetrics.num_analyses en la BEP para clasificar compilaciones. Si es num_analyses <= 1, es una compilación limpia; de lo contrario, podemos categorizarla en términos generales como una compilación incremental. El usuario podría haber cambiado a diferentes marcas o a diferentes destinos, lo que provoca una compilación limpia de forma efectiva. Es probable que cualquier definición más rigurosa de incrementalidad deba presentarse en forma de heurística, por ejemplo, si se observa la cantidad de paquetes cargados (PackageMetrics.packages_loaded).
Métricas de compilación deterministas como proxy para el rendimiento de la compilación
Medir el rendimiento de la compilación puede ser difícil debido a la naturaleza no determinista de ciertas métricas (por ejemplo, el tiempo de CPU de Bazel o los tiempos de cola en un clúster remoto). Por lo tanto, puede ser útil usar métricas deterministas como un proxy para la cantidad de trabajo que realiza Bazel, lo que, a su vez, afecta su rendimiento.
El tamaño de una solicitud de compilación puede tener una implicación significativa en el rendimiento de la compilación. Una compilación más grande podría representar más trabajo de análisis y construcción de los gráficos de compilación. El crecimiento orgánico de las compilaciones es natural con el desarrollo, a medida que se agregan o crean más dependencias y, por lo tanto, aumenta su complejidad y se vuelve más costoso de compilar.
Podemos dividir este problema en las distintas fases de compilación y usar las siguientes métricas como métricas de proxy para el trabajo realizado en cada fase:
PackageMetrics.packages_loaded: Es la cantidad de paquetes cargados correctamente. Aquí, una regresión representa más trabajo que se debe realizar para leer y analizar cada archivo BUILD adicional en la fase de carga.TargetMetrics.targets_configured: Representa la cantidad de destinos y aspectos configurados en la compilación. Una regresión representa más trabajo para construir y recorrer el grafo de destino configurado.- A menudo, esto se debe a la adición de dependencias y a la necesidad de construir el grafo de su cierre transitivo.
- Usa cquery para encontrar dónde se podrían haber agregado las dependencias nuevas.
ActionSummary.actions_created: Representa las acciones creadas en la compilación, y una regresión representa más trabajo para construir el gráfico de acción. Ten en cuenta que esto también incluye las acciones sin usar que podrían no haberse ejecutado.- Usa aquery para depurar regresiones. Te sugerimos que comiences con
--output=summaryantes de desglosarla aún más con--skyframe_state.
- Usa aquery para depurar regresiones. Te sugerimos que comiences con
ActionSummary.actions_executed: Es la cantidad de acciones ejecutadas; una regresión representa directamente más trabajo en la ejecución de estas acciones.- La BEP escribe las estadísticas de acción
ActionDataque muestran los tipos de acciones más ejecutadas. De forma predeterminada, recopila los 20 tipos de acciones principales, pero puedes pasar la--experimental_record_metrics_for_all_mnemonicspara recopilar estos datos de todos los tipos de acciones que se ejecutaron. - Esto debería ayudarte a descubrir qué tipo de acciones se ejecutaron (además).
- La BEP escribe las estadísticas de acción
BuildGraphSummary.outputArtifactCount: Es la cantidad de artefactos creados por las acciones ejecutadas.- Si la cantidad de acciones ejecutadas no aumentó, es probable que se haya cambiado la implementación de una regla.
Todas estas métricas se ven afectadas por el estado de la caché local, por lo que deberás asegurarte de que las compilaciones de las que extraigas estas métricas sean compilaciones limpias.
Detectamos que una regresión en cualquiera de estas métricas puede estar acompañada de regresiones en el tiempo, el tiempo de CPU y el uso de memoria.
Uso de recursos locales
Bazel consume una variedad de recursos en tu máquina local (tanto para analizar el gráfico de compilación y controlar la ejecución, como para ejecutar acciones locales). Esto puede afectar el rendimiento o la disponibilidad de la máquina para realizar la compilación y también otras tareas.
Tiempo transcurrido
Quizás las métricas más susceptibles al ruido (y pueden variar mucho de una compilación a otra) sean el tiempo; en particular, el tiempo real, el tiempo de CPU y el tiempo del sistema. Puedes usar bazel-bench a fin de obtener comparativas para estas métricas y, con una cantidad suficiente de --runs, puedes aumentar la importancia estadística de tu medición.
El tiempo de pared es el tiempo real transcurrido.
- Si solo el tiempo se regresa, sugerimos recopilar un perfil de registro de JSON y buscar diferencias. De lo contrario, es probable que sea más eficiente investigar otras métricas con regresión, ya que podrían haber afectado el tiempo.
El tiempo de CPU es el tiempo que dedica la CPU a ejecutar el código de usuario.
- Si el tiempo de CPU se revierte en dos confirmaciones de proyecto, sugerimos recopilar un perfil de CPU de Starlark. Es probable que también debas usar
--nobuildpara restringir la compilación a la fase de análisis, ya que allí es donde se realiza la mayor parte del trabajo pesado de la CPU.
- Si el tiempo de CPU se revierte en dos confirmaciones de proyecto, sugerimos recopilar un perfil de CPU de Starlark. Es probable que también debas usar
El tiempo del sistema es el tiempo que emplea la CPU en el kernel.
- Si la hora del sistema se regresa, en su mayoría se correlaciona con la E/S cuando Bazel lee los archivos del sistema.
Creación de perfiles de carga en todo el sistema
Con la marca --experimental_collect_load_average_in_profiler que se introdujo en Bazel 6.0, el generador de perfiles de seguimiento de JSON recopila el promedio de carga del sistema durante la invocación.
Figura 1: Perfil que incluye el promedio de carga del sistema.
Una carga alta durante una invocación de Bazel puede ser un indicador de que Bazel programa
demasiadas acciones locales en paralelo para tu máquina. Se recomienda que ajustes --local_cpu_resources y --local_ram_resources, en especial en entornos de contenedores (al menos hasta que se combine #16512).
Supervisa el uso de memoria de Bazel
Existen dos fuentes principales para obtener el uso de memoria de Bazel: info de Bazel y la BEP.
bazel info used-heap-size-after-gc: Es la cantidad de memoria usada en bytes después de una llamada aSystem.gc().- La base de Bazel también proporciona comparativas para esta métrica.
- Además, existen
peak-heap-size,max-heap-size,used-heap-sizeycommitted-heap-size(consulta la documentación), pero son menos relevantes.
MemoryMetrics.peak_post_gc_heap_sizede BEP: tamaño del tamaño máximo del montón de JVM en bytes posteriores a la recolección (requiere la configuración--memory_profileque intenta forzar una recolección completa).
Una regresión en el uso de memoria suele ser el resultado de una regresión en las métricas de tamaño de la solicitud de compilación, que a menudo se debe a la adición de dependencias o a un cambio en la implementación de la regla.
Para analizar la huella de memoria de Bazel en un nivel más detallado, te recomendamos que uses el generador de perfiles de memoria integrado para las reglas.
Generación de perfiles de memoria de trabajadores persistentes
Si bien los trabajadores persistentes pueden ayudar a acelerar las compilaciones de manera significativa (en especial para los lenguajes interpretados), su huella de memoria puede ser problemática. Bazel recopila métricas sobre sus trabajadores, en particular, el campo
WorkerMetrics.WorkerStats.worker_memory_in_kb indica cuánta memoria usan los trabajadores de memoria (por mnemotecnia).
El generador de perfiles de seguimiento de JSON también
recopila el uso de memoria persistente del trabajador durante la invocación mediante la marca
--experimental_collect_system_network_usage (nueva en Bazel 6.0).
Figura 2: Perfil que incluye el uso de memoria de los trabajadores.
Disminuir el valor de --worker_max_instances (valor predeterminado 4) podría ayudar a reducir la cantidad de memoria que usan los trabajadores persistentes. Estamos trabajando de forma activa para
hacer que el administrador de recursos y el programador de Bazel sea más inteligente, de modo que esos ajustes
se requieran con menos frecuencia en el futuro.
Supervisa el tráfico de red para compilaciones remotas
En la ejecución remota, Bazel descarga artefactos que se compilaron como resultado de la ejecución de acciones. Por lo tanto, el ancho de banda de tu red puede afectar el rendimiento de tu compilación.
Si usas la ejecución remota para tus compilaciones, te recomendamos que consideres supervisar el tráfico de red durante la invocación mediante el protocolo NetworkMetrics.SystemNetworkStats de la BEP (requiere pasar --experimental_collect_system_network_usage).
Además, los perfiles de registro JSON te permiten ver el uso de la red en todo el sistema durante la compilación mediante el paso de la marca --experimental_collect_system_network_usage (nueva en Bazel 6.0).
Figura 3: Perfil que incluye el uso de la red en todo el sistema.
Un uso de red alto, pero bastante plano, cuando se utiliza la ejecución remota, puede indicar que la red es el cuello de botella en tu compilación. Si aún no la usas, considera activar la compilación sin los bytes pasando --remote_download_minimal.
Esto acelerará las compilaciones, ya que evitará la descarga de artefactos intermedios innecesarios.
Otra opción es configurar una caché de disco local para ahorrar ancho de banda de descargas.