category: mid
app: kafka
name:
  zh-CN: Kafka消息系统
  en-US: Kafka Message
params:
  # field-字段名称标识符
  - field: host
    # name-参数字段显示名称
    name:
      zh-CN: 主机Host
      en-US: Host
    # type-字段类型,样式(大部分映射input标签type属性)
    type: host
    # 是否是必输项 true-必填 false-可选
    required: true
  - field: port
    name:
      zh-CN: 端口
      en-US: Port
    type: number
    # 当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
metrics:
  - name: server_info
    priority: 0
    fields:
      - field: Version
        type: 1
      - field: StartTimeMs
        type: 1
      - field: CommitId
        type: 1
    protocol: jmx
    jmx:
      host: ^_^host^_^
      port: ^_^port^_^
      username: ^_^username^_^
      password: ^_^password^_^
      # jmx mbean object name
      objectName: kafka.server:type=app-info,id=0
      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
      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: ipv4 ipv6 域名
      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^_^