Monitoring API Gateway

Edit online
Monitoring is an important part of maintaining the reliability, availability, and performance of API Gateway. The API Gateway monitoring service enables you to
  • view the health and performance of the application.
  • discover, analyze, and debug the application issues before they adversely impact the system. This improves business continuity and reduce application downtime.
  • understand the behavior of the application, scale for business volumes, and benefit from the cost optimization.
Through API Gateway monitoring, you can monitor the health and resources of the following API Gateway components:
  • API Gateway Server
  • API Data Store
  • Terracotta Server Array
  • Kibana
You can monitor API Gateway at:
  • Cluster-level
  • Node-level
In a Highly Available (HA) set up, multiple API Gateway instances operate as a cluster. The HA set up ensures that there is no single point of failure in a multiple node deployment such as multiple virtual machines or Kubernetes pods.
  • The cluster-level monitoring ensures service availability, that is, availability of access and functionality (serving API requests) of API Gateway. Service availability must be measured only at the cluster-level, for example, one node down in the cluster does not mean a service outage.
  • The node-level monitoring ensures the ability of a particular instance of API Gateway components to serve the functionality ( API requests) in the node. Node-health must be dealt within isolation by setting up probes per instance of each API Gateway component.