Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
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: タイムアウト(ms)
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: '$'
38 changes: 38 additions & 0 deletions home/docs/help/superset.md
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 |
Original file line number Diff line number Diff line change
@@ -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 | 无 | 构建号 |
1 change: 1 addition & 0 deletions home/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,7 @@
"help/presto",
"help/seatunnel",
"help/spark",
"help/superset",
"help/yarn",
"help/dolphinscheduler"
]
Expand Down
Loading