Skip to content

kafka get-broker-metrics

Get Kafka Broker metrics

Description

Get metrics for one broker or all kafka brokers combined

Synopsis

kafka get-broker-metrics
    [--site <site>]
    [--cluster <cluster>]
    [--broker <broker>]
    [<beans>]

Arguments

site - (string)

     Site where this command will be executed
     Example: --site "site-1"
     Default: input.site      Attributes: optional

cluster - (string)

     Name of kafka cluster
     Example: --cluster "cluster-1"
     Default: default      Attributes: optional

broker - (int)

     broker id
     Example: --broker 1
     Default: -1      Attributes: optional

beans - ()

     list of beans
     Example: "kafka.server"
     Default: _None_      Attributes: optional, multiple allowed

Examples

Input: 

x = ! kafka get-broker-metrics --broker 1 --beans "kafka.server"
Output: 
{
  "brokerMetrics": [
    {
      "brokerId": 1,
      "beanMetrics": [
        {
          "bean": "kafka.server",
          "mbeanMetrics": [
            {
              "mbean": "kafka.server:type=KafkaServer,name=linux-disk-read-bytes",
              "metrics": [
                {
                  "attribute": "linux-disk-read-bytes",
                  "value": 22417408
                }
              ]
            },
            {
              "mbean": "kafka.server:type=KafkaServer,name=linux-disk-write-bytes",
              "metrics": [
                {
                  "attribute": "linux-disk-write-bytes",
                  "value": 11833344
                }
              ]
            },
            {
              "mbean": "kafka.server:type=ReplicaManager,name=*",
              "metrics": [
                {
                  "attribute": "PartitionCount",
                  "value": 3
                },
                {
                  "attribute": "LeaderCount",
                  "value": 2
                },
                {
                  "attribute": "AtMinIsrPartitionCount",
                  "value": 1
                },
                {
                  "attribute": "IsrExpands",
                  "value": 0.0001234603991556604
                }
              ]
            },
            {
              "mbean": "kafka.server:type=DelayedOperationPurgatory,name=PurgatorySize,delayedOperation=Produce",
              "metrics": []
            },
            {
              "mbean": "kafka.server:type=DelayedOperationPurgatory,name=PurgatorySize,delayedOperation=Fetch",
              "metrics": [
                {
                  "attribute": "PurgatorySize",
                  "value": 121
                }
              ]
            },
            {
              "mbean": "kafka.server:type=BrokerTopicMetrics,name=*",
              "metrics": [
                {
                  "attribute": "TotalFetchRequests",
                  "value": 1.9917576217462
                }
              ]
            },
            {
              "mbean": "kafka.server:type=KafkaRequestHandlerPool,name=RequestHandlerAvgIdlePercent",
              "metrics": [
                {
                  "attribute": "RequestHandlerAvgIdlePercentMeanRate",
                  "value": 0.9999090453002375
                }
              ]
            },
            {
              "mbean": "kafka.server:type=Produce",
              "metrics": []
            },
            {
              "mbean": "kafka.server:type=socket-server-metrics,listener={listener_name},networkProcessor={#},name=connection-count",
              "metrics": []
            },
            {
              "mbean": "kafka.server:type=socket-server-metrics,listener={listener_name},networkProcessor={#},name=connection-creation-rate",
              "metrics": []
            }
          ]
        }
      ]
    }
  ]
}
Input: 
x = ! kafka get-broker-metrics --broker 1
Output: 
{
  "brokerMetrics": [
    {
      "brokerId": 1,
      "metrics": [
        {
          "attribute": "TotalFetchRequests",
          "value": 1.9856422065406367
        },
        {
          "attribute": "HeapMemoryUsed",
          "value": 192278112
        },
        {
          "attribute": "NonHeapMemoryUsed",
          "value": 67263000
        }
      ]
    }
  ]
}
Input: 
! kafka get-broker-metrics --broker 1
Output: 
BROKER_ID   LINUX-DISK-READ-BYTES   LINUX-DISK-WRITE-BYTES  ISR_EXPANDS AT_MIN_ISR_PARTITION_COUNT  PARTITION_COUNT LEADER_COUNT    PURGATORY_SIZE  TOTAL_FETCH_REQUESTS    REQUEST_HANDLER_AVG_IDLE_PERCENT_MEAN_RATE  HEAP_MEMORY_USED    NON_HEAP_MEMORY_USED    
        1                22421504                 12103680            0                          1                3            2               507                     1                                             0         182999488                71166816

Access Control

To use this command, you need access to the following:

Field Value
Action "read"
Service Type "kafka"
Service Instance cluster
Namespace
Object Type "broker"
Object ID broker

Please see Access Control for details.