Running devices-service health checks
Learn how to run devices-service 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.
devices-service
Send a request to the /status endpoint of devices-service. Use the service name and port configured
for your deployment.
curl -v http://devices-service-host:8090/status
The response can be either 200 OK if all services are up:
{
"deviceStorage":"UP"
}
or 503 Service Unavailable if one or more services are down:
{
"deviceStorage":"DOWN"
}
All of the following components are checked by default:
| Component | Description |
|---|---|
| deviceStorage | Data store holding device data |
You can disable the health check on any components from the above list. For more information, read Configuring health checks for devices-service.