pref: app-mysql.yml internationalization notes (#778)

Co-authored-by: wuguodong2 <wuguodong2@xdf.cn>

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

@@ -13,68 +13,151 @@
 # 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 custom-custom monitoring os-operating system monitoring
+# 监控类型所属类别：service-应用服务监控 db-数据库监控 custom-自定义监控 os-操作系统监控 cn-云原生cloud native network-网络监控
 category: db
+# The monitoring type eg: linux windows tomcat mysql aws...
+# 监控类型 eg: linux windows tomcat mysql aws...
 app: mysql
+# The monitoring i18n name
+# 监控类型国际化名称
 name:
   zh-CN: Mysql数据库
   en-US: Mysql 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
+    # 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: 3306
+  # 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
+    # required-是否是必输项 true-必填 false-可选
     required: false
+    # hide param-true or false
+    # 是否隐藏字段 true or false
     hide: true
+    # 默认值
     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 tag)
+    # type-字段类型,样式(大部分映射input标签type属性)
     type: text
+    # required-true or false
+    # required-是否是必输项 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 tag)
+    # type-字段类型,样式(大部分映射input标签type属性)
     type: text
+    # 当type为text时,用limit表示字符串限制大小
     limit: 20
+    # required-true or false
+    # required-是否是必输项 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 tag)
+    # type-字段类型,样式(大部分映射input标签type属性)
     type: password
+    # required-true or false
+    # required-是否是必输项 true-必填 false-可选
     required: false
+    # field-param field key
+    # field-变量字段标识符
   - field: url
+    # name-param field display i18n name
+    # name-参数字段显示名称
     name:
       zh-CN: URL
       en-US: URL
+    # type-param field type(most mapping the html input tag)
+    # type-字段类型,样式(大部分映射input标签type属性)
     type: text
+    # 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
-    # 指标组调度优先级(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: version
         type: 1
         instance: true
@@ -89,7 +172,8 @@ metrics:
       - field: innodb_buffer_pool_size
         type: 0
         unit: KB
-    # (非必须)监控指标别名，与上面的指标名映射。用于采集接口数据字段不直接是最终指标名称,需要此别名做映射转换
+    # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field
+    # (可选)监控指标别名, 做为中间字段与采集数据字段和指标字段映射转换
     aliasFields:
       - version
       - version_compile_os
@@ -100,36 +184,64 @@ metrics:
       - thread_cache_size
       - table_open_cache
       - innodb_buffer_pool_size
-    # (非必须)指标计算表达式,与上面的别名一起作用,计算出最终需要的指标值
+    # mapping and conversion expressions, use these and aliasField above to calculate metrics value
+    # (可选)指标映射转换计算表达式,与上面的别名一起作用,计算出最终需要的指标值
     # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime
     calculates:
       - port=port
       - datadir=datadir
       - max_connections=max_connections
       - version=version+"_"+version_compile_os+"_"+version_compile_machine
+    # Convert the initial unit of the indicator to the final unit
+    # 将指标的初始单位转化为最终的单位
     units:
       - innodb_buffer_pool_size=B->KB
+    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
+    # 用于监控的协议, eg: sql, ssh, http, telnet, wmi, snmp, sdk
     protocol: jdbc
+    # the config content when protocol is jdbc
+    # 协议为jdbc时的配置内容
     jdbc:
-      # 主机host: ipv4 ipv6 域名
+      # jdbc host
+      # jdbc host
       host: ^_^host^_^
+      # port
       # 端口
       port: ^_^port^_^
-      platform: mariadb
+      # platform name
+      # 平台名称
+      platform: mysql
+      # username
+      # 用户名
       username: ^_^username^_^
+      # password
+      # 密码
       password: ^_^password^_^
+      # database name
+      # 数据库名称
       database: ^_^database^_^
+      # timeout unit：ms
+      # 超时时间 单位：ms
       timeout: ^_^timeout^_^
+      # SQL Query Method：oneRow, multiRow, columns
       # SQL查询方式： oneRow, multiRow, columns
       queryType: columns
       # sql
+      # sql
       sql: show global variables where Variable_name like 'version%' or Variable_name = 'max_connections' or Variable_name = 'datadir' or Variable_name = 'port' or Variable_name = 'thread_cache_size' or Variable_name = 'table_open_cache' or Variable_name = 'innodb_buffer_pool_size';
       url: ^_^url^_^
 
   - name: cache
+    # 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
+    # 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: query_cache_hit_rate
         type: 0
         unit: '%'
@@ -142,33 +254,54 @@ metrics:
       - field: cache_free_memory
         type: 0
         unit: KB
-    # (非必须)监控指标别名，与上面的指标名映射。用于采集接口数据字段不直接是最终指标名称,需要此别名做映射转换
+    # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field
+    # (可选)监控指标别名, 做为中间字段与采集数据字段和指标字段映射转换
     aliasFields:
       - Qcache_hits
       - Qcache_inserts
       - Qcache_free_blocks
       - Qcache_free_memory
-    # (非必须)指标计算表达式,与上面的别名一起作用,计算出最终需要的指标值
+    # mapping and conversion expressions, use these and aliasField above to calculate metrics value
+    # (可选)指标映射转换计算表达式,与上面的别名一起作用,计算出最终需要的指标值
     # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime
     calculates:
       - query_cache_hit_rate= (Qcache_hits + 1) / (Qcache_hits + Qcache_inserts + 1) * 100
       - cache_hits=Qcache_hits
       - cache_inserts=Qcache_inserts
       - cache_free_blocks=Qcache_free_blocks
       - cache_free_memory=Qcache_free_memory
+    # Convert the initial unit of the indicator to the final unit
+    # 将指标的初始单位转化为最终的单位
     units:
       - cache_free_memory=B->KB
+    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
+    # 用于监控的协议, eg: sql, ssh, http, telnet, wmi, snmp, sdk
     protocol: jdbc
+    # the config content when protocol is jdbc
+    # 协议为jdbc时的配置内容
     jdbc:
-      # 主机host: ipv4 ipv6 域名
+      # jdbc host
+      # jdbchost
       host: ^_^host^_^
+      # port
       # 端口
       port: ^_^port^_^
+      # platform name
+      # 平台名称
       platform: mysql
+      # username
+      # 用户名
       username: ^_^username^_^
+      # password
+      # 密码
       password: ^_^password^_^
+      # database name
+      # 数据库名称
       database: ^_^database^_^
+      # timeout unit：ms
+      # 超时时间 单位：ms
       timeout: ^_^timeout^_^
+      # SQL Query Method：oneRow, multiRow, columns
       # SQL查询方式： oneRow, multiRow, columns
       queryType: columns
       # sql