From 99360f8191fd5f49a5f620019c733cd8dc8dccc9 Mon Sep 17 00:00:00 2001 From: yqz <2678785492@qq.com> Date: Wed, 29 Jul 2026 22:40:36 +0800 Subject: [PATCH 1/2] [feat] add Apache Superset monitoring support (#994) Add an HTTP-based monitoring template for Apache Superset that collects health status and version information via its unauthenticated /health and /version endpoints. - add app-superset.yml with health and version metric sets - add EN and zh-CN help documentation - register the doc in sidebars.json Co-Authored-By: Claude Opus 4.8 --- .../main/resources/define/app-superset.yml | 149 ++++++++++++++++++ home/docs/help/superset.md | 38 +++++ .../current/help/superset.md | 38 +++++ home/sidebars.json | 1 + 4 files changed, 226 insertions(+) create mode 100644 hertzbeat-manager/src/main/resources/define/app-superset.yml create mode 100644 home/docs/help/superset.md create mode 100644 home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/superset.md diff --git a/hertzbeat-manager/src/main/resources/define/app-superset.yml b/hertzbeat-manager/src/main/resources/define/app-superset.yml new file mode 100644 index 00000000000..6fdeb6e4756 --- /dev/null +++ b/hertzbeat-manager/src/main/resources/define/app-superset.yml @@ -0,0 +1,149 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring mid-middleware +category: bigdata +# The monitoring type eg: linux windows tomcat mysql aws... +app: superset +# The monitoring i18n name +name: + zh-CN: Apache Superset + en-US: Apache Superset + ja-JP: Apache Superset +# The description and help of this monitoring type +help: + zh-CN: HertzBeat 对 Apache Superset 通用性能指标（health、version）进行采集监控。
您可以点击“新建 Apache Superset”并进行配置，或者选择“更多操作”，导入已有配置。 + en-US: HertzBeat monitors Apache Superset through general performance metrics such as health and version. You could click the "New Apache Superset" button and proceed with the configuration or import an existing setup through the "More Actions" menu. + zh-TW: HertzBeat對Apache Superset通用性能指標（health、version）進行採集監控。
您可以點擊“新建 Apache Superset”並進行配寘，或者選擇“更多操作”，導入已有配寘。 + ja-JP: HertzBeatは、Apache Supersetの一般的なパフォーマンスのメトリクス（health、version）を監視します。
新規Apache Supersetをクリックして設定しましょう。 +helpLink: + zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/superset/ + en-US: https://hertzbeat.apache.org/docs/help/superset/ +# Input params define for monitoring(render web ui by the definition) +params: + # field-param field key + - field: host + # name-param field display i18n name + name: + zh-CN: 目标 Host + en-US: Target Host + ja-JP: 目標ホスト + # type-param field type(most mapping the html input type) + type: host + # required-true or false + required: true + - field: port + name: + zh-CN: 服务端口 + en-US: Port + ja-JP: ポート + type: number + # when type is number, range is required + range: '[0,65535]' + required: true + defaultValue: 8088 + - field: ssl + name: + zh-CN: 启用HTTPS + en-US: HTTPS + ja-JP: HTTPS + type: boolean + required: true + defaultValue: false + - field: timeout + name: + zh-CN: 超时时间(ms) + en-US: Timeout(ms) + ja-JP: タイムアウト（ｍｓ） + type: number + required: false + hide: true + +# collect metrics config list +metrics: + - name: health + i18n: + zh-CN: 健康状态 + en-US: health status + ja-JP: 健全状態 + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue + priority: 0 + fields: + # field-metric name, i18n-metric name i18n label, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field + - field: responseTime + type: 0 + unit: ms + i18n: + zh-CN: 响应时间 + en-US: Response Time + ja-JP: 応答時間 + - field: statusCode + type: 0 + i18n: + zh-CN: 状态码 + en-US: Status Code + ja-JP: 状態コード + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk + protocol: http + # the config content when protocol is http + http: + # http host: ipv4 ipv6 domain + host: ^_^host^_^ + # http port + port: ^_^port^_^ + # url Indicates the path of the request interface + url: /health + timeout: ^_^timeout^_^ + method: GET + ssl: ^_^ssl^_^ + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule + parseType: website + + - name: version + i18n: + zh-CN: 版本信息 + en-US: version + ja-JP: バージョン + priority: 1 + fields: + - field: version_string + type: 1 + i18n: + zh-CN: Superset 版本 + en-US: Superset version + ja-JP: Supersetバージョン + - field: version_sha + type: 1 + i18n: + zh-CN: 构建 SHA + en-US: Version SHA + ja-JP: ビルドSHA + - field: build_number + type: 1 + i18n: + zh-CN: 构建号 + en-US: Build Number + ja-JP: ビルド番号 + protocol: http + http: + host: ^_^host^_^ + port: ^_^port^_^ + url: /version + timeout: ^_^timeout^_^ + method: GET + ssl: ^_^ssl^_^ + parseType: jsonPath + parseScript: '$' diff --git a/home/docs/help/superset.md b/home/docs/help/superset.md new file mode 100644 index 00000000000..aaedada4cba --- /dev/null +++ b/home/docs/help/superset.md @@ -0,0 +1,38 @@ +--- +id: superset +title: Monitoring Apache Superset +sidebar_label: Apache Superset +keywords: [open source monitoring system, open source observability, Apache Superset monitoring] +--- + +> Collect and monitor general performance metrics for Apache Superset. + +## Configuration Parameters + +| Parameter Name | Parameter Description | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------| +| Monitor Host | IP address, IPV4, IPV6, or domain name of the host being monitored. Note ⚠️ without protocol prefix (e.g., https://, http://). | +| Task Name | Name identifying this monitoring, ensuring uniqueness. | +| Port | Port that Superset is exposed on, default is 8088. | +| Query Timeout | Set timeout for unresponsive connections, in milliseconds (ms), default is 3000ms. | +| HTTPS | Whether to enable HTTPS. | +| Collection Interval | Interval for periodic data collection during monitoring, in seconds, with a minimum interval of 30 seconds. | +| Whether to detect | Whether to perform a probe check for monitoring availability before adding a new monitor; operations proceed if successful. | +| Description | Additional information to identify and describe this monitoring, where users can add remarks. | + +### Collection Metrics + +#### Metric Set: health + +| Metric Name | Metric Unit | Metric Description | +|--------------|-------------|---------------------------| +| responseTime | ms | Response time of /health | +| statusCode | N/A | HTTP response status code | + +#### Metric Set: version + +| Metric Name | Metric Unit | Metric Description | +|----------------|-------------|----------------------| +| version_string | N/A | Superset version | +| version_sha | N/A | Build git SHA | +| build_number | N/A | Build number | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/superset.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/superset.md new file mode 100644 index 00000000000..f7676e8ae5e --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/superset.md @@ -0,0 +1,38 @@ +--- +id: superset +title: 监控：Apache Superset监控 +sidebar_label: Apache Superset +keywords: [开源监控系统, 开源可观测性, Apache Superset监控] +--- + +> 对Apache Superset通用性能指标（health、version）进行采集监控。 + +## 配置参数 + +| 参数名称 | 参数帮助描述 | +|--------|-----------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | +| 端口 | Superset对外提供的端口，默认为8088 | +| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | +| HTTPS | 是否启用HTTPS | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | + +### 采集指标 + +#### 指标集合：health + +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------------| +| responseTime | ms | /health 响应时间 | +| statusCode | 无 | HTTP 响应状态码 | + +#### 指标集合：version + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|-----------| +| version_string | 无 | Superset版本 | +| version_sha | 无 | 构建 git SHA | +| build_number | 无 | 构建号 | diff --git a/home/sidebars.json b/home/sidebars.json index fd24405bbeb..595499f1745 100755 --- a/home/sidebars.json +++ b/home/sidebars.json @@ -279,6 +279,7 @@ "help/presto", "help/seatunnel", "help/spark", + "help/superset", "help/yarn", "help/dolphinscheduler" ] From 1b768e5f9529ff2d60677cd3d42dfda8be644859 Mon Sep 17 00:00:00 2001 From: yqz <2678785492@qq.com> Date: Thu, 30 Jul 2026 00:04:43 +0800 Subject: [PATCH 2/2] [doc] add Fedora CoreOS monitoring help document (#1795) Add the missing help documentation for the Fedora CoreOS (coreos) monitoring type in both English and Chinese, and register it in the sidebar under the os category. - add home/docs/help/coreos.md - add zh-CN help doc - register help/coreos in sidebars.json Co-Authored-By: Claude Opus 4.8 --- home/docs/help/coreos.md | 114 ++++++++++++++++++ .../current/help/coreos.md | 114 ++++++++++++++++++ home/sidebars.json | 1 + 3 files changed, 229 insertions(+) create mode 100644 home/docs/help/coreos.md create mode 100644 home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/coreos.md diff --git a/home/docs/help/coreos.md b/home/docs/help/coreos.md new file mode 100644 index 00000000000..91c1dd3cf89 --- /dev/null +++ b/home/docs/help/coreos.md @@ -0,0 +1,114 @@ +--- +id: coreos +title: Monitoring Fedora CoreOS Operating System +sidebar_label: Fedora CoreOS Operating System +keywords: [open-source monitoring system, open-source operating system monitoring, Fedora CoreOS operating system monitoring] +--- + +> Collect and monitor common performance metrics of the Fedora CoreOS operating system. + +## Configuration Parameters + +| Parameter Name | Parameter Help Description | +|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Monitored Host | The IPV4, IPV6, or domain name of the host being monitored. Note ⚠️ No protocol header (e.g., https://, http://). | +| Task Name | The name that identifies this monitoring, which must be unique. | +| Port | The port provided by Linux SSH, default is 22. | +| Timeout | Sets the connection timeout in milliseconds, default is 6000 ms. | +| Connection Reuse | Sets whether SSH connections are reused, default is :false. If false, a new connection is created each time information is retrieved. | +| Use Proxy Connection | Sets Whether connect via proxy, default is false. | +| Username | SSH connection username, optional. | +| Password | SSH connection password, optional. | +| Collector | Configures which collector is used to schedule data collection for this monitoring. | +| Monitoring Period | The interval time for periodic data collection in seconds, with a minimum interval of 30 seconds. | +| Binding Tags | Used for categorized management of monitoring resources. | +| Description | Additional notes and descriptions for this monitoring, where users can make notes. | +| PrivateKey | The private key required to connect to the server. | +| PrivateKey PassPhrase | The password phrase used to encrypt the SSH private key. If the private key was generated with a passphrase, this field must be filled to decrypt and use the key for authentication. | +| Proxy Host | The address of the proxy server, supporting IPV4, IPV6, or domain name format. Required when using SSH jump host to access the target host. | +| Proxy Port | The port number of the proxy service, default is 22. | +| Proxy Username | The authentication username required to connect to the proxy server. | +| Proxy Username | The authentication password required to connect to the proxy server. | +| Proxy PrivateKey | The private key required to authenticate with the proxy server. | + +### Data Collection Metrics + +#### Metric Set: Basic System Information + +| Metric Name | Metric Unit | Metric Help Description | +|-------------|-------------|-------------------------| +| hostname | None | Host name | +| version | None | System version | +| uptime | None | System Uptime | + +#### Metric Set: CPU Information + +| Metric Name | Metric Unit | Metric Help Description | +|----------------|-------------|-----------------------------------| +| info | None | CPU model | +| cores | None | Number of CPU cores | +| interrupt | None | Number of CPU interrupts | +| load | None | Average CPU load (1/5/15 minutes) | +| context_switch | None | Number of context switches | +| usage | % | CPU usage | + +#### Metric Set: Memory Information + +| Metric Name | Metric Unit | Metric Help Description | +|-------------|-------------|-------------------------------------| +| total | Mb | Total memory capacity | +| used | Mb | Memory used by user programs | +| free | Mb | Free memory capacity | +| buff_cache | Mb | Memory used for cache | +| available | Mb | Remaining available memory capacity | +| usage | % | Memory usage rate | + +#### Metric Set: Disk Information + +| Metric Name | Metric Unit | Metric Help Description | +|---------------|-------------|----------------------------------------| +| disk_num | None | Total number of disks | +| partition_num | None | Total number of partitions | +| block_write | None | Total number of blocks written to disk | +| block_read | None | Total number of blocks read from disk | +| write_rate | iops | Disk block write rate per second | + +#### Metric Set: Network Card Information + +| Metric Name | Metric Unit | Metric Help Description | +|----------------|-------------|-------------------------------| +| interface_name | None | Network card name | +| receive_bytes | Byte | Inbound data traffic (bytes) | +| transmit_bytes | Byte | Outbound data traffic (bytes) | + +#### Metric Set: File System + +| Metric Name | Metric Unit | Metric Help Description | +|-------------|-------------|-------------------------| +| filesystem | None | Name of the file system | +| used | Mb | Used disk size | +| available | Mb | Available disk size | +| usage | % | Usage rate | +| mounted | None | Mount point directory | + +#### Metric Set: Top 10 CPU Processes + +Statistics for the top 10 processes using the CPU. Statistics include: process ID, CPU usage, memory usage, and executed command. + +| Metric Name | Metric Unit | Metric Help Description | +|-------------|-------------|-------------------------| +| pid | None | Process ID | +| cpu_usage | % | CPU usage | +| mem_usage | % | Memory usage | +| command | None | Executed command | + +#### Metric Set: Top 10 Memory Processes + +Statistics for the top 10 processes using memory. Statistics include: process ID, memory usage, CPU usage, and executed command. + +| Metric Name | Metric Unit | Metric Help Description | +|-------------|-------------|-------------------------| +| pid | None | Process ID | +| mem_usage | % | Memory usage | +| cpu_usage | % | CPU usage | +| command | None | Executed command | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/coreos.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/coreos.md new file mode 100644 index 00000000000..51c0345464c --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/coreos.md @@ -0,0 +1,114 @@ +--- +id: coreos +title: 监控：Fedora CoreOS操作系统监控 +sidebar_label: Fedora CoreOS 操作系统 +keywords: [开源监控系统, 开源操作系统监控, Fedora CoreOS操作系统监控] +--- + +> 对Fedora CoreOS操作系统的通用性能指标进行采集监控。 + +## 配置参数 + +| 参数名称 | 参数帮助描述 | +|--------|---------------------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Linux SSH对外提供的端口，默认为22。 | +| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 | +| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次获取信息都会创建一个连接 | +| 使用代理 | 设置是否通过代理连接，默认为false。 | +| 用户名 | SSH连接用户名，可选 | +| 密码 | SSH连接密码，可选 | +| 采集器 | 配置此监控使用哪台采集器调度采集 | +| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 私钥 | 连接服务器所需的私钥 | +| 密钥短语 | 用于加密 SSH 私钥的密码短语（Passphrase）。如果私钥在生成时设置了密码短语，则必须填写此字段才能解密并使用私钥进行认证。 | +| 代理主机 | 代理服务器的地址，支持 IPV4、IPV6或域名。若使用 SSH 代理跳转访问目标主机，需填写代理服务器的地址。 | +| 代理端口 | 代理服务器的端口号。 | +| 代理用户名 | 连接代理服务器时所需的认证用户名。 | +| 代理密码 | 连接代理服务器时所需的认证密码。 | +| 代理主机私钥 | 连接代理服务器时所需的私钥。 | + +### 采集指标 + +#### 指标集合：系统基本信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|--------| +| hostname | 无 | 主机名称 | +| version | 无 | 操作系统版本 | +| uptime | 无 | 启动时间 | + +#### 指标集合：CPU 信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------------------| +| info | 无 | CPU型号 | +| cores | 无 | CPU内核数量 | +| interrupt | 无 | CPU中断数量 | +| load | 无 | CPU最近1/5/15分钟的平均负载 | +| context_switch | 无 | 当前上下文切换数量 | +| usage | % | CPU使用率 | + +#### 指标集合：内存信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|----------| +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | + +#### 指标集合：磁盘信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-----------| +| disk_num | 无 | 磁盘总数 | +| partition_num | 无 | 分区总数 | +| block_write | 无 | 写入磁盘的总块数 | +| block_read | 无 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | + +#### 指标集合：网卡信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|---------------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | Byte | 入站数据流量(bytes) | +| transmit_bytes | Byte | 出站数据流量(bytes) | + +#### 指标集合：文件系统 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| filesystem | 无 | 文件系统的名称 | +| used | Mb | 已使用磁盘大小 | +| available | Mb | 可用磁盘大小 | +| usage | % | 使用率 | +| mounted | 无 | 挂载点目录 | + +#### 指标集合：Top10 CPU进程 + +统计进程使用CPU的Top10进程。统计信息包括：进程ID、CPU占用率、内存占用率、执行命令。 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| pid | 无 | 进程ID | +| cpu_usage | % | CPU占用率 | +| mem_usage | % | 内存占用率 | +| command | 无 | 执行命令 | + +#### 指标集合：Top10 内存进程 + +统计进程使用内存的Top10进程。统计信息包括：进程ID、内存占用率、CPU占用率、执行命令。 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| pid | 无 | 进程ID | +| mem_usage | % | 内存占用率 | +| cpu_usage | % | CPU占用率 | +| command | 无 | 执行命令 | diff --git a/home/sidebars.json b/home/sidebars.json index 595499f1745..aced2ac295c 100755 --- a/home/sidebars.json +++ b/home/sidebars.json @@ -217,6 +217,7 @@ "help/rockylinux", "help/euleros", "help/fedora", + "help/coreos", "help/linux_script", "help/windows_script", "help/macos",