Running api-gateway health checks
Learn how to run api-gateway health checks in Cloud Identity Plane (CIP). This document describes internal service APIs intended to be used by developers, for example, to write a monitoring script that reports the system status.
Prerequisites
-
CIP is up and running.
-
Access to service configuration data (for example a docker-compose file) or information about the service domain from other sources.
api-gateway
Send a request to the /status endpoint of api-gateway. Use the service name and port configured
for your deployment.
curl -v http://api-gateway-host:4050/status
The response can be either 200 OK if all services are up:
{
"kafka": "UP",
"hazelcast": "UP",
"acp": "UP",
"customerService": "UP",
"authz": "UP"
}
or 503 Service Unavailable if one or more services are down:
{
"kafka": "UP",
"hazelcast": "UP",
"acp": "DOWN",
"customerService": "UP",
"authz": "UP"
}
All of the following components are checked by default:
| Component | Description |
|---|---|
| kafka | Kafka message broker used by the service |
| hazelcast | Storage for token information, authentication and authorization sessions, authentication events shared data caches, and more |
| acp | Checks if ACP is alive. This check should only be used when CIP is used as an ACP component. Disable this check in your api-gateway configuration otherwise. |
| customerService | Service used to track and store information regarding organizations |
| authz | Service used to track and store authorization information |
You can disable the health check on any components from the above list. For more information, read Configuring health checks for api-gateway.