Container Metrics
If you have installed API Gateway through Docker or Kubernetes, Software AG recommends monitoring the following metrics to check if the container is healthy. When the metrics exceed the threshold value, consider the severity as mentioned and perform the possible actions that Software AG recommends to identify, analyze, and debug the problem.
Metric | Description |
---|---|
PodNotReady | If the status of the pod is not ready for more than 10 minutes, consider the severity as CRITICAL. |
PodRestarting | If the application inside the pod is not up in 1 minute, consider the severity as CRITICAL. |
PodCrashLooping | If
API Gateway
pod is restarting continuously for
15 minutes, consider the
severity as
CRITICAL.
Perform the following actions to identify the problem when all the three events occur:
|
NodeNotReady | If the status of the new node is
not ready in Kubernetes cluster
for more than
15 minutes, consider the
severity as
CRITICAL.
Perform the following actions to identify the problem:
|
DeploymentReplicas​Mismatch | If there is any mismatch with the replicas,
that is, if the pods replicas count does not match with the pods that are in a
ready state for more than
10 minutes, consider the
severity as
CRITICAL.
Perform the following actions to identify the problem:
|
Additionally, for any reason, if a pod restarts, perform the following steps to verify the health of the new pod.
- Check for the readiness of the pod.
- Check the cluster status of API Gateway using the following REST endpoint: GET /rest/apigateway/health/engine to know if API Gateway and its components are healthy and are in a cluster mode.
- Check the possible cause for the pod restart, if it is due to the pod reallocation, node auto scaling and so on.
- Check the previous logs of the pod for any exception.
- Check the pod events to find the reason for the restart.
- Check the Terracotta client logs for errors in Terracotta communication, if the tenant is in cluster mode.
Analyze Trend
You can use external tools for dashboarding operations and visualizing metrics and logs.