From 0e9d1060d2c6da3d8bfc2ff321b6076222060542 Mon Sep 17 00:00:00 2001 From: MrYZhou <44339602+MrYZhou@users.noreply.github.com> Date: Tue, 28 Mar 2023 23:22:27 +0800 Subject: [PATCH] update app-ping.yml,app-port.yml comment (#813) --- .../src/main/resources/define/app-ping.yml | 52 ++++++++++++++-- .../src/main/resources/define/app-port.yml | 61 ++++++++++++++++++- 2 files changed, 107 insertions(+), 6 deletions(-) diff --git a/manager/src/main/resources/define/app-ping.yml b/manager/src/main/resources/define/app-ping.yml index 63ea1beac0b..7a221d52075 100644 --- a/manager/src/main/resources/define/app-ping.yml +++ b/manager/src/main/resources/define/app-ping.yml @@ -13,44 +13,86 @@ # See the License for the specific language governing permissions and # limitations under the License. +# Category of this monitoring type: +# service - application service monitoring +# db - database monitoring +# custom - custom monitoring +# os - operating system monitoring # 此监控类型所属类别：service-应用服务监控 db-数据库监控 custom-自定义监控 os-操作系统监控 category: service +# Monitoring application type name (consistent with file name) eg: linux windows tomcat mysql aws... # 监控应用类型名称(与文件名保持一致) eg: linux windows tomcat mysql aws... app: ping +# 监控类型国际化名称 name: zh-CN: PING连通性 en-US: PING CONNECT +# 监控所需输入参数定义(根据定义渲染页面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: timeout + # name-param field display i18n name + # name-参数字段显示名称 name: zh-CN: Ping超时时间(ms) en-US: Ping Timeout(ms) + # 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,100000]' + # required-true or false + # 是否是必输项 true-必填 false-可选 required: true + # default value 6000 + # 默认值 6000 defaultValue: 6000 +# collect metrics config list +# 采集指标组配置列表 metrics: + # First monitoring indicator group "cpu" # 第一个监控指标组 cpu + # Note: The built-in monitoring indicators include (responseTime - response time) # 注意：内置监控指标有 (responseTime - 响应时间) - name: summary - # 指标组调度优先级(0-127)越小优先级越高,优先级低的指标组会等优先级高的指标组采集完成后才会被调度,相同优先级的指标组会并行调度采集 + # 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 - # 指标组中的具体监控指标 + # 指标信息 包括 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-是否是指标集合唯一标识符字段 fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 instance是否为实例主键 unit:指标单位 - field: responseTime type: 0 unit: ms -# 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk + # Monitoring and collection protocols eg: sql, ssh, http, telnet, wmi, snmp, sdk + # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk protocol: icmp -# 当protocol为ping协议时具体的采集配置 + # Specific collection configuration when the protocol is the ping protocol + # 当protocol为ping协议时具体的采集配置 icmp: + # icmp host + # icmp 主机 host: ^_^host^_^ + # timeout + # 超时时间 timeout: ^_^timeout^_^ diff --git a/manager/src/main/resources/define/app-port.yml b/manager/src/main/resources/define/app-port.yml index 53a544dc674..7808d89d48d 100644 --- a/manager/src/main/resources/define/app-port.yml +++ b/manager/src/main/resources/define/app-port.yml @@ -13,44 +13,103 @@ # 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: service +# The monitoring type eg: linux windows tomcat mysql aws... +# 监控类型 eg: linux windows tomcat mysql aws... app: port +# 监控类型国际化名称 name: zh-CN: 端口可用性 en-US: PORT TELNET +# 监控所需输入参数定义(根据定义渲染页面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: 端口 en-US: 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 80 + # 默认值 80 defaultValue: 80 + # field-param field key + # field-字段名称标识符 - field: timeout + # name-param field display i18n name + # name-参数字段显示名称 name: zh-CN: 连接超时时间(ms) en-US: Connect Timeout(ms) + # 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,100000]' + # required-true or false + # 是否是必输项 true-必填 false-可选 required: true + # default value 6000 + # 默认值 6000 defaultValue: 6000 +# collect metrics config list +# 采集指标组配置列表 metrics: + # metrics - summary + # 监控指标组 - summary - name: summary + # 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 + # 指标信息 包括 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-是否是指标集合唯一标识符字段 fields: - 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: telnet -# 当protocol为telnet协议时具体的采集配置 + # Specific collection configuration when protocol is telnet protocol + # 当protocol为telnet协议时具体的采集配置 telnet: + # telnet host + # 远程登录主机 host: ^_^host^_^ + # port + # 端口 port: ^_^port^_^ + # timeout + # 超时时间 timeout: ^_^timeout^_^