From 35ec41019f92556fca7452a5d43aedd7c65b34f9 Mon Sep 17 00:00:00 2001 From: liuhy Date: Tue, 20 Aug 2024 21:35:26 +0800 Subject: [PATCH] [type:feature] add kingbase help md --- home/docs/help/kingbase.md | 56 +++++++++++++++++++ .../current/help/kingbase.md | 56 +++++++++++++++++++ home/sidebars.json | 1 + 3 files changed, 113 insertions(+) create mode 100644 home/docs/help/kingbase.md create mode 100644 home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kingbase.md diff --git a/home/docs/help/kingbase.md b/home/docs/help/kingbase.md new file mode 100644 index 00000000000..92d3b440496 --- /dev/null +++ b/home/docs/help/kingbase.md @@ -0,0 +1,56 @@ +--- +id: kingbase +title: Monitoring：Kingbase database monitoring +sidebar_label: Kingbase database +keywords: [open source monitoring tool, open source database monitoring tool, monitoring kingbase database metrics] +--- + +> Collect and monitor the general performance Metrics of Kingbase database. Support Kingbase V8R6+. + +### Configuration parameter + +| Parameter name | Parameter help description | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Monitoring name | Identify the name of this monitoring. The name needs to be unique | +| Port | Port provided by the database. The default is 5432 | +| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 3000ms | +| Database name | Database instance name, optional | +| Username | Database connection user name, optional | +| Password | Database connection password, optional | +| URL | Database connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here | + +### Collection Metric + +#### Metric set：basic + +| Metric name | Metric unit | Metric help description | +|-----------------|-------------|-------------------------------------------| +| server_version | none | Version number of the database server | +| port | none | Database server exposure service port | +| server_encoding | none | Character set encoding of database server | +| data_directory | none | Database storage data disk address | +| max_connections | connections | Database maximum connections | + +#### Metric set：state + +| Metric name | Metric unit | Metric help description | +|----------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| name | none | Database name, or share-object is a shared object | +| conflicts | times | The number of queries canceled in the database due to a conflict with recovery | +| deadlocks | number | Number of deadlocks detected in the database | +| blks_read | times | The number of disk blocks read in the database | +| blks_hit | times | Times the disk block has been found to be in the buffer, so there is no need to read it once (This only includes hits in the Kingbase buffer, not in the operating system file system buffer) | +| blk_read_time | ms | Time spent by the backend reading data file blocks in the database | +| blk_write_time | ms | Time spent by the backend writing data file blocks in the database | +| stats_reset | none | The last time these statistics were reset | + +#### Metric set：activity + +| Metric name | Metric unit | Metric help description | +|-------------|-------------|--------------------------------------| +| running | connections | Number of current client connections | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kingbase.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kingbase.md new file mode 100644 index 00000000000..2f22804c38b --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kingbase.md @@ -0,0 +1,56 @@ +--- +id: kingbase +title: 监控：Kingbase数据库监控 +sidebar_label: Kingbase数据库 +keywords: [开源监控系统, 开源数据库监控, Kingbase数据库监控] +--- + +> 对Kingbase数据库的通用性能指标进行采集监控。支持Kingbase V8R6+。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为5432。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | + +### 采集指标 + +#### 指标集合：basic + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|---------------| +| server_version | 无 | 数据库服务器的版本号 | +| port | 无 | 数据库服务器端暴露服务端口 | +| server_encoding | 无 | 数据库服务器端的字符集编码 | +| data_directory | 无 | 数据库存储数据盘地址 | +| max_connections | 连接数 | 数据库最大连接数 | + +#### 指标集合：state + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------------------------------------------------------------------------| +| name | 无 | 数据库名称，或share-object为共享对象。 | +| conflicts | 次数 | 由于与恢复冲突而在这个数据库中被取消的查询的数目 | +| deadlocks | 个数 | 在这个数据库中被检测到的死锁数 | +| blks_read | 次数 | 在这个数据库中被读取的磁盘块的数量 | +| blks_hit | 次数 | 磁盘块被发现已经在缓冲区中的次数，这样不需要一次读取（这只包括 Kingbase 缓冲区中的命中，而不包括在操作系统文件系统缓冲区中的命中） | +| blk_read_time | ms | 在这个数据库中后端花费在读取数据文件块的时间 | +| blk_write_time | ms | 在这个数据库中后端花费在写数据文件块的时间 | +| stats_reset | 无 | 这些统计信息上次被重置的时间 | + +#### 指标集合：activity + +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------| +| running | 连接数 | 当前客户端连接数 | + diff --git a/home/sidebars.json b/home/sidebars.json index 4c14bc6c39a..8db82fa48c4 100755 --- a/home/sidebars.json +++ b/home/sidebars.json @@ -206,6 +206,7 @@ "help/mysql", "help/mariadb", "help/postgresql", + "help/kingbase", "help/sqlserver", "help/oracle", "help/dm",