Requirement | Type of Impact | Solution |
For API Gateway, is there an endpoint that returns yes or no about its service availability, that is, readiness for serving the incoming API requests? | Business Impact. To know if there is an outage in API Gateway. | Use Readiness Probe. |
For API Gateway, is there an endpoint that indicates the availability of the administrator user consoles? | Operational Impact. To know if the administrator user console is available. | Use Administration Service Health Probe. |
For API Gateway, is there an endpoint that indicates the cluster health and its details? | Technical Impact. To know the details about where the fault lies when there is a cluster failure. | Use Runtime Service Health Probe. |
Readiness Probe | Runtime Service Health Probe | Administration Service Health Probe | |
What is it? | Indicates if the traffic-serving port of API Gateway is ready to accept requests. | Reports on the overall cluster health and indicates if the components of API Gateway are in an operational state. | Indicates if the API Gateway administrator console is available and accessible. |
When is it used? | To continuously check and report on the service availability of API Gateway. | To continuously report on the cluster health with the details of the components involved in clustering. | To continuously report on the availability of the administrator console and API analytics. |
Response | Description |
200 OK | Readiness check is successful. Readiness probe continues to reply OK if API Gateway remains in an operational state to serve the requests. |
500 Internal server error | Readiness check failed and denotes a problem. |
timeout or no response as the request did not reach the probe | Several factors can contribute to the delay when the Readiness Probe initiates, which may result in the timeout errors. To know the reasons for timeout errors, see
Causes for timeout errors for more information. |
Response | Description |
200 OK | Runtime service health check is successful. |
500 Internal server error | Runtime service health check failed and denotes a problem. The response JSON indicates the problem. |
timeout or no response as the request did not reach the probe | Several factors can contribute to the delay when the Runtime Service Health Probe initiates, which may result in the timeout errors. To know the reasons for timeout errors, see
Causes for timeout errors for more information. |
Status | Description |
green | Indicates that the cluster is in a healthy state. |
yellow | Indicates that API Gateway does not have adequate resources to run. |
red | Indicates the cluster failure and an outage. |
Status | Description |
green | Indicates that API Data Store is in a healthy state. When the status of API Data Store signals green or yellow, the overall status of API Gateway is green. |
red | Indicates cluster failure and an outage. When the status of API Data Store signals red, the overall status of API Gateway is red. |
yellow | Indicates a node failure in the cluster. However, the cluster is still functioning and operational. |
Status | Description |
green | Indicates that API Gateway resource types like memory, disk space, and service threads are available to run. |
yellow | Indicates that API Gateway does not have adequate resources to run. When the API Gateway resource status is yellow, the overall status of API Gateway is yellow. |
Status | Description |
green | Indicates that cluster is in a healthy state. The cluster status is green only when Terracotta Server Array is up and running. When the status of the cluster signals green, the overall status of API Gateway is green. |
red | Indicates cluster failure and an outage. When the status of the cluster signals red, the overall status of API Gateway is red. |
Response | Description |
200 OK | Administration service health check is successful. |
500 Internal server error | Denotes a problem. The response JSON indicates the problem. |
timeout or no response as the request did not reach the probe | Several factors can contribute to the delay when you initiate the Administration Service Health Probe, which may result in the timeout errors. To know the reasons for timeout errors, see
Causes for timeout errors for more information. |
Status | Description |
green | Indicates that Kibana's port is accessible. When the status signals green, the overall status of Administration Service Health Probe is green. |
red | Indicates that either Kibana's port is inaccessible or Kibana's communication with API Data Store is not established. When the status signals red, the overall status of Administration Service Health Probe is red. |
Status | Description |
green | Indicates that API Gateway administration service is available. When the status signals green, the overall status of Administration Service Health Probe is green. |
red | Indicates that API Gateway administration service is not available. When the status signals red, the overall status of Administration Service Health Probe is red. |