Skip to content

[doc] add Fedora CoreOS monitoring help document (#1795) #4268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yyyCode wants to merge 3 commits into
base: master
Choose a base branch
from
Open

[doc] add Fedora CoreOS monitoring help document (#1795) #4268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
99360f8
[feat] add Apache Superset monitoring support (#994)
yyyCode Jul 29, 2026
1b768e5
[doc] add Fedora CoreOS monitoring help document (#1795)
yyyCode Jul 29, 2026
1c7a80b
Merge branch 'master' into docs-coreos-help
yyyCode Aug 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 149 additions & 0 deletions hertzbeat-manager/src/main/resources/define/app-superset.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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）进行采集监控。<br>您可以点击“<i>新建 Apache Superset</i>”并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
en-US: HertzBeat monitors Apache Superset through general performance metrics such as health and version. You could click the "<i>New Apache Superset</i>" button and proceed with the configuration or import an existing setup through the "<i>More Actions</i>" menu.
zh-TW: HertzBeat對Apache Superset通用性能指標（health、version）進行採集監控。<br>您可以點擊“<i>新建 Apache Superset</i>”並進行配寘，或者選擇“<i>更多操作</i>”，導入已有配寘。
ja-JP: HertzBeatは、Apache Supersetの一般的なパフォーマンスのメトリクス（health、version）を監視します。<br><i>新規Apache Superset</i>をクリックして設定しましょう。
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: '$'
114 changes: 114 additions & 0 deletions home/docs/help/coreos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 |
38 changes: 38 additions & 0 deletions home/docs/help/superset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 |
Loading
Loading