This is an automated email from the ASF dual-hosted git repository.
gongchao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hertzbeat.git
The following commit(s) were added to refs/heads/master by this push:
new 690eade95 [doc] add help document for mongodb monitoring (#1834)
690eade95 is described below
commit 690eade95d3de56e0bbfff9d012b17220308a235
Author: LiuTianyou <[email protected]>
AuthorDate: Wed Apr 24 23:19:51 2024 +0800
[doc] add help document for mongodb monitoring (#1834)
Co-authored-by: liutianyou <[email protected]>
Co-authored-by: tomsun28 <[email protected]>
---
home/docs/help/guide.md | 1 +
home/docs/help/mongodb.md | 96 ++++++++++++++++++++++
.../current/help/guide.md | 2 +
.../current/help/mongodb.md | 96 ++++++++++++++++++++++
home/sidebars.json | 4 +-
5 files changed, 197 insertions(+), 2 deletions(-)
diff --git a/home/docs/help/guide.md b/home/docs/help/guide.md
index 1783e0487..86b21c6fe 100644
--- a/home/docs/help/guide.md
+++ b/home/docs/help/guide.md
@@ -36,6 +36,7 @@ sidebar_label: Help Center
 👉 [OpenGauss database monitoring](opengauss) <br />
 👉 [IoTDB database monitoring](iotdb) <br />
 👉 [TiDB database monitoring](tidb) <br />
+ 👉 [MongoDB database monitoring](mongodb) <br />
### Operating system monitoring
diff --git a/home/docs/help/mongodb.md b/home/docs/help/mongodb.md
new file mode 100644
index 000000000..4a2951ec2
--- /dev/null
+++ b/home/docs/help/mongodb.md
@@ -0,0 +1,96 @@
+---
+id: mongodb
+title: Monitoring:MongoDB
+sidebar_label: MongoDB database
+keywords: [ open source monitoring tool, open source database monitoring tool,
monitoring MongoDB database metrics ]
+---
+
+> Collect and monitor the general performance Metrics of MongoDB database.
+
+### Configuration parameter
+
+| Parameter name | Parameter help description
|
+|------------------------|-------------------------------------------------------------------------------------------------------------------------|
+| Target 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
27017. |
+| Username | Username for MongoDB,Optional.
|
+| Password | Password for MongoDB,Optional.
|
+| database | Database name.
|
+| authenticationDatabase | Credentials Storage Database.
|
+| Connect Timeout(ms) | Set connection timeout for MongoDB, unit: ms,
default: 6000ms. |
+| Collection interval | Interval time of monitor periodic data collection,
unit: second, and the minimum interval that can be set is 30 seconds |
+| Bind Tags | Used to classify and manage monitoring resources.
|
+| Description remarks | For more information about identifying and
describing this monitoring, users can note information here. |
+
+### Collection Metric
+
+#### Metric set:Build Info
+
+| Metric name | Metric unit | Metric help description
|
+|------------------|-------------|-----------------------------------------------------------------------------------------|
+| version | none | The version number of the MongoDB server.
|
+| gitVersion | none | The Git version of the MongoDB codebase.
|
+| sysInfo | none | System information, typically includes
details about the operating system and platform. |
+| loaderFlags | none | Loader flags used to link MongoDB binaries
|
+| compilerFlags | none | Compiler flags used when compiling MongoDB.
|
+| allocator | none | The memory allocator used by MongoDB.
|
+| javascriptEngine | none | The JavaScript engine used by MongoDB.
|
+
+#### Metric set:Server Document
+
+| Metric name | Metric unit | Metric help description |
+|-------------|-------------|-----------------------------------|
+| deleted | none | The number of documents deleted. |
+| inserted | none | The number of documents inserted. |
+| returned | none | The number of documents returned. |
+| updated | none | The number of documents updated. |
+
+#### Metric set:Server Operation
+
+| Metric name | Metric unit | Metric help description
|
+|----------------|-------------|------------------------------------------------------------------|
+| scanAndOrder | none | The number of times a query required both
scanning and ordering. |
+| writeConflicts | none | The number of write conflicts that occurred.
|
+
+#### Metric set: Max Connections
+
+| Metric name | Metric unit | Metric help description |
+|------------------|-------------|--------------------------------------------|
+| deletedDocuments | none | Number of deleted documents. |
+| passes | none | Total number of passes for TTL operations. |
+
+#### Metric set:System Info
+
+| Metric name | Metric unit | Metric help description
|
+|-------------|-------------|------------------------------------------------------|
+| currentTime | none | Current system time.
|
+| hostname | none | Hostname of the server.
|
+| cpuAddrSize | MB | Size of CPU address in bits.
|
+| memSizeMB | MB | Total size of system memory in megabytes.
|
+| memLimitMB | MB | Memory limit for the MongoDB process in
megabytes. |
+| numCores | none | Total number of CPU cores.
|
+| cpuArch | none | CPU architecture.
|
+| numaEnabled | none | Whether NUMA (Non-Uniform Memory Access) is
enabled. |
+
+#### Metric set:OS Info
+
+| Metric name | Metric unit | Metric help description |
+|-------------|-------------|----------------------------------|
+| type | none | Type of the operating system. |
+| name | none | Name of the operating system. |
+| version | none | Version of the operating system. |
+
+#### Metric set：Extra Info
+
+| Metric name | Metric unit | Metric help description
|
+|-----------------|-------------|--------------------------------------------------------|
+| versionString | none | String describing the version of the
operating system. |
+| libcVersion | none | Version of the C standard library (libc).
|
+| kernelVersion | none | Version of the operating system kernel.
|
+| cpuFrequencyMHz | none | Frequency of the CPU in megahertz.
|
+| cpuFeatures | none | Features supported by the CPU.
|
+| pageSize | none | Size of a memory page in bytes.
|
+| numPages | none | Total number of memory pages.
|
+| maxOpenFiles | none | Maximum number of open files allowed.
|
+
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md
index 207936f8e..24f6382e0 100644
--- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md
@@ -34,6 +34,7 @@ sidebar_label: 帮助入门
 👉 [OpenGauss数据库监控](opengauss) <br />
 👉 [IoTDB数据库监控](iotdb) <br />
 👉 [TiDB数据库监控](tidb) <br />
+  👉 [MongoDB数据库监控](mongodb) <br />
### 操作系统监控
@@ -138,6 +139,7 @@ sidebar_label: 帮助入门
 👉 [达梦数据库监控](dm) <br />
 👉 [OpenGauss数据库监控](opengauss) <br />
 👉 [IoTDB数据库监控](iotdb) <br />
+  👉 [MongoDB数据库监控](mongodb) <br />
### 操作系统监控
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb.md
new file mode 100644
index 000000000..23c4a8668
--- /dev/null
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb.md
@@ -0,0 +1,96 @@
+---
+id: mongodb
+title: 监控：MongoDB数据库
+sidebar_label: MongoDB数据库
+keywords: [ 开源监控系统, 开源数据库监控, MongoDB数据库监控 ]
+---
+
+> 对MongoDB数据库的通用性能指标进行采集监控。
+
+### 配置参数
+
+| 参数名称 | 参数帮助描述 |
+|--------|------------------------------------------------------|
+| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
+| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 |
+| 端口 | 数据库对外提供的端口，默认为27017。 |
+| 用户名 | MongoDB用户名，可选。 |
+| 密码 | MongoDB密码，可选。 |
+| 数据库 | 数据库名称 |
+| 认证数据库 | 存储用户凭据的数据库名称。 |
+| 连接超时时间 | 设置连接MongoDB未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。 |
+| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒。 |
+| 绑定标签 | 用于对监控资源进行分类管理。 |
+| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息。 |
+
+### 采集指标
+
+#### 指标集合：构建信息
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|------------------|------|-------------------------|
+| version | 无 | MongoDB版本信息 |
+| gitVersion | 无 | 源代码git版本 |
+| sysInfo | 无 | 系统信息 |
+| loaderFlags | 无 | 加载器标志 |
+| compilerFlags | 无 | 编译器标志 |
+| allocator | 无 | MongoDB所使用的内存分配器 |
+| javascriptEngine | 无 | MongoDB所使用的JavaScript引擎 |
+
+#### 指标集合：服务器文档
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|----------|------|--------|
+| deleted | 无 | 已删除数 |
+| inserted | 无 | 已插入数 |
+| returned | 无 | 已返回数 |
+| updated | 无 | 已更新数 |
+
+#### 指标集合：服务器操作
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|----------------|------|-------------------|
+| scanAndOrder | 无 | 执行查询时需要扫描并进行排序的次数 |
+| writeConflicts | 无 | 写冲突的次数 |
+
+#### 指标集合： 服务器_ttl
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|------------------|------|-------------------------------|
+| deletedDocuments | 无 | 删除的过期文档数量 |
+| passes | 无 | TTL清理过程的总传递次数，每次传递会检查并删除过期的文档 |
+
+#### 指标集合：系统信息
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|-------------|------|-----------------------|
+| currentTime | 无 | 当前时间 |
+| hostname | 无 | 主机名 |
+| cpuAddrSize | MB | CPU的地址位数 |
+| memSizeMB | MB | 内存大小（MB） |
+| memLimitMB | MB | MongoDB进程的内存限制(MB) |
+| numCores | 无 | CPU 核数 |
+| cpuArch | 无 | CPU 架构 |
+| numaEnabled | 无 | 是否启用了NUMA（非一致性内存访问）架构 |
+
+#### 指标集合：操作系统信息
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|---------|------|--------|
+| type | 无 | 操作系统类型 |
+| name | 无 | 操作系统名称 |
+| version | 无 | 版本号 |
+
+#### 指标集合：额外信息
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|-----------------|------|----------------------|
+| versionString | 无 | 版本 |
+| libcVersion | 无 | 标准库版本 |
+| kernelVersion | 无 | 内核版本 |
+| cpuFrequencyMHz | 无 | CPU 频率（兆赫兹） |
+| cpuFeatures | 无 | CPU的特性列表，包括支持的指令集和特性 |
+| pageSize | 无 | 内存页大小 |
+| numPages | 无 | 内存页数量 |
+| maxOpenFiles | 无 | 系统中允许打开的最大文件数 |
+
diff --git a/home/sidebars.json b/home/sidebars.json
index 8372a4fb2..a5e5cd131 100644
--- a/home/sidebars.json
+++ b/home/sidebars.json
@@ -166,7 +166,8 @@
"help/dm",
"help/opengauss",
"help/nebulaGraph",
- "help/tidb"
+ "help/tidb",
+ "help/mongodb"
]
},
@@ -270,7 +271,6 @@
"type": "category",
"label": "Others",
"items": [
- "others/developer",
"others/contributing",
"others/resource"
]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
