# 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: service # The monitoring type eg: linux windows tomcat mysql aws... # 监控类型 eg: linux windows tomcat mysql aws... app: jvm # The monitoring i18n name # 监控类型国际化名称 name: zh-CN: JVM虚拟机 en-US: JVM # The description and help of this monitoring type # 监控类型的帮助描述信息 help: zh-CN: HertzBeat 使用 JMX 协议对 JVM 虚拟机的通用性能指标进行采集监控。⚠️注意:您需要在 JVM 应用中开启 JMX 服务,应用启动时添加 JVM 参数, 可自定义暴露端口,对外IP。点击查看开启步骤。 en-US: "HertzBeat using JMX protocol to monitor and collect general performance metric of virtual machine. ⚠️Note: You need to enable JVM services in JVM application, and add the JVM parameters when the application start. You can also customize external IP address and exposed port.Click here to view the activation steps." zh-TW: HertzBeat使用JMX協定對JVM虛擬機器的通用性能指標進行採集監控。 ⚠️ 注意:您需要在JVM應用中開啟JMX服務,應用啟動時添加JVM參數,可自定義暴露埠,對外IP。點擊查看開啟步驟。 helpLink: zh-CN: https://hertzbeat.com/zh-cn/docs/help/jvm/ en-US: https://hertzbeat.com/docs/help/jvm/ # Input params define for monitoring(render web ui by the definition) # 监控所需输入参数定义(根据定义渲染页面UI) 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: 端口 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: 9999 # 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 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 # 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: VmName type: 1 - field: VmVendor type: 1 - field: VmVersion type: 1 - 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 jmx jmx: # host: ipv4 ipv6 domain # 主机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^_^ - name: memory_pool priority: 1 fields: - field: name type: 1 instance: true - field: committed type: 0 unit: MB - field: init type: 0 unit: MB - field: max type: 0 unit: MB - field: used type: 0 unit: MB units: - committed=B->MB - init=B->MB - max=B->MB - used=B->MB # (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 protocol: jmx jmx: # host: ipv4 ipv6 domain # 主机host: ipv4 ipv6 域名 host: ^_^host^_^ # port # 端口 port: ^_^port^_^ username: ^_^username^_^ password: ^_^password^_^ objectName: java.lang:type=MemoryPool,name=* url: ^_^url^_^ - name: code_cache priority: 5 fields: - field: committed type: 0 - field: init type: 0 - field: max type: 0 - field: used type: 0 aliasFields: - Usage->committed - Usage->init - Usage->max - Usage->used calculates: - committed=Usage->committed - init=Usage->init - max=Usage->max - used=Usage->used protocol: jmx jmx: # host: ipv4 ipv6 domain # 主机host: ipv4 ipv6 域名 host: ^_^host^_^ # port # 端口 port: ^_^port^_^ username: ^_^username^_^ password: ^_^password^_^ objectName: java.lang:type=MemoryPool,name=Code Cache url: ^_^url^_^ - name: class_loading priority: 6 # 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: LoadedClassCount type: 0 - field: TotalLoadedClassCount type: 0 - field: UnloadedClassCount type: 0 protocol: jmx jmx: host: ^_^host^_^ port: ^_^port^_^ username: ^_^username^_^ password: ^_^password^_^ objectName: java.lang:type=ClassLoading url: ^_^url^_^ - name: thread priority: 7 # 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: TotalStartedThreadCount type: 0 - field: ThreadCount type: 0 - field: PeakThreadCount type: 0 - field: DaemonThreadCount type: 0 - field: CurrentThreadUserTime type: 0 unit: s - field: CurrentThreadCpuTime type: 0 unit: s protocol: jmx jmx: host: ^_^host^_^ port: ^_^port^_^ username: ^_^username^_^ password: ^_^password^_^ objectName: java.lang:type=Threading url: ^_^url^_^