diff --git a/README.md b/README.md index faf6b7a1a80e3b940be9c66ab432ca36329d5f1f..c83a009e6965d63ef3ba59fec80489e629b03a7f 100644 --- a/README.md +++ b/README.md @@ -188,6 +188,34 @@ curl -X POST -d "pool_name=u01.mydb&db_portal=172.22.224.10:5432" http://127.0.0 curl -X POST -d "pool_name=u01.mydb&db_portal=172.22.224.10:5432" http://127.0.0.1:9380/api/v1/pool_list_be_db ``` +### 监控指标 + +**ZQPool 提供了基于 Prometheus 的 Exporter。** + +在配置文件中指定 Exporter 端口: +`exporter_port=9816 # 指定 Prometheus 监控端口, 即 ZQPool 中 Exporter 暴露数据的端口` + +标签: +pool_id 即配置文件中: pool.x.y 的 x
+比如: + +``` +# pool_id=1 +pool.1.fe_max_conns = 3000 +pool.1.fe_user=kuafu +``` + +| 指标名称 | 说明 | 状态 | +| --------------------------------------------- | ---------------------------------------------------- | ---- | +| zqpool_backend_connections | 后端连接数,记录了每个连接池的后端连接数目。 | ✅ | +| zqpool_active_backend_connections | 活跃后端连接数,记录了每个连接池的活跃后端连接数目。 | ✅ | +| zqpool_frontend_connections | 前端连接数,记录了每个连接池的前端连接数目。 | ✅ | +| zqpool_active_frontend_connections | 活跃前端连接数,记录了每个连接池的活跃前端连接数目。 | ✅ | +| zqpool_total_requests | 请求总数,记录了每个连接池的请求总数。 | ✅ | +| zqpool_total_simple_queries | 简单查询总数,记录了每个连接池的简单查询总数。 | ✅ | +| zqpool_total_extended_queries | 扩展查询总数,记录了每个连接池的扩展查询总数。 | ✅ | +| zqpool_backend_connection_limit_reached_times | 记录了每个连接池的后端连接数被占满的次数。 | ✅ | + ### PostgreSQl 14版本使用注意 目前ZQPool还不支持SCRAM-SHA-256的密码验证方式。而PostgreSQL 14版本默认使用SCRAM-SHA-256的密码验证方式,而不再是md5,所以当后端的数据库版本是14时或后端用户的验证方式SCRAM-SHA-256时,会报如下错误: