API 指标监控
API7 网关能以极低的延迟向监控系统提供全面的指标,便于持续监控和诊断。
API7 网关的监控和告警功能基于广泛使用的系统监控和告警工具 Prometheus。Prometheus 收集并存储多维时间序列数据,包括以键值对标注的指标。
本指南介绍如何启用 prometheus 插件并接入监控系统,以便收集和可视化 HTTP 指标。
前提条件
监控所有服务
建议通过全局规则启用 prometheus 插件,以统一监控和跟踪所有服务和路由。
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的插件设置。
- 选择插件全局规则选项卡,然后点击启用插件。
- 搜索
prometheus插件,然后点击启用。 - 在对话框中点击启用,无需额外配置。
- 调用 API 以验证监控是否生效。
- 从侧边栏选择监控,查看指标。
要使用 ADC 启用监控,请创建以下配置。
adc.yaml
global_rules:
prometheus:
_meta:
disable: false
将配置同步到 API7 网关。
adc sync -f adc.yaml
备注
ADC 以配置文件为唯一依据。运行 adc sync 时,请确保通过 -f 传入所有配置文件。
在 API7 企业版控制台中,从侧边栏选择监控,查看指标。
创建清单文件,为所有路由全局启用 prometheus 插件。
global-observability.yaml
apiVersion: apisix.apache.org/v2
kind: ApisixGlobalRule
metadata:
name: global-observability
# namespace: api7 # replace with your namespace
spec:
monitoring:
prometheus:
enable: true
将配置应用到集群。
kubectl apply -f global-observability.yaml
在 API7 企业版控制台中,从侧边栏选择监控,查看指标。