Skip to main content

Version: 3.2.16.3

Monitor API Metrics

API7 Gateway supports exposing a comprehensive set of metrics to the monitoring system with minimal delay, facilitating ongoing monitoring and diagnostics.

API7 Gateway's monitoring and alerting framework is built on Prometheus, a widely used system monitoring and alerting toolkit. Prometheus gathers and stores multidimensional time series data, including metrics annotated with key-value labels.

This guide explains how to enable the Prometheus plugin to integrate with the monitoring system, allowing you to collect and visualize HTTP metrics.

Prerequisites

  1. Install API7 Enterprise.
  2. Have a running API on the gateway group.

Monitor All Services

It is recommended to enable the prometheus plugin as a global rule. This ensures that all services and routes are consistently monitored and tracked.

  1. Select Plugin Settings of your gateway group from the side navigation bar.
  2. Select the Plugin Global Rules tab, then click Enable Plugin.
  3. Search for the prometheus plugin, then click Enable.
  4. In the dialog box that appeared, click Enable, no extra configuration needed.
  5. Make some API calls to test the monitoring.
  6. Select Monitoring from the side navigation bar to view the metrics.

API7.ai Logo

API Management for Modern Architectures with Edge, API Gateway, Kubernetes, and Service Mesh.

Product

API7 Cloud

SOC2 Type IIISO 27001HIPAAGDPRRed Herring

Copyright © APISEVEN Ltd. 2019 – 2024. Apache, Apache APISIX, APISIX, and associated open source project names are trademarks of the

Apache Software Foundation