# 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: mid
# The monitoring type eg: linux windows tomcat mysql aws...
# 监控类型 eg: linux windows tomcat mysql aws...
app: kafka
# The monitoring i18n name
# 监控类型国际化名称
name:
zh-CN: Kafka消息系统
en-US: Kafka Message
# The description and help of this monitoring type
# 监控类型的帮助描述信息
help:
zh-CN: HertzBeat 对 Kafka 的通用性能指标(server info、code cache、active controller count、broker partition count、broker leader count、broker handler avg percent)进行采集监控。
⚠️注意:由于系统使用 JMX 协议对 Kafka 进行指标采集,您需要在 Kafka 开启 JMX 服务, 点击查看开启步骤。
en-US: "HertzBeat monitors kafka through general performance metrics such as code cache, active controller count, broker partition count.
⚠️Note:Due to the system using JMX protocol for collect metric data in Kafka, you need to enable JMX service in Kafka. Click here to view the specific steps."
zh-TW: HertzBeat對Kafka的通用性能指標(server info、code cache、active controller count、broker partition count、broker leader count、broker handler avg percent)進行採集監控。
⚠️ 注意:由於系統使用JMX協定對Kafka進行名額採集,您需要在Kafka開啟JMX服務,點擊查看開啟步驟。
helpLink:
zh-CN: https://hertzbeat.com/zh-cn/docs/help/kafka
en-US: https://hertzbeat.com/docs/help/kafka
# 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: port
name:
zh-CN: 端口
en-US: Port
type: number
# when type is number, range is required
# 当type为number时,用range表示范围
range: '[0,65535]'
required: true
defaultValue: 9999
- field: url
name:
zh-CN: JMX URL
en-US: JMX URL
type: text
required: false
hide: true
placeholder: 'service:jmx:rmi:///jndi/rmi://host:port/jmxrmi'
- field: username
name:
zh-CN: 用户名
en-US: Username
type: text
limit: 20
required: false
hide: true
- field: password
name:
zh-CN: 密码
en-US: Password
type: password
required: false
hide: true
# collect metrics config list
# 采集指标组配置列表
metrics:
# metrics - server_info
# 监控指标组 - server_info
- name: server_info
# 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
- field: StartTimeMs
type: 1
- field: CommitId
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 jmx
jmx:
host: ^_^host^_^
port: ^_^port^_^
username: ^_^username^_^
password: ^_^password^_^
# jmx mbean object name
# jmx mbean 对象名
objectName: kafka.server:type=app-info,id=0
# jmx url
url: ^_^url^_^
- name: jvm_basic
priority: 1
fields:
- field: VmName
type: 1
- field: VmVendor
type: 1
- field: VmVersion
type: 1
- field: Uptime
type: 0
unit: ms
protocol: jmx
jmx:
host: ^_^host^_^
port: ^_^port^_^
username: ^_^username^_^
password: ^_^password^_^
# jmx mbean object name
# jmx mbean 对象名
objectName: java.lang:type=Runtime
url: ^_^url^_^
- name: jvm_memory_pool
priority: 1
fields:
- field: name
type: 1
instance: true
- field: committed
type: 0
- field: init
type: 0
- field: max
type: 0
- field: used
type: 0
aliasFields:
- Name
- Usage->committed
- Usage->init
- Usage->max
- Usage->used
calculates:
- name=Name
- committed=Usage->committed
- init=Usage->init
- max=Usage->max
- used=Usage->used
protocol: jmx
jmx:
host: ^_^host^_^
port: ^_^port^_^
username: ^_^username^_^
password: ^_^password^_^
objectName: java.lang:type=MemoryPool,name=*
url: ^_^url^_^
- name: active_controller_count
priority: 1
fields:
- field: Value
type: 0
protocol: jmx
jmx:
host: ^_^host^_^
port: ^_^port^_^
username: ^_^username^_^
password: ^_^password^_^
# jmx mbean object name
# jmx mbean 对象名
objectName: kafka.controller:type=KafkaController,name=ActiveControllerCount
url: ^_^url^_^
- name: broker_partition_count
priority: 1
fields:
- field: Value
type: 0
protocol: jmx
jmx:
host: ^_^host^_^
port: ^_^port^_^
username: ^_^username^_^
password: ^_^password^_^
# jmx mbean object name
# jmx mbean 对象名
objectName: kafka.server:type=ReplicaManager,name=PartitionCount
url: ^_^url^_^
- name: broker_leader_count
priority: 1
fields:
- field: Value
type: 0
protocol: jmx
jmx:
host: ^_^host^_^
port: ^_^port^_^
username: ^_^username^_^
password: ^_^password^_^
# jmx mbean object name
# jmx mbean 对象名
objectName: kafka.server:type=ReplicaManager,name=LeaderCount
url: ^_^url^_^
- name: broker_handler_avg_percent
priority: 2
fields:
- field: EventType
type: 1
- field: RateUnit
type: 1
- field: Count
type: 0
- field: MeanRate
type: 0
- field: OneMinuteRate
type: 0
- field: FiveMinuteRate
type: 0
- field: FifteenMinuteRate
type: 0
protocol: jmx
jmx:
host: ^_^host^_^
port: ^_^port^_^
username: ^_^username^_^
password: ^_^password^_^
# jmx mbean object name
# jmx mbean 对象名
objectName: kafka.server:type=KafkaRequestHandlerPool,name=RequestHandlerAvgIdlePercent
url: ^_^url^_^
- name: topic_bytes_in_persec
priority: 2
fields:
- field: EventType
type: 1
- field: RateUnit
type: 1
- field: MeanRate
type: 0
- field: OneMinuteRate
type: 0
- field: FiveMinuteRate
type: 0
- field: FifteenMinuteRate
type: 0
- field: Count
type: 0
protocol: jmx
jmx:
host: ^_^host^_^
port: ^_^port^_^
username: ^_^username^_^
password: ^_^password^_^
# jmx mbean object name
# jmx mbean 对象名
objectName: kafka.server:type=BrokerTopicMetrics,name=BytesInPerSec
url: ^_^url^_^
- name: topic_bytes_out_persec
priority: 2
fields:
- field: EventType
type: 1
- field: RateUnit
type: 1
- field: MeanRate
type: 0
- field: OneMinuteRate
type: 0
- field: FiveMinuteRate
type: 0
- field: FifteenMinuteRate
type: 0
- field: Count
type: 0
protocol: jmx
jmx:
host: ^_^host^_^
port: ^_^port^_^
username: ^_^username^_^
password: ^_^password^_^
# jmx mbean object name
# jmx mbean 对象名
objectName: kafka.server:type=BrokerTopicMetrics,name=BytesOutPerSec
url: ^_^url^_^
- name: produce_message_conversions_persec
priority: 2
fields:
- field: EventType
type: 1
- field: RateUnit
type: 1
- field: MeanRate
type: 0
- field: OneMinuteRate
type: 0
- field: FiveMinuteRate
type: 0
- field: FifteenMinuteRate
type: 0
- field: Count
type: 0
protocol: jmx
jmx:
host: ^_^host^_^
port: ^_^port^_^
username: ^_^username^_^
password: ^_^password^_^
# jmx mbean object name
# jmx mbean 对象名
objectName: kafka.server:type=BrokerTopicMetrics,name=ProduceMessageConversionsPerSec
url: ^_^url^_^
- name: produce_total_requests_persec
priority: 2
fields:
- field: EventType
type: 1
- field: RateUnit
type: 1
- field: MeanRate
type: 0
- field: OneMinuteRate
type: 0
- field: FiveMinuteRate
type: 0
- field: FifteenMinuteRate
type: 0
- field: Count
type: 0
protocol: jmx
jmx:
host: ^_^host^_^
port: ^_^port^_^
username: ^_^username^_^
password: ^_^password^_^
# jmx mbean object name
# jmx mbean 对象名
objectName: kafka.server:type=BrokerTopicMetrics,name=TotalProduceRequestsPerSec
url: ^_^url^_^