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: TBD

JIRA: Unable to render Jira issues macro, execution error.

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

Motivation

Usually we have no interest in internal topics when using the kafka-topics.sh command . However, the kafka-topics.sh can't exclude the internal topics simply. We have to write the regular to exclude the internal topics. This kip tries to add a flag (perhaps "exclude-internal") to kafka-topics.sh. If user set the flag, all internal topics will be excluded by the following commands - "list" and "describe"

Proposed Changes && Public Interfaces

KIP-338 plan to add a new option to kafka-topics.sh to enable/disable kafka-topics.sh to show the information of internal topics. The new option is called as "exclude-internal". Assume we have a internal topic "__consumer_offsets" and a user topic "testTopic".

The following command will show both topics.

$ kafka-topics.sh --zookeeper localhost:2181 --list

The following command will show the "testTopic" only.

$ kafka-topics.sh --zookeeper localhost:2181 --list --exclude-internal

The explanation of "exclude-internal" is "exclude internal topics when running list or describe command". 

Compatibility, Deprecation, and Migration Plan

• No compatibility issue since the default value of exclude-internal is false.

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.