diff --git a/manager/src/main/resources/define/app-a_example.yml b/manager/src/main/resources/define/app-a_example.yml index 32f2c50b150..153b0fd09af 100644 --- a/manager/src/main/resources/define/app-a_example.yml +++ b/manager/src/main/resources/define/app-a_example.yml @@ -13,67 +13,124 @@ # See the License for the specific language governing permissions and # limitations under the License. - -# 此监控类型所属类别:service-应用服务监控 db-数据库监控 custom-自定义监控 os-操作系统监控 cn-云原生cloud native +# The monitoring type category:service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring +# 监控类型所属类别:service-应用服务监控 db-数据库监控 custom-自定义监控 os-操作系统监控 cn-云原生cloud native network-网络监控 category: custom -# 监控应用类型(与文件名保持一致) eg: linux windows tomcat mysql aws... +# The monitoring type eg: linux windows tomcat mysql aws... +# 监控类型 eg: linux windows tomcat mysql aws... app: a_example +# The monitoring i18n name +# 监控类型国际化名称 name: zh-CN: 模拟应用 en-US: EXAMPLE APP +# 监控所需输入参数定义(根据定义渲染页面UI) +# Input params define for monitoring(render web ui by the definition) params: - # field-字段名称标识符 + # 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 - # 是否是必输项 true-必填 false-可选 + # required-true or false + # required-是否是必输项 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 + # required-是否是必输项 true-必填 false-可选 required: true - # 端口默认值 + # default value + # 默认值 defaultValue: 80 # 参数输入框提示信息 + # param field input placeholder placeholder: '请输入端口' + # 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 + # required-是否是必输项 true-必填 false-可选 required: false + # hide param-true or false + # 是否隐藏字段 true or false hide: true + # 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 tag) + # type-字段类型,样式(大部分映射input标签type属性) type: password + # required-true or false + # required-是否是必输项 true-必填 false-可选 required: false + # hide param-true or false + # 是否隐藏字段 true or false hide: true + # field-param field key + # field-变量字段标识符 - field: ssl + # name-param field display i18n name + # name-参数字段显示名称 name: zh-CN: 启动SSL en-US: SSL - # 当type为boolean时,前端用switch展示开关 + # type-param field type(boolean mapping the html switch tag) + # type-当type为boolean时,前端用switch展示开关 type: boolean + # required-true or false + # required-是否是必输项 true-必填 false-可选 required: false + # field-param field key + # field-变量字段标识符 - field: method + # name-param field display i18n name + # name-参数字段显示名称 name: zh-CN: 请求方式 en-US: Method + # type-param field type(radio mapping the html radio tag) + # type-当type为radio时,前端用radio展示开关 type: radio + # required-true or false + # required-是否是必输项 true-必填 false-可选 required: true - # 当type为radio单选框,checkbox复选框时,option表示可选项值列表 {name1:value1,name2:value2} + # when type is radio checkbox, use option to show optional values {name1:value1,name2:value2} + # 当type为radio单选框, checkbox复选框时, option表示可选项值列表 {name1:value1,name2:value2} options: - label: GET value: GET @@ -83,25 +140,42 @@ params: value: PUT - label: DELETE value: DELETE + # field-param field key + # field-变量字段标识符 - field: headers + # name-param field display i18n name + # name-参数字段显示名称 name: zh-CN: 请求Headers en-US: Headers + # type-param field type(key-value mapping the html key-value input tags) + # type-字段类型(key-value映射为前端key-value的双input格式渲染) type: key-value + # required-true or false + # required-是否是必输项 true-必填 false-可选 required: false + # when type is key-value, use keyAlias to config key alias name + # 当字段类型为key-value时, 使用keyAlias配置key的展示别名 keyAlias: Header Name + # when type is key-value, use valueAlias to config value alias name + # 当字段类型为key-value时, 使用valueAlias配置value的展示别名 valueAlias: Header Value -# 指标组列表 +# collect metrics config list +# 采集指标组配置列表 metrics: -# 第一个监控指标组 cpu -# 注意:内置监控指标有 (responseTime - 响应时间) + # metrics - cpu + # 监控指标组 - cpu - name: cpu - # 指标组调度优先级(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 - # 指标组中的具体监控指标 + # 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: hostname type: 1 instance: true @@ -113,7 +187,8 @@ metrics: - field: waitTime type: 0 unit: s -# (非必须)监控指标别名,与上面的指标名映射。用于采集接口数据字段不直接是最终指标名称,需要此别名做映射转换 + # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field + # (可选)监控指标别名, 做为中间字段与采集数据字段和指标字段映射转换 aliasFields: - hostname - core1 @@ -121,42 +196,43 @@ metrics: - usage - allTime - runningTime -# (非必须)指标计算表达式,与上面的别名一起作用,计算出最终需要的指标值 -# eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime + # mapping and conversion expressions, use these and aliasField above to calculate metrics value + # (可选)指标映射转换计算表达式,与上面的别名一起作用,计算出最终需要的指标值 + # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime calculates: - hostname=hostname - cores=core1+core2 - usage=usage - waitTime=allTime-runningTime -# 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk protocol: http -# 当protocol为http协议时具体的采集配置 + # the config content when protocol is http http: - # 主机host: ipv4 ipv6 域名 + # http host: ipv4 ipv6 domain host: ^_^host^_^ - # 端口 + # http port port: ^_^port^_^ - # url请求接口路径 + # http url url: /metrics/cpu - # 请求方式 GET POST PUT DELETE PATCH + # http method: GET POST PUT DELETE PATCH method: GET - # 是否启用ssl/tls,即是http还是https,默认false + # if enabled https ssl: false - # 请求头内容 + # http request header content headers: ^_^headers^_^: ^_^headers^_^ - # 请求参数内容 + # http request params params: param1: param1 param2: param2 - # 认证 + # http auth authorization: - # 认证方式: Basic Auth, Digest Auth, Bearer Token + # http auth type: Basic Auth, Digest Auth, Bearer Token type: Basic Auth basicAuthUsername: ^_^username^_^ basicAuthPassword: ^_^password^_^ - # 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控 - # todo xmlPath-xmlPath脚本,prometheus-Prometheus数据规则 + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule + # http 响应数据解析方式: default-系统规则, jsonPath-jsonPath脚本, website-网站可用性指标监控, prometheus-Prometheus数据规则 parseType: jsonPath parseScript: '$'