From c2e60bebdd81fefbc2c21eb81d4c4a1a15bbfad3 Mon Sep 17 00:00:00 2001 From: tomsun28 Date: Wed, 9 Mar 2022 07:50:56 +0800 Subject: [PATCH] =?UTF-8?q?[home]=E6=96=B0=E5=A2=9Epostgresql=E5=B8=AE?= =?UTF-8?q?=E5=8A=A9=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../{extend-mysql.md => extend-jdbc.md} | 14 ++--- home/docs/advanced/extend-point.md | 2 +- home/docs/help/guide.md | 2 +- home/docs/help/mariadb.md | 4 +- home/docs/help/mysql.md | 4 +- home/docs/help/postgresql.md | 56 +++++++++++++++++++ home/sidebars.json | 7 ++- 7 files changed, 71 insertions(+), 18 deletions(-) rename home/docs/advanced/{extend-mysql.md => extend-jdbc.md} (94%) create mode 100644 home/docs/help/postgresql.md diff --git a/home/docs/advanced/extend-mysql.md b/home/docs/advanced/extend-jdbc.md similarity index 94% rename from home/docs/advanced/extend-mysql.md rename to home/docs/advanced/extend-jdbc.md index ad3cdc8..4e068a7 100644 --- a/home/docs/advanced/extend-mysql.md +++ b/home/docs/advanced/extend-jdbc.md @@ -1,15 +1,15 @@ --- -id: extend-mysql -title: MYSQL协议自定义监控 -sidebar_label: MYSQL协议自定义监控 +id: extend-jdbc +title: JDBC协议自定义监控 +sidebar_label: JDBC协议自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用MYSQL协议自定义指标监控。 -> mysql协议自定义监控可以让我们很方便的通过写SQL查询语句就能监控到我们想监控的指标 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JDBC(目前支持mysql,mariadb,postgresql)自定义指标监控。 +> JDBC协议自定义监控可以让我们很方便的通过写SQL查询语句就能监控到我们想监控的指标 -### MYSQL协议采集流程 +### JDBC协议采集流程 【**系统直连MYSQL**】->【**运行SQL查询语句**】->【**响应数据解析:oneRow, multiRow, columns**】->【**指标数据提取**】 -由流程可见，我们自定义一个MYSQL协议的监控类型，需要配置MYSQL请求参数，配置获取哪些指标，配置查询SQL语句。 +由流程可见，我们自定义一个JDBC协议的监控类型，需要配置JDBC请求参数，配置获取哪些指标，配置查询SQL语句。 ### 数据解析方式 SQL查询回来的数据字段和我们需要的指标映射，就能获取对应的指标数据，目前映射解析方式有三种：oneRow, multiRow, columns diff --git a/home/docs/advanced/extend-point.md b/home/docs/advanced/extend-point.md index 2ed31d0..ed95f40 100644 --- a/home/docs/advanced/extend-point.md +++ b/home/docs/advanced/extend-point.md @@ -4,7 +4,7 @@ title: 自定义监控 sidebar_label: 自定义监控 --- > HertzBeat拥有自定义监控能力，您只需配置两个YML文件就能适配一款自定义的监控类型。 -> 目前自定义监控支持[HTTP协议](extend-http)，MYSQL协议，后续会支持更多通用协议(ssh telnet wmi snmp)。 +> 目前自定义监控支持[HTTP协议](extend-http)，[JDBC](extend-jdbc)(mysql,mariadb,postgresql..)协议，后续会支持更多通用协议(ssh telnet wmi snmp)。 ### 自定义步骤 diff --git a/home/docs/help/guide.md b/home/docs/help/guide.md index e23f2b1..e6d62f4 100644 --- a/home/docs/help/guide.md +++ b/home/docs/help/guide.md @@ -18,7 +18,7 @@ sidebar_label: 帮助入门 ### 数据库监控 -[MYSQL数据库监控](mysql)      [MariaDB数据库监控](mariadb) +[MYSQL数据库监控](mysql)      [MariaDB数据库监控](mariadb)      [PostgreSQL数据库监控](postgresql) ## 💡 告警服务 diff --git a/home/docs/help/mariadb.md b/home/docs/help/mariadb.md index 83f0d28..3411ebb 100644 --- a/home/docs/help/mariadb.md +++ b/home/docs/help/mariadb.md @@ -12,7 +12,7 @@ sidebar_label: MariaDB数据库 | ----------- | ----------- | | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 监控名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | +| 端口 | 数据库对外提供的端口，默认为3306。 | | 数据库名称 | 数据库实例名称，可选。 | | 用户名 | 数据库连接用户名，可选 | | 密码 | 数据库连接密码，可选 | @@ -40,8 +40,6 @@ sidebar_label: MariaDB数据库 | threads_connected | 无 | MariaDB已经连接的连接数 | | threads_cached | 无 | MariaDB当前缓存的连接数 | | threads_running | 无 | MariaDB当前活跃的连接数 | -| qps | 无 | 每秒请求查询次数。`QPS = questions/uptimes` | -| tps | 无 | 每秒事务数据 `TPS= (commit+rollback)/seconds`| #### 指标集合：innodb diff --git a/home/docs/help/mysql.md b/home/docs/help/mysql.md index 1b2a92d..e69b564 100644 --- a/home/docs/help/mysql.md +++ b/home/docs/help/mysql.md @@ -12,7 +12,7 @@ sidebar_label: MYSQL数据库 | ----------- | ----------- | | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 监控名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | +| 端口 | 数据库对外提供的端口，默认为3306。 | | 数据库名称 | 数据库实例名称，可选。 | | 用户名 | 数据库连接用户名，可选 | | 密码 | 数据库连接密码，可选 | @@ -40,8 +40,6 @@ sidebar_label: MYSQL数据库 | threads_connected | 无 | MySql已经连接的连接数 | | threads_cached | 无 | MySql当前缓存的连接数 | | threads_running | 无 | MySql当前活跃的连接数 | -| qps | 无 | 每秒请求查询次数。`QPS = questions/uptimes` | -| tps | 无 | 每秒事务数据 `TPS= (commit+rollback)/seconds`| #### 指标集合：innodb diff --git a/home/docs/help/postgresql.md b/home/docs/help/postgresql.md new file mode 100644 index 0000000..bd64690 --- /dev/null +++ b/home/docs/help/postgresql.md @@ -0,0 +1,56 @@ +--- +id: postgresql +title: 监控：PostgreSQL数据库监控 +sidebar_label: PostgreSQL数据库 +--- + +> 对PostgreSQL数据库的通用性能指标进行采集监控。支持PostgreSQL 10+。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +| ----------- | ----------- | +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 监控名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为5432。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为10秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | + +### 采集指标 + +#### 指标集合：basic + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------- | ----------- | ----------- | +| server_version | 无 | 数据库服务器的版本号 | +| port | 无 | 数据库服务器端暴露服务端口 | +| server_encoding | 无 | 数据库服务器端的字符集编码 | +| data_directory | 无 | 数据库存储数据盘地址 | +| max_connections | 连接数 | 数据库最大连接数 | + +#### 指标集合：state + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------- | ----------- | ----------- | +| name | 无 | 数据库名称，或share-object为共享对象。 | +| conflicts | 次数 | 由于与恢复冲突而在这个数据库中被取消的查询的数目 | +| deadlocks | 个数 | 在这个数据库中被检测到的死锁数 | +| blks_read | 次数 | 在这个数据库中被读取的磁盘块的数量 | +| blks_hit | 次数 | 磁盘块被发现已经在缓冲区中的次数，这样不需要一次读取（这只包括 PostgreSQL 缓冲区中的命中，而不包括在操作系统文件系统缓冲区中的命中） | +| blk_read_time | ms | 在这个数据库中后端花费在读取数据文件块的时间 | +| blk_write_time | ms | 在这个数据库中后端花费在写数据文件块的时间 | +| stats_reset | 无 | 这些统计信息上次被重置的时间 | + + +#### 指标集合：activity + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------- | ----------- | ----------- | +| running | 连接数 | 当前客户端连接数 | + + diff --git a/home/sidebars.json b/home/sidebars.json index 1228a6b..4787677 100644 --- a/home/sidebars.json +++ b/home/sidebars.json @@ -28,9 +28,9 @@ }, { "type": "category", - "label": "MYSQL协议", + "label": "JDBC协议", "items": [ - "advanced/extend-mysql" + "advanced/extend-jdbc" ] } ] @@ -56,7 +56,8 @@ "label": "数据库监控", "items": [ "help/mysql", - "help/mariadb" + "help/mariadb", + "help/postgresql" ] }, {