# 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
category: mid
# The monitoring type 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 使用 <a href="https://hertzbeat.apache.org/docs/advanced/extend-jmx">JMX 协议</a> 对 Kafka 的通用性能指标 (server info、code cache、active controller count、broker partition count、broker leader count、broker handler avg percent etc) 进行采集监控。<br><span class='help_module_span'>注意⚠️：您需要在 Kafka 开启 JMX 服务，应用启动时添加 JMX 参数，暴露端口，对外IP。<a class='help_module_content' href='https://hertzbeat.apache.org/zh-cn/docs/help/kafka'>点击查看开启步骤</a>。</span>
  en-US: HertzBeat uses <a href='https://hertzbeat.apache.org/docs/advanced/extend-jmx'>JMX Protocol</a> to monitoring kafka general performance metrics (server info、code cache、active controller count、broker partition count、broker leader count、broker handler avg percent etc). <br><span class='help_module_span'>Note⚠️:You need to enable JMX service in Kafka, export JMX port and config params. <a class='help_module_content' href='https://hertzbeat.apache.org/docs/help/kafka'>Click here to view the specific steps.</a></span>
  zh-TW: HertzBeat 使用 <a href="https://hertzbeat.apache.org/docs/advanced/extend-jmx">JMX 協議</a> 對 Kafka 的通用性能指標 (server info、code cache、active controller count、broker partition count、broker leader count、broker handler avg percent etc) 進行采集監控。<br><span class='help_module_span'>注意⚠️：您需要在 Kafka 開啓 JMX 服務，應用啓動時添加 JMX 參數，暴露端口，對外IP。<a class='help_module_content' href='https://hertzbeat.apache.org/zh-cn/docs/help/kafka'>點擊查看開啓步驟</a>。</span>
helpLink:
  zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/kafka
  en-US: https://hertzbeat.apache.org/docs/help/kafka
# Input params define for monitoring(render web ui by the definition)
params:
  # field-param field key
  - field: host
    # name-param field display i18n name
    name:
      zh-CN: 目标Host
      en-US: Target Host
    # type-param field type(most mapping the html input type)
    type: host
    # required-true or false
    required: true
  - field: port
    name:
      zh-CN: 端口
      en-US: Port
    type: number
    # when type is number, range is required
    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
  - name: server_info
    # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel
    # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue
    priority: 0
    # collect metrics content
    fields:
      # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field
      - 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
    protocol: jmx
    # the config content when protocol is jmx
    jmx:
      host: ^_^host^_^
      port: ^_^port^_^
      username: ^_^username^_^
      password: ^_^password^_^
      # jmx mbean object name
      objectName: kafka.server:type=app-info,id=0
      # jmx url
      url: ^_^url^_^

  - name: jvm_basic
    i18n:
      zh-CN: 虚拟机基础信息
      en-US: JVM Basic
    priority: 1
    fields:
      - field: VmName
        type: 1
        i18n:
          zh-CN: 名称
          en-US: Vm Name
      - field: VmVendor
        type: 1
        i18n:
          zh-CN: 厂商
          en-US: Vm Vendor
      - field: VmVersion
        type: 1
        i18n:
          zh-CN: 版本
          en-US: Vm Version
      - field: Uptime
        type: 0
        unit: ms
        i18n:
          zh-CN: 运行时长
          en-US: Up time
    protocol: jmx
    jmx:
      host: ^_^host^_^
      port: ^_^port^_^
      username: ^_^username^_^
      password: ^_^password^_^
      # jmx mbean object name
      objectName: java.lang:type=Runtime
      url: ^_^url^_^

  - name: jvm_memory_pool
    i18n:
      zh-CN: 内存池
      en-US: Memory Pool
    priority: 1
    fields:
      - field: name
        type: 1
        label: true
        i18n:
          zh-CN: 指标名称
          en-US: Name
      - field: committed
        type: 0
        i18n:
          zh-CN: 已分配内存
          en-US: Committed
      - field: init
        type: 0
        i18n:
          zh-CN: 初始化内存
          en-US: Init
      - field: max
        type: 0
        i18n:
          zh-CN: 最大内存
          en-US: Max
      - field: used
        type: 0
        i18n:
          zh-CN: 已使用内存
          en-US: Used
    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
      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
      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
      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
      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
      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
      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
      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
      objectName: kafka.server:type=BrokerTopicMetrics,name=TotalProduceRequestsPerSec
      url: ^_^url^_^