Ruta de healthcheck

Una ruta de healthcheck permite a la plataforma verificar periódicamente que su aplicación se está ejecutando y funciona correctamente.

Por defecto, si no se habilita ningún health check, la plataforma realiza solo una comprobación básica después del despliegue: se asegura de que el contenedor de la aplicación se haya iniciado correctamente. En este caso, no se evalúa el estado real de la aplicación: la app puede estar respondiendo incorrectamente o no responder en absoluto, y aun así el despliegue se marcará como exitoso.

Para evitar esto, puede configurar una ruta de health check. Su aplicación debe exponer un endpoint que no dependa de sistemas externos (como una base de datos o servicios de terceros) y que refleje con precisión el estado interno de la aplicación.

Puede especificar este endpoint durante la configuración: por ejemplo, /health, /status o /ping.

Por defecto, durante el despliegue el sistema solo comprueba la URL raíz (/). Envía una solicitud a la página principal, y si el estado de la respuesta no está en el rango 2xx, el despliegue se considera fallido.

Cómo funcionan los healthchecks

Las solicitudes de healthcheck siempre se realizan desde localhost.

El único requisito es que el endpoint devuelva un código de estado 2xx. El cuerpo de la respuesta no importa; solo importa el código de estado.

Durante un redeploy

Si se configura una ruta de healthcheck, el sistema envía hasta tres solicitudes GET consecutivas a la nueva instancia de la aplicación.

• Si al menos una solicitud devuelve un código de estado 2xx, el despliegue se considera exitoso y la nueva versión se activa.

• Si los tres intentos fallan (cualquier código distinto de 2xx), el despliegue se marca como fallido y la versión anterior permanece activa.

Las comprobaciones continúan hasta que se cumpla una de las siguientes condiciones:

• una única respuesta exitosa,

• tres respuestas fallidas consecutivas, siendo la última 40 segundos después del inicio,

• o que transcurran 180 segundos; si nada de lo anterior ocurre dentro de ese tiempo, el despliegue se considera fallido.

Si la comprobación falla, aparecerá un mensaje de error de healthcheck en los logs de despliegue.

Después del inicio

Una vez que un despliegue tiene éxito, el sistema continúa comprobando el estado de la aplicación con una solicitud cada 30 segundos.

Si tres comprobaciones consecutivas fallan, la aplicación se reinicia automáticamente. Este evento aparecerá en los logs de la aplicación.

Configuración de una ruta de healthcheck

Puede configurar una ruta de healthcheck al crear una nueva aplicación o más tarde para una existente.

Al crear una aplicación

En la sección App settings, introduzca la ruta deseada en el campo Health Check path.

Por ejemplo, si su aplicación ofrece un endpoint /health accesible en https://domain/health, establezca:

/health

Para una aplicación existente

1. Abra la aplicación en el panel de control.

2. Vaya a la pestaña Settings.

3. En la sección Deploy settings, haga clic en Edit.

4. Introduzca la ruta de healthcheck.

5. Haga clic en Save Data.

Se iniciará automáticamente un nuevo despliegue con la configuración actualizada.

Docker y Docker Compose

Despliegues con Dockerfile

Si su aplicación se despliega mediante un Dockerfile, aún puede configurar la ruta de healthcheck en el panel de control.

Sin embargo, si el Dockerfile incluye una instrucción HEALTHCHECK, esta tiene prioridad y la configuración del panel de control se ignora.

Ejemplo:

HEALTHCHECK --interval=30s --timeout=10s --retries=3 \
  CMD curl -f http://localhost/health || exit 1

Para más detalles, consulte la documentación oficial de Docker.

Despliegues con Docker Compose

Para despliegues con Docker Compose, no se admite la configuración de la ruta de healthcheck en el panel de control.

Si sus servicios utilizan un Dockerfile, puede configurar HEALTHCHECK directamente en él; se comportará como se describe anteriormente.