Skip to content

Commit

Permalink
update app-docker.yml comment (#804)
Browse files Browse the repository at this point in the history
翻译app-docker.yml文件中标定注释
  • Loading branch information
yk-flight authored Mar 28, 2023
1 parent ff9ac77 commit 2c5180a
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions manager/src/main/resources/define/app-docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,26 @@ name:
zh-CN: Docker
en-US: Docker
params:
# field - field name identifier
# field-字段名称标识符
- field: host
# name - parameter field display name
# name-参数字段显示名称
name:
zh-CN: 主机Host
en-US: Host
# type-field type, style (most map input tag type attribute)
# type-字段类型,样式(大部分映射input标签type属性)
type: host
# Is it mandatory? true-required false-optional
# 是否是必输项 true-必填 false-可选
required: true
- field: port
name:
zh-CN: 端口
en-US: Port
type: number
# When type is number, use range to represent the range
# 当type为number时,用range表示范围
range: '[0,65535]'
required: true
Expand All @@ -42,16 +47,21 @@ params:
name:
zh-CN: 启动SSL
en-US: SSL
# shen the type is boolean, the front end uses switch to display the switch
# 当type为boolean时,前端用switch展示开关
type: boolean
required: false
metrics:
- name: system
# The smaller the index group scheduling priority (0-127), the higher the priority. The index group with low priority will not be scheduled until the collection of index groups with high priority is completed. The index groups with the same priority will be scheduled and collected 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
# specific monitoring indicators in the indicator group
# 指标组中的具体监控指标
fields:
# Indicator information includes field name type field type: 0-number, 1-string whether instance is the primary key of the instance unit: indicator unit
# 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 instance是否为实例主键 unit:指标单位
- field: name
type: 1
Expand Down Expand Up @@ -109,27 +119,38 @@ metrics:
units:
- mem_total=B->MB
protocol: http
# When the protocol is the http protocol, the specific collection configuration
# 当protocol为http协议时具体的采集配置
http:
# Host host: ipv4 ipv6 domain name
# 主机host: ipv4 ipv6 域名
host: ^_^host^_^
# port
# 端口
port: ^_^port^_^
# url request interface path
# url请求接口路径
url: /info
# request 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: ^_^ssl^_^
# response data analysis method: default-system rules, jsonPath-jsonPath script, website-api usability indicator monitoring
# 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-api可用性指标监控
parseType: default

- name: containers
# The smaller the priority value (0-127), the higher the priority of the metrics group. Lower-priority metrics groups will be scheduled after higher-priority metrics groups have been collected. Metrics groups with the same priority will be scheduled to collect data 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: 1
# specific monitoring indicators in the indicator group
# 指标组中的具体监控指标
fields:
# Indicator information includes field name type field type: 0-number, 1-string whether instance is the primary key of the instance unit: indicator unit
# 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 instance是否为实例主键 unit:指标单位
- field: id
type: 1
Expand Down Expand Up @@ -157,20 +178,28 @@ metrics:
- command = Command
- state = State
- status = Status
# Protocols used for monitoring and collection eg: sql, ssh, http, telnet, wmi, snmp, sdk
# 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk
protocol: http
# When the protocol is the http protocol, the specific collection configuration
# 当protocol为http协议时具体的采集配置
http:
# Host host: ipv4 ipv6 domain name
# 主机host: ipv4 ipv6 域名
host: ^_^host^_^
# port
# 端口
port: ^_^port^_^
# url request interface path
# url请求接口路径
url: /containers/json
# # request 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: ^_^ssl^_^
# Response data analysis method: default-system rules, jsonPath-jsonPath script, website-api usability indicator monitoring
# 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-api可用性指标监控
parseType: jsonPath
parseScript: '$.*'
Expand Down Expand Up @@ -218,18 +247,24 @@ metrics:
- used_memory=B->MB
protocol: http
http:
# Host host: ipv4 ipv6 domain name
# 主机host: ipv4 ipv6 域名
host: ^_^host^_^
# port
# 端口
port: ^_^port^_^
# url request interface path
# url请求接口路径
url: /containers/^o^id^o^/stats
# request 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: ^_^ssl^_^
params:
stream: false
# Response data analysis method: default-system rules, jsonPath-jsonPath script, website-api usability indicator monitoring
# 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-api可用性指标监控
parseType: jsonPath
parseScript: '$'

0 comments on commit 2c5180a

Please sign in to comment.