跳到主要内容

使用 Prometheus 监控 APISIX 指标

Prometheus 是一种常用的系统监控和告警工具包。它收集并存储多维时间序列数据，例如带有键值对标签的指标。

APISIX 能够以低延迟向 Prometheus 公开大量指标，从而支持持续监控和诊断。

本指南介绍如何启用 prometheus 插件，与 Prometheus 和 Grafana 服务集成，以收集并可视化 APISIX HTTP 指标。


APISIX、Prometheus 和 Grafana 的数据流示意图

前置条件​

启用 Prometheus 插件​

全局启用 prometheus 插件。你也可以仅在某个路由上启用该插件。

curl "http://127.0.0.1:9180/apisix/admin/global_rules/prometheus" -X PUT \
  -H "Content-Type: application/json" \
  -d '{
    "plugins": {
      "prometheus": {}
    }
  }'

APISIX 收集内部运行时指标，并默认通过端口 9091 和路径 /apisix/prometheus/metrics 公开这些指标。可以在配置文件中自定义端口和路径。

向 /apisix/prometheus/metrics 路径发送请求，从 APISIX 获取指标：

curl "http://127.0.0.1:9091/apisix/prometheus/metrics"

你应该看到类似以下的指标列表：

# HELP apisix_etcd_modify_indexes Etcd modify index for APISIX keys
# TYPE apisix_etcd_modify_indexes gauge
apisix_etcd_modify_indexes{key="consumers"} 0
apisix_etcd_modify_indexes{key="global_rules"} 0
apisix_etcd_modify_indexes{key="max_modify_index"} 16
apisix_etcd_modify_indexes{key="prev_index"} 15
apisix_etcd_modify_indexes{key="protos"} 0
apisix_etcd_modify_indexes{key="routes"} 16
apisix_etcd_modify_indexes{key="services"} 0
apisix_etcd_modify_indexes{key="ssls"} 0
apisix_etcd_modify_indexes{key="stream_routes"} 0
apisix_etcd_modify_indexes{key="upstreams"} 0
apisix_etcd_modify_indexes{key="x_etcd_index"} 16
# HELP apisix_etcd_reachable Config server etcd reachable from APISIX, 0 is unreachable
# TYPE apisix_etcd_reachable gauge
apisix_etcd_reachable 1
...
# HELP apisix_http_status HTTP status codes per service in APISIX
# TYPE apisix_http_status counter
...

配置 Prometheus​

在 Prometheus 中，目标是 Prometheus 抓取指标的端点。可以将 APISIX 指标端点配置为 Prometheus 目标，以便从中收集指标。

创建配置文件 prometheus.yml：

cat > prometheus.yml <<'EOF'
global:
  scrape_interval: 15s

scrape_configs:
  - job_name: apisix
    metrics_path: /apisix/prometheus/metrics
    static_configs:
      - targets:
          - apisix-quickstart:9091
EOF

创建数据卷并启动 Prometheus。主机上的端口 9092 映射到容器内端口 9090 上的 Prometheus Web 界面：

docker volume create apisix-quickstart-prometheus-data

docker run -d --name apisix-quickstart-prometheus \
  --network apisix-quickstart-net \
  -p 9092:9090 \
  -v "$(pwd)/prometheus.yml:/etc/prometheus/prometheus.yml:ro" \
  -v apisix-quickstart-prometheus-data:/prometheus \
  prom/prometheus:v3.7.3

打开 Prometheus 目标页面。apisix 目标的状态应为 UP。

Prometheus 目标页面显示 APISIX 目标处于 UP 状态

配置 Grafana​

Grafana 可以可视化 Prometheus 中保存的指标。

创建数据卷，并在同一个 Docker 网络上启动 Grafana：

docker volume create apisix-quickstart-grafana-data

docker run -d --name apisix-quickstart-grafana \
  --network apisix-quickstart-net \
  -p 3000:3000 \
  -v apisix-quickstart-grafana-data:/var/lib/grafana \
  grafana/grafana:13.1.0

打开 Grafana，使用默认用户名和密码 admin 登录，并按提示修改密码。

前往 Connections > Data sources，添加 Prometheus 数据源，并将其 URL 设为 http://apisix-quickstart-prometheus:9090。由于 Grafana 从 Docker 网络内部发起请求，该 URL 使用 Prometheus 容器名称和容器端口。选择 Save & test，确认 Grafana 能够查询 Prometheus。

使用 Prometheus 容器 URL 配置的 Grafana Prometheus 数据源

生成网关流量，并等待 Prometheus 完成一次抓取：

for i in {1..100}; do
  curl -sS "http://127.0.0.1:9080/ip" > /dev/null
done

sleep 15

下载 Apache APISIX 源代码树中为此版本维护的 Dashboard：

curl -fL "https://raw.githubusercontent.com/apache/apisix/3.17.0/docs/assets/other/json/apisix-grafana-dashboard.json" \
  -o apisix-grafana-dashboard.json
备注

Grafana 目录中的 Dashboard 11719 页面只列出了对 APISIX 2.10.x 的兼容性，并依赖旧版 Grafana 面板。对于本指南公开的指标，请使用上面的版本化 Dashboard JSON。

在 Grafana 中前往 Dashboards > New > Import，上传 apisix-grafana-dashboard.json，选择 Prometheus 数据源，然后选择 Import。

已加载 Apache APISIX Dashboard JSON 的 Grafana Dashboard 导入页面

Dashboard 应显示上面生成的请求，并展示 APISIX 连接、请求、延迟、带宽、etcd 和共享字典指标。

显示实时网关指标的 Apache APISIX Grafana Dashboard

下一步​

现在，你已了解如何使用 Prometheus 监控 APISIX 指标，并在 Grafana 中将其可视化。有关更多配置选项，请参阅 prometheus 插件文档。