update app-jetty.yml comment

manager/src/main/resources/define/app-jetty.yml

@@ -1,56 +1,124 @@
+# 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: mid
+# The monitoring type eg: linux windows tomcat mysql aws...
+# 监控类型 eg: linux windows tomcat mysql aws...
 app: jetty
+# The monitoring i18n name
+# 监控类型国际化名称
 name:
   zh-CN: Jetty应用服务器
   en-US: Jetty AppServer
+# 监控所需输入参数定义(根据定义渲染页面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: JMX端口
       en-US: JMX 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
+    # port default value
     # 端口默认值
     defaultValue: 1099
+    # field-param field key
+    # field-变量字段标识符
   - field: url
+    # name-param field display i18n name
+    # name-参数字段显示名称
     name:
       zh-CN: JMX URL
       en-US: JMX URL
+    # type-param field type(most mapping the html input type)
+    # type-字段类型,样式(大部分映射input标签type属性)
     type: text
+    # required-true or false
+    # required-是否是必输项 true-必填 false-可选
     required: false
+    # hide param-true or false
+    # 是否隐藏字段 true or false
     hide: true
+    # 参数输入框提示信息
+    # param field input placeholder
     placeholder: 'service:jmx:rmi:///jndi/rmi://host:port/jmxrmi'
+    # 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 type)
+    # type-字段类型,样式(大部分映射input标签type属性)
     type: password
+    # required-true or false
+    # required-是否是必输项 true-必填 false-可选
     required: false
+    # hide param-true or false
+    # 是否隐藏字段 true or false
     hide: true
+# collect metrics config list
+# 采集指标组配置列表
 metrics:
+  # metrics - basic
+  # 监控指标组 - basic
   - name: basic
+    # 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
+    # monitor metric content in metrics group
+    # 指标组中的具体监控指标
     fields:
+      # 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: VmName
         type: 1
       - field: VmVendor
@@ -60,28 +128,48 @@ metrics:
       - field: Uptime
         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: jmx
+    # the config content when protocol is http
+    # 协议为jmx时的配置内容
     jmx:
+      # Host: ipv4 ipv6 domain name
       # 主机host: ipv4 ipv6 域名
       host: ^_^host^_^
+      # port
       # 端口
       port: ^_^port^_^
       username: ^_^username^_^
       password: ^_^password^_^
       # jmx mbean object name
+      # jmx-mbean对象名称
       objectName: java.lang:type=Runtime
       url: ^_^url^_^
-
+    # metrics - server
+    # 监控指标组 - server
   - name: server
+    # 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: 1
+    # monitor metric content in metrics group
+    # 指标组中的具体监控指标
     fields:
+    # 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: version
         type: 1
       - field: state
         type: 1
       - field: startupTime
         type: 0
+    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
+    # 用于监控的协议, 比如: sql, ssh, http, telnet, wmi, snmp, sdk
     protocol: jmx
+    # the config content when protocol is http
+    # 协议为jmx时的配置内容
     jmx:
       # 主机host: ipv4 ipv6 域名
       host: ^_^host^_^
@@ -92,14 +180,19 @@ metrics:
       # jmx mbean object name
       objectName: org.eclipse.jetty.server:type=server,id=0
       url: ^_^url^_^
-
+    # metrics - server
+    # 监控指标组 - server
   - name: memory_pool
-    # 指标组调度优先级(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: 1
+    # monitor metric content in metrics group
     # 指标组中的具体监控指标
     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: name
         type: 1
         instance: true
@@ -111,19 +204,28 @@ metrics:
         type: 0
       - field: used
         type: 0
+    # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field
+    # (可选)监控指标别名, 做为中间字段与采集数据字段和指标字段映射转换
     aliasFields:
       - Name
       - Usage->committed
       - Usage->init
       - Usage->max
       - Usage->used
+    # mapping and conversion expressions, use these and aliasField above to calculate metrics value
+    # (可选)指标映射转换计算表达式,与上面的别名一起作用,计算出最终需要的指标值
+    # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime
     calculates:
       - name=Name
       - committed=Usage->committed
       - init=Usage->init
       - max=Usage->max
       - used=Usage->used
+    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
+    # 用于监控的协议, 比如: sql, ssh, http, telnet, wmi, snmp, sdk
     protocol: jmx
+    # the config content when protocol is http
+    # 协议为jmx时的配置内容
     jmx:
       # 主机host: ipv4 ipv6 域名
       host: ^_^host^_^
@@ -133,19 +235,30 @@ metrics:
       password: ^_^password^_^
       objectName: java.lang:type=MemoryPool,name=*
       url: ^_^url^_^
-
+    # metrics - class_loading
+    # 监控指标组 - class_loading
   - name: class_loading
+    # 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: 1
+    # monitor metric content in metrics group
     # 指标组中的具体监控指标
     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: LoadedClassCount
         type: 0
       - field: TotalLoadedClassCount
         type: 0
       - field: UnloadedClassCount
         type: 0
+    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
+    # 用于监控的协议, 比如: sql, ssh, http, telnet, wmi, snmp, sdk
     protocol: jmx
+    # the config content when protocol is http
+    # 协议为jmx时的配置内容
     jmx:
       # 主机host: ipv4 ipv6 域名
       host: ^_^host^_^
@@ -155,12 +268,19 @@ metrics:
       password: ^_^password^_^
       objectName: java.lang:type=ClassLoading
       url: ^_^url^_^
-
+    # metrics - thread
+    # 监控指标组 - thread
   - name: thread
+    # 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: 1
+    # monitor metric content in metrics group
     # 指标组中的具体监控指标
     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: TotalStartedThreadCount
         type: 0
       - field: ThreadCount
@@ -175,7 +295,11 @@ metrics:
       - field: CurrentThreadCpuTime
         type: 0
         unit: s
+    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
+    # 用于监控的协议, 比如: sql, ssh, http, telnet, wmi, snmp, sdk
     protocol: jmx
+    # the config content when protocol is http
+    # 协议为jmx时的配置内容
     jmx:
       # 主机host: ipv4 ipv6 域名
       host: ^_^host^_^
@@ -185,10 +309,19 @@ metrics:
       password: ^_^password^_^
       objectName: java.lang:type=Threading
       url: ^_^url^_^
-
+    # metrics - webapp
+    # 监控指标组 - webapp
   - name: webapp
+    # 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: 2
+    # monitor metric content in metrics group
+    # 指标组中的具体监控指标
     fields:
+      # 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: displayName
         type: 1
         instance: true
@@ -200,7 +333,11 @@ metrics:
         type: 1
       - field: shutdown
         type : 1
+    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
+    # 用于监控的协议, 比如: sql, ssh, http, telnet, wmi, snmp, sdk
     protocol: jmx
+    # the config content when protocol is http
+    # 协议为jmx时的配置内容
     jmx:
       # 主机host: ipv4 ipv6 域名
       host: ^_^host^_^