Health Monitoring

GET /health/diagnostic

Detailed diagnostic information with comprehensive health metrics

Provides in-depth diagnostic information including all dependencies, their individual health status, response times, error details, and overall system health assessment, including CloudStack system VMs. Useful for troubleshooting and detailed monitoring.

Status Codes:

  • 200 OK – Comprehensive diagnostic information” example({“service”:”karios-core”,”overall_status”:”WARNING”,”dependencies”:[{“name”:”Management Server”,”status”:”UP”,”latency_ms”:23,”error”:””},{“name”:”PostgreSQL”,”status”:”DOWN”,”latency_ms”:5000,”error”:”connection timeout”,”error_count”:1}]})

Response JSON Object:

  • dependencies[].error (string)

  • dependencies[].error_count (integer)

  • dependencies[].latency_ms (integer)

  • dependencies[].name (string)

  • dependencies[].services[].failed (integer)

  • dependencies[].services[].instances[].container_id (string)

  • dependencies[].services[].instances[].host (string)

  • dependencies[].services[].instances[].name (string)

  • dependencies[].services[].instances[].status (string)

  • dependencies[].services[].running (integer)

  • dependencies[].services[].service_type (string)

  • dependencies[].services[].status (string)

  • dependencies[].services[].total (integer)

  • dependencies[].status (string)

  • dependencies[].summary.failed (integer)

  • dependencies[].summary.running (integer)

  • dependencies[].summary.total (integer)

  • dependencies[].system_vm_summary.non_running (integer)

  • dependencies[].system_vm_summary.running (integer)

  • dependencies[].system_vm_summary.total (integer)

  • dependencies[].system_vms[].agent_state (string)

  • dependencies[].system_vms[].name (string)

  • dependencies[].system_vms[].public_ip (string)

  • dependencies[].system_vms[].state (string) – State is the hypervisor VM state; AgentState is the CloudStack agentstate (control-plane reachability). A system VM is healthy only when BOTH are positive — see common.SystemVMHealthy (the single health authority).

  • dependencies[].system_vms[].zone_name (string)

  • health_percentage (number)

  • healthy_deps (integer)

  • overall_status (string)

  • service (string)

  • timestamp (string)

  • total_deps (integer)

GET /health/healthz

Basic liveness probe for service health monitoring

Performs a simple liveness check to verify that the Karios Core service is running and responsive. This endpoint is typically used by load balancers, monitoring systems, and orchestration platforms for health checks.

Status Codes:

  • 200 OK – Service is alive and responding

Response JSON Object:

  • service (string) – (required)

  • status (string) – (required)

GET /health/readyz

Comprehensive readiness probe with dependency status

Performs a detailed readiness check including all critical dependencies (CloudStack API, MySQL, Console Proxy VM, Secondary Storage VM, InfluxDB, PostgreSQL). Returns overall status based on worst dependency state: DOWN if any dependency is down, WARNING if any dependency has warnings, UP if all are healthy. Always returns HTTP 200 with detailed status information for monitoring systems.

Status Codes:

  • 200 OK – Service readiness status with dependency details

Response JSON Object:

  • dependencies[].error (string)

  • dependencies[].error_count (integer)

  • dependencies[].latency_ms (integer)

  • dependencies[].name (string)

  • dependencies[].services[].failed (integer)

  • dependencies[].services[].instances[].container_id (string)

  • dependencies[].services[].instances[].host (string)

  • dependencies[].services[].instances[].name (string)

  • dependencies[].services[].instances[].status (string)

  • dependencies[].services[].running (integer)

  • dependencies[].services[].service_type (string)

  • dependencies[].services[].status (string)

  • dependencies[].services[].total (integer)

  • dependencies[].status (string)

  • dependencies[].summary.failed (integer)

  • dependencies[].summary.running (integer)

  • dependencies[].summary.total (integer)

  • dependencies[].system_vm_summary.non_running (integer)

  • dependencies[].system_vm_summary.running (integer)

  • dependencies[].system_vm_summary.total (integer)

  • dependencies[].system_vms[].agent_state (string)

  • dependencies[].system_vms[].name (string)

  • dependencies[].system_vms[].public_ip (string)

  • dependencies[].system_vms[].state (string) – State is the hypervisor VM state; AgentState is the CloudStack agentstate (control-plane reachability). A system VM is healthy only when BOTH are positive — see common.SystemVMHealthy (the single health authority).

  • dependencies[].system_vms[].zone_name (string)

  • health_percentage (number)

  • healthy_deps (integer)

  • service (string) – (required)

  • status (string) – (required)

  • timestamp (string)

  • total_deps (integer)