[manager] feature:i18n for app-mongodb.yml and app-mysql.yml (#794)

* [manager] feature:i18n for app-mongodb.yml * [manager] feature:i18n for app-mongodb.yml and app-mysql.yml * Update manager/src/main/resources/define/app-mongodb.yml ---------
apache · Mar 27, 2023 · 7a31a88 · 7a31a88
1 parent ec50a95
commit 7a31a88
Show file tree

Hide file tree

Showing 2 changed files with 64 additions and 6 deletions.
diff --git a/manager/src/main/resources/define/app-mongodb.yml b/manager/src/main/resources/define/app-mongodb.yml
@@ -13,25 +13,54 @@
 # 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: mongodb
+# The monitoring i18n name
+# 监控类型国际化名称
 name:
   zh-CN: MongoDB数据库
   en-US: MongoDB
+# 监控所需输入参数定义(根据定义渲染页面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: 27017
   - field: username
     name:
@@ -51,6 +80,8 @@ params:
       zh-CN: 数据库
       en-US: database
     type: text
+    # when type is text, use limit to limit string length
+    # 当type为text时,用limit表示字符串限制大小
     limit: 20
     required: true
     defaultValue: 'test'
@@ -62,14 +93,29 @@ params:
     limit: 20
     required: true
     defaultValue: 'admin'
+# can get status information and other config params of MongoDB by running Diagnostic Commands
 # 可以通过执行 Diagnostic Commands 获取 mongodb 的状态信息以及一些性能、配置参数
 # https://www.mongodb.com/docs/manual/reference/command/nav-diagnostic/
+# name must be Diagnostic Commands 's name,support . way to get subdocument, should be careful about if the user that need connection have the right to run command
 # name 必须为 Diagnostic Commands 名称，支持 . 方式获取子文档，需注意连接的用户是否具有相应命令的权限
+
+# collect metrics config list
+# 采集指标组配置列表
 metrics:
   # https://www.mongodb.com/docs/manual/reference/command/buildInfo/#usage
+  # metrics - buildInfo
+  # 监控指标组 - buildInfo
   - name: buildInfo
+    # 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-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: gitVersion
@@ -84,14 +130,24 @@ metrics:
         type: 1
       - field: javascriptEngine
         type: 1
+    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
     protocol: mongodb
+    # the config content when protocol is mongodb
     mongodb:
+      #mongodb host:
       host: ^_^host^_^
+      #mongodb port
       port: ^_^port^_^
+      #user's username
       username: ^_^username^_^
+      #user's password
       password: ^_^password^_^
+      #mongodb's database
       database: ^_^database^_^
+      #Specifies the database in which the User is created
+      #指定创建User的数据库
       authenticationDatabase: ^_^authenticationDatabase^_^
+      #The buildInfo command is an administrative command which returns a build summary for the current mongod.
       command: buildInfo
 
   # https://www.mongodb.com/docs/manual/reference/command/serverStatus/#metrics

diff --git a/manager/src/main/resources/define/app-mysql.yml b/manager/src/main/resources/define/app-mysql.yml
@@ -17,7 +17,7 @@
 # 监控类型所属类别：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...
+# 监控类型 eg: linux windows tomcat mysql aws..
 app: mysql
 # The monitoring i18n name
 # 监控类型国际化名称
@@ -105,6 +105,7 @@ params:
     # type-param field type(most mapping the html input tag)
     # type-字段类型,样式(大部分映射input标签type属性)
     type: text
+    # when type is text, use limit to limit string length
     # 当type为text时,用limit表示字符串限制大小
     limit: 20
     # required-true or false
@@ -173,7 +174,7 @@ metrics:
         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
@@ -185,7 +186,7 @@ metrics:
       - 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
@@ -202,10 +203,10 @@ metrics:
     # the config content when protocol is jdbc
     # 协议为jdbc时的配置内容
     jdbc:
-      # jdbc host
-      # jdbc host
+      # mysql host: ipv4 ipv6 host
+      # 主机host: ipv4 ipv6 域名
       host: ^_^host^_^
-      # port
+      # mysql port
       # 端口
       port: ^_^port^_^
       # platform name
@@ -229,6 +230,7 @@ metrics:
       # 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';
+      #JDBC url
       url: ^_^url^_^
 
   - name: cache