Depuración de hits de caché remota para ejecución remota

7.3 · 7.2 · 7.1 · 7.0 · 6.5

En esta página, se describe cómo verificar el porcentaje de aciertos de la caché y cómo investigar los errores de caché en el contexto de la ejecución remota.

En esta página, se da por sentado que tienes una compilación o prueba que usa de forma correcta la ejecución remota y que quieres asegurarte de que estás usando la caché remota de manera eficaz.

Verifica la tasa de aciertos de caché

En el resultado estándar de la ejecución de Bazel, observa la línea INFO que enumera los procesos, que corresponden aproximadamente a las acciones de Bazel. Esa línea detalla dónde se ejecutó la acción. Busca la etiqueta remote, que indica una acción ejecutada de forma remota, linux-sandbox para las acciones ejecutadas en una zona de pruebas local y otros valores para otras estrategias de ejecución. Una acción cuyo resultado provino de una caché remota se muestra como remote cache hit.

Por ejemplo:

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

En este ejemplo, hubo 6 aciertos de caché remota y 2 acciones no tenían aciertos de caché y se ejecutaron de forma remota. Se puede ignorar la 3ª parte interna. Por lo general, se trata de acciones internas muy pequeñas, como la creación de vínculos simbólicos. Los aciertos de caché local no se incluyen en este resumen. Si no obtienes ningún proceso (o un número inferior al esperado), ejecuta bazel clean seguido del comando de compilación o prueba.

Solución de problemas de aciertos de caché

Si no obtienes la tasa de aciertos de caché que esperabas, haz lo siguiente:

Asegúrate de volver a ejecutar el mismo comando de compilación o prueba que produzca aciertos de caché

Ejecuta las compilaciones o pruebas que esperas que propaguen la caché. La primera vez que se ejecuta una compilación nueva en una pila en particular, no se esperan aciertos de caché remota. Como parte de la ejecución remota, los resultados de las acciones se almacenan en la caché, y una ejecución posterior debería recuperarlos.
Ejecuta bazel clean. Este comando limpia tu caché local, lo que te permite investigar los aciertos de caché remota sin que los resultados se enmasquen por los aciertos de caché local.
Vuelve a ejecutar las compilaciones y las pruebas que estés investigando (en la misma máquina).
Revisa la línea INFO para ver la tasa de aciertos de caché. Si no ves ningún proceso, excepto remote cache hit y internal, significa que se está completando y accediendo a la caché correctamente. En ese caso, ve a la siguiente sección.
Una posible fuente de discrepancia es algo no hermético en la compilación que hace que las acciones reciban claves de acción diferentes en las dos ejecuciones. Para encontrar esas acciones, haz lo siguiente:

a. Vuelve a ejecutar las compilaciones o pruebas en cuestión para obtener registros de ejecución:
```
  bazel clean
  bazel --optional-flags build //your:target --execution_log_binary_file=/tmp/exec1.log
```
b. Compara los registros de ejecución entre las dos ejecuciones. Asegúrate de que las acciones sean idénticas en los dos archivos de registro. Las discrepancias proporcionan una pista sobre los cambios que ocurrieron entre las ejecuciones. Actualiza tu compilación para eliminar esas discrepancias.

Si puedes resolver los problemas de almacenamiento en caché y la ejecución repetida produce todos los hits de caché, ve a la siguiente sección.

Si tus IDs de acción son idénticos, pero no hay aciertos de caché, entonces algún elemento de tu configuración impide el almacenamiento en caché. Continúa con esta sección para verificar si hay problemas comunes.

Si no necesitas comparar los registros de ejecución, puedes usar la marca --execution_log_json_file legible por humanos. No se puede usar para diffing estable, ya que contiene tiempo de ejecución y no garantiza un orden.
Verifica que todas las acciones del registro de ejecución tengan cacheable establecido como verdadero. Si cacheable no aparece en el registro de ejecución de una acción determinada, significa que la regla correspondiente puede tener una etiqueta no-cache en su definición en el archivo BUILD. Observa el campo progress_message legible por humanos en el registro de ejecución para determinar de dónde proviene la acción.
Si las acciones son idénticas y cacheable, pero no hay aciertos de caché, es posible que tu línea de comandos incluya --noremote_accept_cached, lo que inhabilitaría las búsquedas en caché para una compilación.

Si es difícil determinar la línea de comandos real, usa la línea de comandos canónica del Protocolo de eventos de compilación de la siguiente manera:

a. Agrega --build_event_text_file=/tmp/bep.txt a tu comando de Bazel para obtener la versión de texto del registro.

b. Abre la versión de texto del registro y busca el mensaje structured_command_line con command_line_label: "canonical". Se mostrarán todas las opciones después de la expansión.

c. Busca remote_accept_cached y verifica si está configurado como false.

d. Si remote_accept_cached es false, determina dónde se configura como false, ya sea en la línea de comandos o en un archivo bazelrc.

Garantizar el almacenamiento en caché en las máquinas

Después de que los aciertos de caché ocurran como se espera en la misma máquina, ejecuta las mismas compilaciones o pruebas en otra máquina. Si sospechas que la caché no se está realizando en todas las máquinas, haz lo siguiente:

Haz una pequeña modificación en tu compilación para evitar que se carguen las cachés existentes.

Ejecuta la compilación en la primera máquina:

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

Ejecuta la compilación en la segunda máquina y asegúrate de que se incluya la modificación del paso 1:
```
 bazel clean
 bazel ... build ... --execution_log_binary_file=/tmp/exec2.log
```
Compara los registros de ejecución de las dos ejecuciones. Si los registros no son idénticos, investiga tus configuraciones de compilación en busca de discrepancias, así como propiedades del entorno del host que se filtren en cualquiera de las compilaciones.

Compara los registros de ejecución

Los registros de ejecución contienen registros de todas las acciones ejecutadas durante la compilación. Para cada acción hay un elemento SpawnExec que contiene toda la información de la clave de acción. Por lo tanto, si los registros son idénticos, entonces también lo son las claves de caché de acciones.

Para comparar los registros de dos compilaciones que no comparten los aciertos de caché como se espera, haz lo siguiente:

Obtén los registros de ejecución de cada compilación y almacénalos como /tmp/exec1.log y /tmp/exec2.log.
Descarga el código fuente de Bazel y navega a la carpeta de Bazel con el siguiente comando. Necesitas el código fuente para analizar los registros de ejecución con el analizador de execlog.
```
git clone https://github.com/bazelbuild/bazel.git
cd bazel
```
Usa el analizador de registros de ejecución para convertir los registros en texto. La siguiente invocación también ordena las acciones en el segundo registro para que coincidan con el orden de acciones en el primer registro y facilitar la comparación.
```
bazel build src/tools/execlog:parser
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
```
Usa la diferencia de texto que prefieras para diferenciar /tmp/exec1.log.txt y /tmp/exec2.log.txt.