This is an automated email from the ASF dual-hosted git repository.
tomsun28 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 c9306528dc [doc] add HertzBeat monitoring help documentation (#4413)
c9306528dc is described below
commit c9306528dc18463865167193bf4a2f795295f2c3
Author: butterfly-520-boy <[email protected]>
AuthorDate: Tue Oct 6 10:45:22 2026 +0800
[doc] add HertzBeat monitoring help documentation (#4413)
Co-authored-by: butterfly-520-boy
<[email protected]>
Co-authored-by: Tomsun28 <[email protected]>
---
home/docs/help/hertzbeat.md | 83 ++++++++++++++++++++++
.../current/help/hertzbeat.md | 83 ++++++++++++++++++++++
home/sidebars.json | 2 +-
3 files changed, 167 insertions(+), 1 deletion(-)
diff --git a/home/docs/help/hertzbeat.md b/home/docs/help/hertzbeat.md
new file mode 100644
index 0000000000..509a556e32
--- /dev/null
+++ b/home/docs/help/hertzbeat.md
@@ -0,0 +1,83 @@
+---
+id: hertzbeat
+title: Monitoring HertzBeat
+sidebar_label: HertzBeat
+keywords: [open source monitoring tool, HertzBeat monitoring, HertzBeat
self-monitoring]
+---
+
+> Monitor the status, internal queues, JVM threads, and JVM memory of a
HertzBeat server through its HTTP APIs and Actuator endpoints.
+
+## Prerequisites
+
+- The collector assigned to this monitor must be able to access the target
HertzBeat server.
+- Prepare an account that can access the HertzBeat summary, internal metrics,
and Actuator metrics endpoints.
+- If HTTPS is enabled on the target server, enable HTTPS in the monitor and
use the corresponding HTTPS port.
+
+The monitor collects data from `/api/summary`, `/api/metrics`, and the JVM
metrics exposed under `/actuator/metrics`.
+
+## Configuration parameters
+
+| Parameter name | Parameter description
|
+|---------------------|----------------------------------------------------------------------------------------------------------------------------|
+| Target Host | IPv4 address, IPv6 address, or domain name of the
HertzBeat server. Do not include `http://` or `https://`. |
+| Monitoring name | Unique name used to identify this monitor.
|
+| Port | Port of the HertzBeat server. The default port is
`1157`. |
+| Enable HTTPS | Whether to access the target server through HTTPS.
|
+| Timeout | Maximum time in milliseconds to wait for an HTTP
response. The default value is `6000`. |
+| Auth Type | HTTP authentication type. The template supports Basic
Auth and Digest Auth. |
+| Username | Username used to access the protected HertzBeat API
and Actuator endpoints. |
+| Password | Password used to access the protected HertzBeat API
and Actuator endpoints. |
+| Collector | Collector used to schedule data collection for this
monitor. |
+| Collection interval | Interval between data collections, in seconds. The
minimum interval is 30 seconds. |
+| Bind tags | Tags used to categorize and manage the monitored
resource. |
+| Description | Additional information about the monitor.
|
+
+## Collection metrics
+
+### Metric set: Summary
+
+Provides an overview of the monitor types managed by the target HertzBeat
server.
+
+| Metric name | Unit | Description |
+|--------------|------|--------------------------------------------------|
+| app | None | Monitor application type. |
+| category | None | Monitor category. |
+| status | None | Status of the monitor application type. |
+| Size | None | Total number of monitors for this type. |
+| availableSize | None | Number of available monitors for this type. |
+
+### Metric set: Inner Queue
+
+Provides the current sizes of HertzBeat internal data queues.
+
+| Metric name | Unit | Description
|
+|------------------------------------------|------|--------------------------------------------------|
+| responseTime | ms | Response time of the
internal metrics endpoint. |
+| alertDataQueue | None | Number of entries in the
alert data queue. |
+| metricsDataToAlertQueue | None | Metrics waiting to be
processed by the alerter. |
+| metricsDataToPersistentStorageQueue | None | Metrics waiting for
persistent storage. |
+| metricsDataToMemoryStorageQueue | None | Metrics waiting for
in-memory storage. |
+
+### Metric set: Threads
+
+Provides the number of JVM threads in each thread state.
+
+| Metric name | Unit | Description |
+|-------------|------|----------------------------------------------|
+| state | None | JVM thread state. |
+| number | None | Number of threads in this state. |
+
+### Metric set: Memory Used
+
+Provides JVM memory usage grouped by memory space.
+
+| Metric name | Unit | Description |
+|-------------|------|----------------------------------------------|
+| space | None | JVM memory space name. |
+| mem_used | MB | Memory used in this space. |
+
+## Troubleshooting
+
+- If collection returns `401` or `403`, verify the authentication type,
username, password, and account permissions.
+- If JVM thread or memory metrics cannot be collected, verify that the target
server exposes the required Actuator metrics endpoints.
+- When using a remote collector, do not use `localhost` unless HertzBeat is
running on the same host as that collector.
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hertzbeat.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hertzbeat.md
new file mode 100644
index 0000000000..1a40826ca8
--- /dev/null
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hertzbeat.md
@@ -0,0 +1,83 @@
+---
+id: hertzbeat
+title: 监控：HertzBeat
+sidebar_label: HertzBeat
+keywords: [开源监控系统, HertzBeat监控, HertzBeat自监控]
+---
+
+> 通过 HertzBeat 的 HTTP API 和 Actuator 指标接口，监控 HertzBeat 服务的状态、内部队列、JVM 线程和 JVM
内存。
+
+## 监控前提
+
+- 为监控任务分配的采集器必须能够访问目标 HertzBeat 服务。
+- 准备一个能够访问 HertzBeat 概要、内部指标及 Actuator 指标接口的账号。
+- 如果目标服务启用了 HTTPS，请在监控配置中开启 HTTPS，并填写对应的 HTTPS 端口。
+
+该监控通过 `/api/summary`、`/api/metrics` 以及 `/actuator/metrics` 下的 JVM 指标接口采集数据。
+
+## 配置参数
+
+| 参数名称 | 参数帮助描述 |
+|----------|--------------|
+| 目标Host | HertzBeat 服务的 IPv4、IPv6 地址或域名。请勿包含 `http://` 或 `https://`。 |
+| 任务名称 | 标识此监控的唯一名称。 |
+| 端口 | HertzBeat 服务端口，默认端口为 `1157`。 |
+| 启用HTTPS | 是否通过 HTTPS 访问目标服务。 |
+| 超时时间 | 等待 HTTP 响应的最长时间，单位为毫秒，默认值为 `6000`。 |
+| 认证方式 | HTTP 认证方式，模板支持 Basic Auth 和 Digest Auth。 |
+| 用户名 | 访问受保护的 HertzBeat API 和 Actuator 指标接口所使用的用户名。 |
+| 密码 | 访问受保护的 HertzBeat API 和 Actuator 指标接口所使用的密码。 |
+| 采集器 | 调度此监控任务进行数据采集的采集器。 |
+| 采集间隔 | 周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 |
+| 绑定标签 | 用于分类和管理监控资源的标签。 |
+| 描述备注 | 此监控的补充说明。 |
+
+## 采集指标
+
+### 指标集合：概要信息
+
+展示目标 HertzBeat 服务所管理的各类监控概况。
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|----------|----------|--------------|
+| app | 无 | 监控应用类型。 |
+| category | 无 | 监控类别。 |
+| status | 无 | 监控应用类型的状态。 |
+| Size | 无 | 此类型的监控总数。 |
+| availableSize | 无 | 此类型中可用的监控数量。 |
+
+### 指标集合：内部队列
+
+展示 HertzBeat 内部数据队列当前的长度。
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|----------|----------|--------------|
+| responseTime | ms | 内部指标接口的响应时间。 |
+| alertDataQueue | 无 | 告警数据队列中的数据数量。 |
+| metricsDataToAlertQueue | 无 | 等待告警模块处理的指标数量。 |
+| metricsDataToPersistentStorageQueue | 无 | 等待写入持久化存储的指标数量。 |
+| metricsDataToMemoryStorageQueue | 无 | 等待写入内存存储的指标数量。 |
+
+### 指标集合：线程
+
+展示各 JVM 线程状态对应的线程数量。
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|----------|----------|--------------|
+| state | 无 | JVM 线程状态。 |
+| number | 无 | 处于此状态的线程数量。 |
+
+### 指标集合：内存使用
+
+按 JVM 内存空间展示已使用的内存大小。
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|----------|----------|--------------|
+| space | 无 | JVM 内存空间名称。 |
+| mem_used | MB | 此内存空间已使用的内存大小。 |
+
+## 常见问题
+
+- 如果采集返回 `401` 或 `403`，请检查认证方式、用户名、密码及账号权限。
+- 如果无法采集 JVM 线程或内存指标，请确认目标服务已暴露所需的 Actuator 指标接口。
+- 使用远程采集器时，除非 HertzBeat 与该采集器运行在同一主机，否则不要使用 `localhost` 作为目标 Host。
diff --git a/home/sidebars.json b/home/sidebars.json
index ef3c6e90e7..ad542a8d7f 100755
--- a/home/sidebars.json
+++ b/home/sidebars.json
@@ -316,7 +316,7 @@
"type": "category",
"label": "Custom",
"key": "help-custom",
- "items": ["help/kafka_promql", "help/influxdb_promql",
"help/tdengine_promql"]
+ "items": ["help/hertzbeat", "help/kafka_promql",
"help/influxdb_promql", "help/tdengine_promql"]
},
"help/status",
"help/bulletin",
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
