Registro

La CLI registra mensajes internamente para ayudarle a diagnosticar problemas.

Diagnosticar problemas utilizando registros

Si la invocación de un comando no produce los resultados esperados, puede diagnosticar el problema inspeccionando los registros. La CLI envía los registros a OSLog y al sistema de archivos.

En cada ejecución, crea un archivo de registro en $XDG_STATE_HOME/tuist/logs/{uuid}.log donde $XDG_STATE_HOME toma el valor ~/.local/state si la variable de entorno no está establecida. También puede utilizar $TUIST_XDG_STATE_HOME para establecer un directorio de estado específico de Tuist, que tiene prioridad sobre $XDG_STATE_HOME.

::: consejo

Obtenga más información sobre la organización de directorios de Tuist y sobre cómo configurar directorios personalizados en la documentación

Directorios.

:::

Por defecto, la CLI muestra la ruta de logs cuando la ejecución finaliza inesperadamente. Si no lo hace, puede encontrar los registros en la ruta mencionada anteriormente (es decir, el archivo de registro más reciente).

::: advertencia

La información sensible no se redacta, así que tenga cuidado al compartir los registros.

:::

Integración continua

En CI, donde los entornos son desechables, es posible que desee configurar su tubería CI para exportar los registros de Tuist. La exportación de artefactos es una capacidad común en todos los servicios de CI, y la configuración depende del servicio que utilices. Por ejemplo, en GitHub Actions, puedes usar la acción actions/upload-artifact para subir los registros como un artefacto:

name: Node CI

on: [push]

env:
  TUIST_XDG_STATE_HOME: /tmp

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
      # ... other steps
      - run: tuist generate
      # ... do something with the project
      - name: Export Tuist logs
        if: failure()
        uses: actions/upload-artifact@v4
        with:
          name: tuist-logs
          path: /tmp/tuist/logs/*.log

Depuración del demonio de caché

Para depurar problemas relacionados con la caché, Tuist registra las operaciones del demonio de caché utilizando os_log con el subsistema dev.tuist.cache. Puede transmitir estos registros en tiempo real utilizando:

log stream --predicate 'subsystem == "dev.tuist.cache"' --debug

Estos registros también son visibles en Console.app filtrando por el subsistema dev.tuist.cache. Esto proporciona información detallada sobre las operaciones de caché, lo que puede ayudar a diagnosticar problemas de carga, descarga y comunicación de la caché.