Saltar al contenido principal

Monitoreo y Salud

Comprobación de Salud - /api/health​

  • Endpoint: /api/health

  • Método: GET

  • Descripción: Comprobación de disponibilidad económica para la aplicación y la conexión SQLite. Docker HEALTHCHECK y el bucle de punto de entrada utilizan esta URL en localhost.

  • Respuesta (saludable):

    {
      "status": "healthy",
      "database": "connected",
      "basicConnection": true,
      "initializationStatus": "complete",
      "initializationComplete": true,
      "connectionHealth": true,
      "timestamp": "2024-03-20T10:00:00Z"
    }

  • Respuesta (degradada):

    {
      "status": "degraded",
      "database": "unavailable",
      "basicConnection": false,
      "initializationStatus": "complete",
      "initializationComplete": true,
      "connectionHealth": false,
      "connectionHealthError": "Database connection test failed",
      "timestamp": "2024-03-20T10:00:00Z"
    }

  • Respuesta de Error (503):

    {
      "status": "unhealthy",
      "error": "Database connection failed",
      "message": "Connection timeout",
      "timestamp": "2024-03-20T10:00:00Z"
    }

  • Notas:

    • Devuelve 200 cuando la inicialización se completó y SELECT 1 tiene éxito
    • Devuelve 503 cuando falla la inicialización o la comprobación de conexión
    • No enumera nombres de tablas ni ejecuta consultas de panel
    • Nunca requiere una clave de API
    • Cuando está habilitada alguna lista de IPs permitidas, la IP del cliente debe ser de loopback o estar incluida en la lista de CIDR de administrador o externa (403 IP_NOT_ALLOWED de lo contrario)
    • Los clientes que no son de loopback tienen limitación de frecuencia (429 PROBE_RATE_LIMITED, 30 por minuto y 120 por hora). El loopback (127.0.0.1, ::1) nunca se limita

Sonda de Conectividad - /api/ping​

  • Endpoint: /api/ping

  • Método: GET

  • Descripción: Respuesta { "ok": true } diminuta utilizada por la comprobación de conectividad del panel de control (cada 30 segundos).

  • Respuesta:

    {
      "ok": true
    }

  • Notas:

    • Nunca requiere una clave de API o una cookie de sesión
    • Las mismas reglas de unión de lista de permitidos y loopback que /api/health
    • Los clientes que no son loopback tienen límite de velocidad (429 PROBE_RATE_LIMITED, 60/minuto y 600/hora)