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 12e45a703 [doc] add help documentation for clickhouse monitoring
(#1798)
12e45a703 is described below
commit 12e45a703bfe0dfa76fd8df067ec80b1d601065e
Author: LiuTianyou <[email protected]>
AuthorDate: Sat Apr 20 23:49:46 2024 +0800
[doc] add help documentation for clickhouse monitoring (#1798)
Co-authored-by: LiuTianyou <[email protected]>
---
home/docs/help/clickhouse.md | 73 ++++++++++++++++++++++
home/docs/help/guide.md | 3 +
.../current/help/clickhouse.md | 73 ++++++++++++++++++++++
.../current/help/guide.md | 4 ++
home/sidebars.json | 3 +-
5 files changed, 155 insertions(+), 1 deletion(-)
diff --git a/home/docs/help/clickhouse.md b/home/docs/help/clickhouse.md
new file mode 100644
index 000000000..6d7577276
--- /dev/null
+++ b/home/docs/help/clickhouse.md
@@ -0,0 +1,73 @@
+---
+id: clickhouse
+title: Monitoring：Clickhouse database monitoring
+sidebar_label: Clickhouse database
+keywords: [open source monitoring tool, open source database monitoring tool,
monitoring clickhouse database metrics]
+---
+
+> Collect and monitor the general performance Metrics of Clickhouse database.
+
+### 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 8123
|
+| Query timeout | Set the timeout time when SQL query does not respond to
data, unit: ms, default: 6000ms
|
+| Database name | Database instance name, optional
|
+| Username | Database connection user name, optional
|
+| Password | Database connection password, optional
|
+| 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：ping_available
+
+| Metric name | Metric unit | Metric help description |
+| ----------- | ----------- |------------------------------------|
+| responseTime | none | response time |
+#### Metric set：Data in the system.metrics table
+
+| Metric name | Metric unit | Metric help description |
+| ----------- |-------------| ----------- |
+| Query | none | Number of executing queries |
+| Merge | none | Number of executing background merges
|
+| PartMutation | none | Number of mutations (ALTER
DELETE/UPDATE) |
+| ReplicatedFetch| none | Number of data parts being fetched from
replica |
+| ReplicatedSend| none | Number of data parts being sent to replicas
|
+| ReplicatedChecks| none | Number of data parts checking for
consistency |
+| BackgroundMergesAndMutationsPoolTask| none | Number of active merges
and mutations in an associated background pool |
+| BackgroundFetchesPoolTask| none | Number of active fetches in an
associated background pool |
+| BackgroundCommonPoolTask| none | Number of active tasks in an
associated background pool |
+| BackgroundMovePoolTask| none | Number of active tasks in
BackgroundProcessingPool for moves |
+
+
+#### Metric set：Data for the system.events table
+
+| Metric name | Metric unit | Metric help description |
+| ----------- |-------------| ----------- |
+| Query | none | Number of queries to be interpreted and
potentially executed. Does not include queries that failed to parse or were
rejected due to AST size limits, quota limits or limits on the number of
simultaneously running queries. May include internal queries initiated by
ClickHouse itself. Does not count subqueries. |
+| SelectQuery | none | Same as Query, but only for SELECT
queries.
|
+| FailedQuery | none | Number of failed queries.
|
+| FailedSelectQuery | none | Same as FailedQuery, but only for SELECT
queries. |
+| QueryTimeMicroseconds | none | Total time of all queries.
|
+
+
+#### Metric set：Data from the system.asynchronous_metrics table
+
+| Metric name | Metric unit | Metric help description |
+| ----------- |-------------| ----------- |
+| AsynchronousMetricsCalculationTimeSpent | none | Time spent on
asynchronous metrics calculation. |
+| jemalloc.arenas.all.muzzy_purged | none | Number of muzzy
pages purged. |
+| jemalloc.arenas.all.dirty_purged | none | Number of dirty
pages purged. |
+| BlockReadBytes_ram1 | none | Number of bytes
read from RAM. |
+| jemalloc.background_thread.run_intervals | none | Number of
background thread run intervals. |
+| BlockQueueTime_nbd13 | none | Time spent in
block queue. |
+| jemalloc.background_thread.num_threads | none | Number of
background threads. |
+| jemalloc.resident | none | Resident memory
size. |
+| InterserverThreads | none | Number of
inter-server threads. |
+| BlockWriteMerges_nbd7 | none | Number of block
write merges. |
+
diff --git a/home/docs/help/guide.md b/home/docs/help/guide.md
index cabcbe695..796909e79 100644
--- a/home/docs/help/guide.md
+++ b/home/docs/help/guide.md
@@ -57,6 +57,9 @@ sidebar_label: Help Center
 👉 [Docker](docker) <br />
 👉 [Kubernetes](kubernetes) <br />
+### Bigdata monitoring
+
+ 👉 [Clickhouse](clickhouse) <br />
***
## 💡 Alarm service
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/clickhouse.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/clickhouse.md
new file mode 100644
index 000000000..1f0fcfa27
--- /dev/null
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/clickhouse.md
@@ -0,0 +1,73 @@
+---
+id: clickhouse
+title: 监控：Clickhouse数据库监控
+sidebar_label: Clickhouse数据库
+keywords: [开源监控系统, 开源数据库监控, Clickhouse数据库监控]
+---
+
+> 对Clickhouse数据库的通用性能指标进行采集监控。
+
+### 配置参数
+
+| 参数名称 | 参数帮助描述 |
+|--------|------------------------------------------------------|
+| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
+| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 |
+| 端口 | 数据库对外提供的端口，默认为8123。 |
+| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。 |
+| 数据库名称 | 数据库实例名称，可选。 |
+| 用户名 | 数据库连接用户名，可选 |
+| 密码 | 数据库连接密码，可选 |
+| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 |
+| 绑定标签 | 用于对监控资源进行分类管理 |
+| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 |
+
+### 采集指标
+
+#### 指标集合：ping 可用性
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+| ----------- | ----------- |------------|
+| responseTime | 无 | 响应时间 |
+
+#### 指标集合：system.metrics表的数据
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+| ----------- | ----------- |--------------------|
+| Query | 无 | 正在执行的查询的数量 |
+| Merge | 无 | 正在执行的后台合并的数量 |
+| PartMutation | 无 | 变更操作的数量(删除/更新) |
+| ReplicatedFetch| 无 | 从副本中获取的数据块的数量 |
+| ReplicatedSend| 无 | 发送到副本的数据块的数量 |
+| ReplicatedChecks| 无 | 数据块检查一致性的数量 |
+| BackgroundMergesAndMutationsPoolTask| 无 | 关联后台池中活跃的合并和变更操作数量 |
+| BackgroundFetchesPoolTask| 无 | 关联后台池中活跃的拉取操作数量 |
+| BackgroundCommonPoolTask| 无 | 关联后台池中活跃的通用操作数量 |
+| BackgroundMovePoolTask| 无 | 后台操作池中活跃的移动操作数量 |
+
+
+#### 指标集合：system.events表的数据
+
+| 指标名称 | 指标单位 | 指标帮助描述
|
+| -----------
|------|------------------------------------------------------------------------------------------------|
+| Query | 无 | 要解释和可能执行的查询数量。 不包括由于 AST
大小限制、配额限制或同时运行的查询数量限制而无法解析或被拒绝的查询。 可能包括 ClickHouse 本身发起的内部查询。 不计算子查询。 |
+| SelectQuery | 无 | 与 Query 相同，但仅适用于 SELECT 查询。
|
+| FailedQuery | 无 | 失败查询的数量。
|
+| FailedSelectQuery | 无 | 与 FailedQuery 相同，但仅适用于 SELECT 查询。
|
+| QueryTimeMicroseconds | 无 | 所有查询的总时间(微秒)。
|
+
+#### 指标集合：system.asynchronous_metrics表的数据
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+| ----------- |------|---------------------------|
+| AsynchronousMetricsCalculationTimeSpent | 无 | 异步指标计算花费的时间（秒）
|
+| jemalloc.arenas.all.muzzy_purged | 无 | 被清除的模糊（muzzy）页的数量
|
+| jemalloc.arenas.all.dirty_purged | 无 | 被清除的脏 （dirty）页的数量
|
+| BlockReadBytes_ram1 | 无 | ram1 块读取的字节数
|
+| jemalloc.background_thread.run_intervals | 无 | jemalloc 后台线程的运行间隔数
|
+| BlockQueueTime_nbd13 | 无 | nbd13 块队列等待时间
|
+| jemalloc.background_thread.num_threads | 无 | jemalloc 后台线程的数量
|
+| jemalloc.resident | 无 | jemalloc
分配器占用的物理内存大小（字节） |
+| InterserverThreads | 无 | Interserver 线程数
|
+| BlockWriteMerges_nbd7 | 无 | nbd7 块写合并数量
|
+
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 7d177cfe8..d0298ee93 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
@@ -57,6 +57,10 @@ sidebar_label: 帮助入门
 👉 [Docker](docker) <br />
 👉 [Kubernetes](kubernetes) <br />
+### 大数据监控
+
+  👉 [Clickhouse](clickhouse) <br />
+
## 💡 告警服务
> 更自由化的阈值告警配置，支持邮箱，短信，webhook，钉钉，企业微信，飞书机器人等告警通知。
diff --git a/home/sidebars.json b/home/sidebars.json
index 0a59fbaf6..5f6fda95c 100644
--- a/home/sidebars.json
+++ b/home/sidebars.json
@@ -203,7 +203,8 @@
"help/hadoop",
"help/iotdb",
"help/hive",
- "help/airflow"
+ "help/airflow",
+ "help/clickhouse"
]
},
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
