24.3 Health Check in the Load Balancer
To configure health check in the load balancer, the graph server(PGX) exposes the
isReady
and isRunning
endpoints.
Note:
By default, theisReady
and isRunning
endpoints
are unprotected. See Public Health Endpoint Security to enable protection for the health
check API.
The load balancer can check the following health status of the graph servers:
- Readiness of the graph server: The
isReady
endpoint detects if the graph server (PGX) is capable of handling more requests. See thereadiness_memory_usage_ratio
system parameter in Configuration Parameters for the Graph Server (PGX) Engine for more details. - Liveness of the graph server: The
isRunning
endpoint detects if the graph server (PGX) is running and alive. See therunning_memory_usage_ratio
system parameter in Configuration Parameters for the Graph Server (PGX) Engine for more details.
By default, both the endpoints do not require authentication. If the
server is running or ready, they return true
in the HTTP body with
HTTP
status code 200
. If the server is
not running or ready, they return false
with
HTTP
status code 503
.
Parent topic: Deploying Oracle Graph Server Behind a Load Balancer