前言:部分内容在 Kong Quick Start 和 APISIX Quick Start 中有描述,在本篇中不再重复。
安装 Prometheus
可以直接到 Prometheus 官方下载页面下载,https://prometheus.io/download/ 。Prometheus 是一个用 Go 编写的二进制可执行文件,所以支持 Linux、Windows 和 MacOS 等操作系统,下载对应版本即可,这里使用 Linux:
wget https://github.com/prometheus/prometheus/releases/download/v2.18.1/prometheus-2.18.1.linux-amd64.tar.gz
tar -xzvf prometheus-2.18.1.linux-amd64.tar.gz
cd prometheus-2.18.1.linux-amd64
./prometheus
这里修改 prometheus.yaml
中的 scrape_configs
配置参数,Prometheus 默认情况下使用的 Pull 方式来拉取数据,即由它的抓取模块主动访问目标服务器的接口来获取各种性能指标,当然也可以通过 gateway 实现 Push 方式,这里不详细描述,可参考官方文档。修改 scrape_configs
增加 Kong 的 metrics 接口:
scrape_configs:
# The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
- job_name: 'prometheus'
# metrics_path defaults to '/metrics'
# scheme defaults to 'http'.
static_configs:
- targets: ['localhost:9090']
- job_name: 'kong'
scrape_interval: 1s
static_configs:
- targets: ['192.168.33.10:8001']
保存后,启动 Prometheus:
./prometheus --config.file="prometheus.yml"
配置 Kong
Kong 2.0 开始默认启用了 prometheus 插件,我们可以直接使用。这里我们将 Prometheus 插件配置为全局插件,如果只想针对部分 service 或者 route 进行性能监控,可以单独配置在这部分上面。开启全局可以监控全局流量,后续的性能数据对 service 做了区分。
curl http://localhost:8001/plugins -d name=prometheus
我们可以直接访问 /metrics
测试,将会得到 Prometheus 标准的数据格式:
curl http://localhost:8001/metrics
注意,开发环境可以直接访问 Admin 的 /metrics
接口,生产部署环境尽量不要这样做。我们可以通过 Kong Proxy 的 IP 地址白名单来做访问限制(详细配置可以参考 https://github.com/Kong/kong-plugin-prometheus
):
curl -XPOST http://localhost:8001/services -d name=prometheusEndpoint -d url=http://localhost:8001/metrics
curl -XPOST http://localhost:8001/services/prometheusEndpoint/routes -d paths[]=/metrics
curl -XPOST http://localhost:8001/services/prometheusEndpoint/plugins -d name=ip-restriction -d config.whitelist=10.0.0.0/8
此时我们可以访问:
curl http://localhost:8000/metrics
注意:是 8000 端口,不是 8001 端口。8000 是 Kong 的代理端口,8001 是 Kong 的管理端口。
安装 Grafana
官方下载页面:https://grafana.com/grafana/download 。
启动 Grafana:
wget https://dl.grafana.com/oss/release/grafana-7.0.3.linux-amd64.tar.gz)
tar -xzvf grafana-7.0.3.linux-amd64.tar.gz
cd grafana-7.0.3
bin/grafana-server
访问 localhost:3000
,默认用户和密码是 admin/admin
。
第一步是创建数据源( http://localhost:3000/datasources/new ),选择 Prometheus 创建即可。开发环境下可将 Access
访问方式设置为 Browser
直接访问 Prometheus。
第二步是创建 Dashboard,我们需要使用 Kong 或者 APISIX 官方提供的 Dashboard 模板,因此直接使用 Grafana 的 Import( http://localhost:3000/dashboard/import ):
- Kong Dashboard: https://grafana.com/grafana/dashboards/7424
- APISIX Dashboard: https://grafana.com/grafana/dashboards/11719
配置好后,我们需要对接口进行压测,详细操作步骤可参考 Kong Quick Start ,这里不再详述。
注意:调整右上方的时间范围为「Last 15 minutes」可以更清楚地观察结果。