Skip to content

Commit

Permalink
update app-clickhouse.yml comment (#811)
Browse files Browse the repository at this point in the history
Co-authored-by: ShuningWan <shuningwan@gmail.com>
  • Loading branch information
2 people authored and tomsun28 committed Jan 16, 2024
1 parent a43be68 commit d34655c
Showing 1 changed file with 90 additions and 4 deletions.
94 changes: 90 additions & 4 deletions manager/src/main/resources/define/app-clickhouse.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,75 +13,161 @@
# 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 mid-middleware custom-custom monitoring os-operating system monitoring
# 监控类型所属类别:service-应用服务监控 db-数据库监控 mid-中间件 custom-自定义监控 os-操作系统监控 cn-云原生cloud native network-网络监控
category: db
# The monitoring type eg: linux windows tomcat mysql aws...
# 监控类型 eg: linux windows tomcat mysql aws...
app: clickhouse
# The monitoring i18n name
# 监控类型国际化名称
name:
zh-CN: ClickHouse数据库
en-US: ClickHouse DB
# 监控所需输入参数定义(根据定义渲染页面UI)
# Input params define for monitoring(render web ui by the definition)
params:
# field-param field key
# field-字段名称标识符
- field: host
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 主机Host
en-US: Host
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: host
# required-true or false
# 是否是必输项 true-必填 false-可选
required: true
# field-param field key
# field-字段名称标识符
- field: port
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: HTTP端口
en-US: HTTP Port
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: number
# when type is number, range is required
# 当type为number时,用range表示范围
range: '[0,65535]'
# required-true or false
# 是否是必输项 true-必填 false-可选
required: true
# default value
# 默认值
defaultValue: 8123
# field-param field key
# field-字段名称标识符
- field: timeout
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 查询超时时间(ms)
en-US: Query Timeout(ms)
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: number
# required-true or false
# 是否是必输项 true-必填 false-可选
required: false
# hide-is hide this field and put it in advanced layout
# hide-是否隐藏此参数将其放入高级设置中
hide: true
# default value
# 默认值
defaultValue: 6000
# field-param field key
# field-字段名称标识符
- field: database
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 数据库名称
en-US: Database Name
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: text
# required-true or false
# 是否是必输项 true-必填 false-可选
required: false
# field-param field key
# field-字段名称标识符
- field: username
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 用户名
en-US: Username
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: text
# when type is text, use limit to limit string length
# 当type为text时,用limit表示字符串限制大小
limit: 20
# required-true or false
# 是否是必输项 true-必填 false-可选
required: false
# field-param field key
# field-字段名称标识符
- field: password
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 密码
en-US: Password
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: password
# required-true or false
# 是否是必输项 true-必填 false-可选
required: false
# collect metrics config list
# 采集指标组配置列表
metrics:
# metrics - ping_available
# 监控指标组 - ping_available
- name: ping_available
# metrics group scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel
# priority 0's metrics group is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue
# 指标组调度优先级(0->127)->(优先级高->低) 优先级低的指标组会等优先级高的指标组采集完成后才会被调度, 相同优先级的指标组会并行调度采集
# 优先级为0的指标组为可用性指标组,即它会被首先调度,采集成功才会继续调度其它指标组,采集失败则中断调度
priority: 0
# collect metrics content
# 具体监控指标列表
fields:
# 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 instance是否为实例主键 unit:指标单位
# field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), instance-if is metrics group unique identifier
# field-指标名称, type-指标类型(0-number数字,1-string字符串), unit-指标单位('%','ms','MB'), instance-是否是指标集合唯一标识符字段
- field: responseTime
type: 0
unit: ms
# the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
# 采集协议, 目前支持sql, ssh, http, telnet, wmi, snmp, sdk
protocol: http
# the config content when protocol is http
# 当protocol为http协议时具体的采集配置
http:
# 主机host: ipv4 ipv6 域名
# http host: ipv4 ipv6 domain
# http 主机:ipv4 ipv6 域名
host: ^_^host^_^
# 端口
# http port
# http 端口
port: ^_^port^_^
# url请求接口路径
# url request interface path
# url 请求接口路径
url: /ping
timeout: ^_^timeout^_^
# http method: GET POST PUT DELETE PATCH
# 请求方式 GET POST PUT DELETE PATCH
method: GET
# Whether to enable ssl/tls, that is, http or https, the default is false
# 是否启用ssl/tls,即是http还是https,默认false
ssl: false
# http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule
# 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控
parseType: website
- name: system
Expand Down

0 comments on commit d34655c

Please sign in to comment.