# Licensed to the Apache Software Foundation (ASF) under one or more # contributor license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright ownership. # The ASF licenses this file to You under the Apache License, Version 2.0 # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # 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 # when type is text, use limit to limit string length # 当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 # 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-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 - field: port type: 1 - field: datadir type: 1 - field: max_connections type: 0 - field: thread_cache_size type: 0 - 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 - version_compile_machine - port - datadir - max_connections - 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: # mysql host: ipv4 ipv6 host # 主机host: ipv4 ipv6 域名 host: ^_^host^_^ # mysql 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 # 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 # 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: query_cache_hit_rate type: 0 unit: '%' - field: cache_hits type: 0 - field: cache_inserts type: 0 - field: cache_free_blocks type: 0 - 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: # 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 sql: show global status like 'QCache%'; url: ^_^url^_^ - name: performance priority: 1 fields: - field: questions type: 0 - field: qps type: 0 # (非必须)监控指标别名，与上面的指标名映射。用于采集接口数据字段不直接是最终指标名称,需要此别名做映射转换 aliasFields: - uptime - questions # (非必须)指标计算表达式,与上面的别名一起作用,计算出最终需要的指标值 # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime calculates: - qps=uptime / questions protocol: jdbc jdbc: # 主机host: ipv4 ipv6 域名 host: ^_^host^_^ # 端口 port: ^_^port^_^ platform: mysql username: ^_^username^_^ password: ^_^password^_^ database: ^_^database^_^ timeout: ^_^timeout^_^ # SQL查询方式： oneRow, multiRow, columns queryType: columns # sql sql: show global status where Variable_name = 'questions' or Variable_name = 'uptime'; url: ^_^url^_^ - name: innodb priority: 1 fields: # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 instance是否为实例主键 unit:指标单位 - field: innodb_data_reads type: 0 unit: Times - field: innodb_data_writes type: 0 unit: Times - field: innodb_data_read type: 0 unit: KB - field: innodb_data_written type: 0 unit: KB - field: innodb_buffer_hit_rate type: 0 unit: '%' aliasFields: - Innodb_data_reads - Innodb_data_writes - Innodb_data_read - Innodb_data_written - Innodb_buffer_pool_read_requests - Innodb_buffer_pool_read_ahead - Innodb_buffer_pool_reads # (非必须)指标计算表达式,与上面的别名一起作用,计算出最终需要的指标值 # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime calculates: - innodb_buffer_hit_rate= (Innodb_buffer_pool_read_requests + 1) / (Innodb_buffer_pool_read_requests + Innodb_buffer_pool_read_ahead + Innodb_buffer_pool_reads + 1) * 100 - innodb_data_reads=Innodb_data_reads - innodb_data_writes=Innodb_data_writes - innodb_data_read=Innodb_data_read - innodb_data_written=Innodb_data_written units: - innodb_data_read=B->KB - innodb_data_written=B->KB protocol: jdbc jdbc: # 主机host: ipv4 ipv6 域名 host: ^_^host^_^ # 端口 port: ^_^port^_^ platform: mysql username: ^_^username^_^ password: ^_^password^_^ database: ^_^database^_^ timeout: ^_^timeout^_^ # SQL查询方式： oneRow, multiRow, columns queryType: columns # sql sql: show global status where Variable_name like 'innodb%'; url: ^_^url^_^ - name: status priority: 1 fields: # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 instance是否为实例主键 unit:指标单位 - field: uptime type: 0 unit: s - field: com_select type: 0 - field: com_insert type: 0 - field: com_update type: 0 - field: com_delete type: 0 - field: com_commit type: 0 - field: com_rollback type: 0 - field: threads_created type: 0 - field: threads_connected type: 0 - field: threads_cached type: 0 - field: threads_running type: 0 - field: qps type: 0 # (非必须)监控指标别名，与上面的指标名映射。用于采集接口数据字段不直接是最终指标名称,需要此别名做映射转换 aliasFields: - uptime - com_select - com_insert - com_update - com_delete - com_commit - com_rollback - threads_created - threads_connected - threads_cached - threads_running - questions # (非必须)指标计算表达式,与上面的别名一起作用,计算出最终需要的指标值 # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime calculates: - qps=uptime / questions protocol: jdbc jdbc: # 主机host: ipv4 ipv6 域名 host: ^_^host^_^ # 端口 port: ^_^port^_^ platform: mysql username: ^_^username^_^ password: ^_^password^_^ database: ^_^database^_^ timeout: ^_^timeout^_^ # SQL查询方式： oneRow, multiRow, columns queryType: columns # sql sql: show global status where Variable_name like 'thread%' or Variable_name = 'com_select' or Variable_name = 'com_insert' or Variable_name = 'com_update' or Variable_name = 'com_delete' or Variable_name = 'com_commit' or Variable_name = 'com_rollback' or Variable_name = 'questions' or Variable_name = 'uptime'; url: ^_^url^_^ - name: handler priority: 2 fields: # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 instance是否为实例主键 unit:指标单位 - field: handler_commit type: 0 - field: handler_delete type: 0 - field: handler_write type: 0 - field: handler_update type: 0 - field: handler_discover type: 0 - field: handler_prepare type: 0 - field: handler_read_first type: 0 - field: handler_read_rnd type: 0 - field: handler_read_next type: 0 - field: handler_read_rnd_next type: 0 - field: handler_read_key type: 0 - field: handler_external_lock type: 0 protocol: jdbc jdbc: # 主机host: ipv4 ipv6 域名 host: ^_^host^_^ # 端口 port: ^_^port^_^ platform: mysql username: ^_^username^_^ password: ^_^password^_^ database: ^_^database^_^ timeout: ^_^timeout^_^ # SQL查询方式： oneRow, multiRow, columns queryType: columns # sql sql: show global status like 'Handler%'; url: ^_^url^_^ - name: connection priority: 2 fields: - field: connections type: 0 - field: max_used_connections type: 0 - field: aborted_connects type: 0 - field: aborted_clients type: 0 protocol: jdbc jdbc: # 主机host: ipv4 ipv6 域名 host: ^_^host^_^ # 端口 port: ^_^port^_^ platform: mysql username: ^_^username^_^ password: ^_^password^_^ database: ^_^database^_^ timeout: ^_^timeout^_^ # SQL查询方式： oneRow, multiRow, columns queryType: columns # sql sql: show global status; url: ^_^url^_^ - name: thread priority: 2 fields: - field: threads_created type: 0 - field: threads_connected type: 0 - field: threads_cached type: 0 - field: threads_running type: 0 protocol: jdbc jdbc: # 主机host: ipv4 ipv6 域名 host: ^_^host^_^ # 端口 port: ^_^port^_^ platform: mysql username: ^_^username^_^ password: ^_^password^_^ database: ^_^database^_^ timeout: ^_^timeout^_^ # SQL查询方式： oneRow, multiRow, columns queryType: columns # sql sql: show global status like 'thread%'; url: ^_^url^_^ - name: tmp priority: 2 fields: - field: created_tmp_tables type: 0 - field: created_tmp_disk_tables type: 0 - field: created_tmp_files type: 0 protocol: jdbc jdbc: # 主机host: ipv4 ipv6 域名 host: ^_^host^_^ # 端口 port: ^_^port^_^ platform: mysql username: ^_^username^_^ password: ^_^password^_^ database: ^_^database^_^ timeout: ^_^timeout^_^ # SQL查询方式： oneRow, multiRow, columns queryType: columns # sql sql: show global status where Variable_name like '%tmp%'; url: ^_^url^_^ - name: select_type priority: 2 fields: - field: select_full_join type: 0 - field: select_full_range_join type: 0 - field: select_range type: 0 - field: select_range_check type: 0 - field: select_scan type: 0 protocol: jdbc jdbc: # 主机host: ipv4 ipv6 域名 host: ^_^host^_^ # 端口 port: ^_^port^_^ platform: mysql username: ^_^username^_^ password: ^_^password^_^ database: ^_^database^_^ timeout: ^_^timeout^_^ # SQL查询方式： oneRow, multiRow, columns queryType: columns # sql sql: show global status where Variable_name like 'select%'; url: ^_^url^_^ - name: sort priority: 2 fields: - field: sort_rows type: 0 - field: sort_range type: 0 - field: sort_merge_passes type: 0 - field: sort_scan type: 0 protocol: jdbc jdbc: # 主机host: ipv4 ipv6 域名 host: ^_^host^_^ # 端口 port: ^_^port^_^ platform: mysql username: ^_^username^_^ password: ^_^password^_^ database: ^_^database^_^ timeout: ^_^timeout^_^ # SQL查询方式： oneRow, multiRow, columns queryType: columns # sql sql: show global status where Variable_name like 'sort%'; url: ^_^url^_^ - name: table_lock priority: 2 fields: - field: table_locks_immediate type: 0 - field: table_locks_waited type: 0 protocol: jdbc jdbc: # 主机host: ipv4 ipv6 域名 host: ^_^host^_^ # 端口 port: ^_^port^_^ platform: mysql username: ^_^username^_^ password: ^_^password^_^ database: ^_^database^_^ timeout: ^_^timeout^_^ # SQL查询方式： oneRow, multiRow, columns queryType: columns # sql sql: show global status where Variable_name like 'table_lock%'; url: ^_^url^_^ - name: process_state priority: 2 fields: - field: state type: 1 instance: true - field: num type: 0 protocol: jdbc jdbc: # 主机host: ipv4 ipv6 域名 host: ^_^host^_^ # 端口 port: ^_^port^_^ platform: mysql username: ^_^username^_^ password: ^_^password^_^ database: ^_^database^_^ timeout: ^_^timeout^_^ # SQL查询方式： oneRow, multiRow, columns queryType: multiRow # sql sql: select state, count(*) as num from information_schema.PROCESSLIST where state != '' group by state; url: ^_^url^_^ - name: slow_sql priority: 2 fields: - field: id type: 1 instance: true - field: sql_text type: 0 - field: start_time type: 1 - field: db type: 1 - field: query_time type: 1 aliasFields: - sql_text - start_time - db - query_time # (非必须)指标计算表达式,与上面的别名一起作用,计算出最终需要的指标值 # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime calculates: - id= start_time + sql_text protocol: jdbc jdbc: # 主机host: ipv4 ipv6 域名 host: ^_^host^_^ # 端口 port: ^_^port^_^ platform: mysql username: ^_^username^_^ password: ^_^password^_^ database: ^_^database^_^ timeout: ^_^timeout^_^ # SQL查询方式： oneRow, multiRow, columns queryType: multiRow # sql sql: select sql_text, start_time, db, query_time from mysql.slow_log; url: ^_^url^_^