Home > Tutorials > Run iam-services health checks

Running iam-services health checks

Learn how to run iam-services 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.

iam-services

Send a request to the /status endpoint of iam-services. Use the service name and port configured for your deployment.

curl -v http://iam-services-host:7900/status

The response can be either 200 OK if all services are up:

{
    "userStorage": "UP",
    "sessionStorage": "UP",
    "kafka": "UP",
    "acp": "UP",
    "deviceService": "UP",
    "permissionService": "UP"
}

or 503 Service Unavailable if one or more services are down:

{
    "userStorage": "UP",
    "sessionStorage": "UP",
    "kafka": "UP",
    "acp": "UP",
    "deviceService": "DOWN",
    "permissionService": "UP"
}

All of the following components are checked by default:

Component Description
userStorage Data store holding user data.
sessionStorage Data store holding session information.
kafka Kafka message broker used by the service
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 iam-services configuration otherwise.
deviceService Service used to track and store device information.

You can disable the health check on any components from the above list. For more information, read Configuring health checks for iam-services.