Health check /live and /ready

Health check endpoints for monitoring server availability and readiness in containerized environments

Radiator server supports two end points for identifying the ability of the server to process requests. Usually these end points are used in containerized environments as part of container life cycle management.

These are automatically started when management UI is enabled and at the same port as the management UI. The end points do not require any authentication.

  • /live API end point returns 200 (OK) as soon as the software has read in configuration and is able to respond. This will continue to return 200 (OK) even when the software is shutting down.
  • /ready API end point returns 200 (OK) if the software is ready to service requests or configured not to service requests. So if no configuration is set for services, services are disabled by UI or API it will return 200. Otherwise 503 (Service Unavailable) is returned. Usual cause for this is configuration file errors. This state is also used when the software is shutting down (after a kill signal for example). Refer to the log files for detailed information.

Example usage

The Radius server below is live, but unable to server requests. It might be just booting up or broken configuration. It should not need a restart.

% curl -w "%{http_code}\n" http://127.0.0.1:8080/live
200

% curl -w "%{http_code}\n" http://127.0.0.1:8080/ready
503

The port number (8080) is what is configured as your management server address.

Navigation
Home