phenix healthcheck¶
Every command on this page also accepts the global flags.
phenix healthcheck¶
Check the health of the phenix UI server
Synopsis¶
Check the health of the phenix UI server
Requests the server's liveness endpoint (/healthz), or with --ready its
readiness endpoint (/readyz), and exits 0 when it answers 200 and 1
otherwise. The URL comes from ui.listen-endpoint and ui.tls-key/tls-cert
(the config file or PHENIX_UI_* environment variables), with a wildcard
host replaced by loopback; --url overrides it. Flags given only on the
phenix ui command line are not seen here: pass --url, or set
PHENIX_UI_LISTEN_ENDPOINT, PHENIX_UI_TLS_KEY and PHENIX_UI_TLS_CERT.
Unlike other subcommands, healthcheck opens no store, unix socket or log
file, so it is cheap enough for a container health check.
Examples¶
# Liveness, as the Docker and Podman health checks run it
phenix healthcheck
# Readiness (minimega, store, disk space, ...), with every check
phenix healthcheck --ready -o json
# A server listening elsewhere
phenix healthcheck --url https://phenix.example.com/readyz
Options¶
-h, --help help for healthcheck
-o, --output string Output format (text, json) (default "text")
--ready check readiness (/readyz) rather than liveness (/healthz)
--timeout duration how long to wait for an answer (default 5s)
--url string URL to check, instead of the one derived from the UI settings
SEE ALSO¶
- phenix - A cli application for phēnix