Child pages
  • KIP-59: Proposal for a kafka broker command
Skip to end of metadata
Go to start of metadata

This page is meant as a template for writing a KIP. To create a KIP choose Tools->Copy on this page and modify with your content and replace the heading with the next KIP number and a description of your issue. Replace anything in italics with your own description.

Status

Current state: Under Discussion

Discussion thread:

JIRA: KAFKA-3663 - Proposal for a kafka broker command - kafka-brokers.sh Open

Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).

Motivation

This is a proposal for an admin tool - say, kafka-brokers.sh to provide broker related useful information. Some of the key factors for Kafka's success are its performant architecture and operational simplicity. This is further complemented with a set of commandline tools and utilities for managing topics as well as testing/stress-testing. However currently Kafka lacks commands/tools to get cluster and broker overview. Although it should be mentioned that Kafka does expose cluster information via API and broker metrics via JMX.

Public Interfaces

The kafka-broker.sh command is modeled after the kafka-topic.sh and has options as described later below.

 

Proposed Changes

The command will essentially provide the following pieces of information:

Broker Information

  • Broker Id
  • Hostname
  • Rack
  • Endpoints
  • Topic count (i.e. how many topics are hosted by the broker)
  • All partition count (i.e. how many partition replicas are hosted by the broker)
  • Leader partition count (i.e. how many leader partitions are hosted by the broker)
  • Insync partition count (i.e, how many follower partitions are insync)
  • Under-replicated partition count (i.e. how many partitions are not insync)
  • An asterisk would indicate that the broker is the leader for that partition.

With commandline options, topic names and partition numbers can be enumerated.

Command Options

The command kafka-brokers.sh requires zookeeper information and additional accepts other options as show below:

kafka-brokers.sh Usage/Options

 

The options "–broker", "–host", "–rack" and "–topic" provide filtering for the specified broker (broker-id), host, rack or topic. Each of the options can be specified multiple times. The option "--topic-details" makes the command to enumerate all the topic names in addition to giving the topic count. The option "--partition-details" makes the command to enumerate all the partitions for each topic. The partitions have an an optional prefix of "+" or "-" to indicate that the partition is a leader partition or an under-replicated partition respectively. An insync replica partition will not have any prefix.

Here are examples usages of the command.

Summary Output Without Any Details
Output with Topic Details
Output with Partition Details
Output with Topic and Partition Details

 

Compatibility, Deprecation, and Migration Plan

None yet.

Rejected Alternatives

If there are alternative ways of accomplishing the same thing, what were they? The purpose of this section is to motivate why the design is the way it is and not some other way.

  • No labels