health
Check agent health status
health
Check Arctic agent health status.
Synopsis
arctic health [flags]Description
The health command checks the liveness or readiness of Arctic agents. It does not require authentication.
Flags
| Flag | Description |
|---|---|
--readyz | Check readiness instead of liveness |
Examples
Check Current Context
arctic healthOutput:
Peer ID: peer_01KBYMHC35F0N070F3XXMEZAZR
Name: agent-1
URL: http://192.168.3.251:8080
Status: ok
Timestamp: 2025-12-09 04:43:41 UTCCheck Readiness
arctic health --readyzCheck Specific Agent
arctic health --url http://192.168.1.30:8080JSON Output
Use -j as shorthand for -o json:
arctic health -j{
"peer_id": "peer_01KBYMHC35F0N070F3XXMEZAZR",
"name": "agent-1",
"url": "http://192.168.3.251:8080",
"status": "ok",
"timestamp": "2025-12-09 04:43:41 UTC"
}Exit Codes
The health command uses specific exit codes:
| Code | Condition |
|---|---|
| 0 | Agent healthy |
| 4 | Agent unreachable |
Scripting Example
arctic health
exit_code=$?
case $exit_code in
0)
echo "Agent healthy"
;;
4)
echo "Agent down"
send_alert "Arctic agent unreachable"
;;
*)
echo "Unexpected error: $exit_code"
;;
esacLiveness vs Readiness
Liveness (/livez)
- Default check
- Indicates the agent process is running
- Returns
okif the agent can respond
Readiness (/readyz)
- Use
--readyzflag - Indicates the agent is ready to serve requests
- May return
not readyduring startup or maintenance
Authentication
Health checks do not require authentication. They are designed for use by:
- Load balancers
- Monitoring systems
- Health check scripts
- Kubernetes probes
See Also
- Connectivity Issues - Troubleshooting
- API Health Endpoints