Skip to content

Commit

Permalink
[home] add DM db document supplement (#411)
Browse files Browse the repository at this point in the history
* DM Document Supplement

* [home] support dm help i18n

* [home] support dm help i18n

Co-authored-by: 高兴存 <gxc01514416@alibaba-inc.com>
Co-authored-by: tomsun28 <tomsun28@outlook.com>
  • Loading branch information
3 people committed Nov 6, 2022
1 parent 1dbeb44 commit 36c7922
Show file tree
Hide file tree
Showing 4 changed files with 156 additions and 1 deletion.
48 changes: 48 additions & 0 deletions home/docs/help/dm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
id: dm
title: 监控:达梦数据库监控
sidebar_label: 达梦数据库
---

> 对DM达梦数据库的通用性能指标进行采集监控。支持DM8+。
### 配置参数

| 参数名称 | 参数帮助描述 |
| ------------ | ------------------------------------------------------------ |
| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 |
| 端口 | 数据库对外提供的端口,默认为5236。 |
| 查询超时时间 | 设置SQL查询未响应数据时的超时时间,单位ms毫秒,默认3000毫秒。 |
| 数据库名称 | 数据库实例名称,可选。 |
| 用户名 | 数据库连接用户名,可选 |
| 密码 | 数据库连接密码,可选 |
| URL | 数据库连接URL,可选 |
| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为10秒 |
| 是否探测 | 新增监控前是否先探测检查监控可用性,探测成功才会继续新增修改操作 |
| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 |

### 采集指标

#### 指标集合:basic

| 指标名称 | 指标单位 | 指标帮助描述 |
| ------------ | -------- | ------------------ |
| PORT_NUM || 数据库暴露服务端口 |
| CTL_PATH || 控制文件路径 |
| MAX_SESSIONS || 数据库最大连接数 |

#### 指标集合:status

| 指标名称 | 指标单位 | 指标帮助描述 |
| -------- | -------- | ------------------ |
| status$ || DM数据库的开闭状态 |


#### 指标集合:thread

| 指标名称 | 指标单位 | 指标帮助描述 |
| ----------- | -------- | ---------------------------------------------- |
| dm_sql_thd || 用于编写 dmsql dmserver 的线程 |
| dm_io_thd || IO线程,由IO_THR_GROUPS参数控制,默认为2个线程 |
| dm_quit_thd || 用于执行正常关闭数据库的线程 |
48 changes: 48 additions & 0 deletions home/i18n/en/docusaurus-plugin-content-docs/current/help/dm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
id: dm
title: Monitor:DM database monitoring
sidebar_label: DM DB
---

> Collect and monitor the general performance metrics of the DM database. DM8+ is supported.
### Configuration parameters

| Parameter name | Parameter help description |
| ------- | ---------- |
| Monitor Host | Monitored peer IPV4, IPV6 or domain name. Note ⚠️ without protocol headers (eg: https://, http://). |
| Monitor Name | Identifies the name of this monitor. The name needs to be unique. |
| Port | The port provided by the database externally, the default is 5236. |
| Query Timeout | Set the timeout when the SQL query does not respond to data, in ms milliseconds, the default is 3000 milliseconds. |
| database name | database instance name, optional. |
| username | database connection username, optional |
| password | database connection password, optional |
| URL | Database connection URL, optional |
| Collection Interval | Monitor periodical collection data interval, in seconds, the minimum interval that can be set is 10 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring, and then continue to add and modify operations if the detection is successful |
| Description Remarks | More remarks that identify and describe this monitoring, users can remark information here |

### Collect metrics

#### Metric collection: basic

| Metric Name | Metric Unit | Metric Help Description |
| ------------ | -------- | ------------------ |
| PORT_NUM | None | Database exposed service port |
| CTL_PATH | None | Control File Path |
| MAX_SESSIONS | None | Maximum database connections |

#### Metric collection: status

| Metric Name | Metric Unit | Metric Help Description |
| -------- | -------- | ------------------ |
| status$ | None | Open/Close status of DM database |


#### Metric collection: thread

| Metric Name | Metric Unit | Metric Help Description |
| ------------- | -------- | ------------------------- |
| dm_sql_thd | None | Thread for writing dmsql dmserver |
| dm_io_thd | None | IO threads, controlled by IO_THR_GROUPS parameter, default is 2 threads |
| dm_quit_thd | None | Thread used to perform a graceful shutdown of the database |
58 changes: 58 additions & 0 deletions home/i18n/en/docusaurus-plugin-content-docs/version-v1.0.0.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
{
"version.label": {
"message": "v1.0.0",
"description": "The label for version v1.0.0"
},
"sidebar.docs.category.快速入门": {
"message": "快速入门",
"description": "The label for category 快速入门 in sidebar docs"
},
"sidebar.docs.category.自定义监控": {
"message": "自定义监控",
"description": "The label for category 自定义监控 in sidebar docs"
},
"sidebar.docs.category.HTTP协议": {
"message": "HTTP协议",
"description": "The label for category HTTP协议 in sidebar docs"
},
"sidebar.docs.category.JDBC协议": {
"message": "JDBC协议",
"description": "The label for category JDBC协议 in sidebar docs"
},
"sidebar.docs.category.SSH协议": {
"message": "SSH协议",
"description": "The label for category SSH协议 in sidebar docs"
},
"sidebar.docs.category.帮助文档": {
"message": "帮助文档",
"description": "The label for category 帮助文档 in sidebar docs"
},
"sidebar.docs.category.应用服务监控": {
"message": "应用服务监控",
"description": "The label for category 应用服务监控 in sidebar docs"
},
"sidebar.docs.category.数据库监控": {
"message": "数据库监控",
"description": "The label for category 数据库监控 in sidebar docs"
},
"sidebar.docs.category.操作系统": {
"message": "操作系统",
"description": "The label for category 操作系统 in sidebar docs"
},
"sidebar.docs.category.中间件": {
"message": "中间件",
"description": "The label for category 中间件 in sidebar docs"
},
"sidebar.docs.category.阈值告警配置": {
"message": "阈值告警配置",
"description": "The label for category 阈值告警配置 in sidebar docs"
},
"sidebar.docs.category.告警通知配置": {
"message": "告警通知配置",
"description": "The label for category 告警通知配置 in sidebar docs"
},
"sidebar.docs.category.Others": {
"message": "Others",
"description": "The label for category Others in sidebar docs"
}
}
3 changes: 2 additions & 1 deletion home/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@
"help/mariadb",
"help/postgresql",
"help/sqlserver",
"help/oracle"
"help/oracle",
"help/dm"
]
},
{
Expand Down

0 comments on commit 36c7922

Please sign in to comment.