...

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

JIRA: KAFKA-313

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

Motivation

Add JSON/CSV output and looping options to ConsumerGroupCommand. Neither of the these options depend on each other (you can loop in the human readable output, or do a single shot execution with JSON output). Existing behavior/output maintained if neither of the the options are used.

Public Interfaces

Briefly list any new interfaces that will be introduced as part of this proposal or any existing interfaces that will be removed or changed. The purpose of this section is to concisely call out the public contract that will come along with this feature.

A public interface is any change to the following:

...

Binary log format - No changes

...

The network protocol and api behavior - No changes

...

Any class in the public packages under clientsConfiguration, especially client configuration - No changes

• org/apache/kafka/common/serialization

• org/apache/kafka/common

• org/apache/kafka/common/errors

• org/apache/kafka/clients/producer

• org/apache/kafka/clients/consumer (eventually, once stable)

...

Monitoring - No changes

Command line tools and arguments

...

Add the following two options to the ConsumerGroupCommand:

• output

  .

  -format, if specified, takes "csv" or "json" as value, sets the output format of ConsumerGroupCommand to "csv" or "json"

• loop, if specified, takes an integer value greater than 0, keeps executing the command at an interval of that many seconds until explicitly terminated by the admin/user

• Anything else that will likely break existing users in some way when they upgrade - No

  num-iterations, if specified terminates the loop after after that many iterations

Proposed Changes

Add JSON/CSV output and looping options to ConsumerGroupCommand. Neither of the these options depend on each other (you can loop in the human readable output, or do a single shot execution with JSON output). Existing behavior/output maintained if neither of the the options are used.

 Adds  Adds following two options to ConsumerGroupCommand.

• output.-format, if specified, takes "csv" or "json" as value, sets the output format of ConsumerGroupCommand to "csv" or "json"

• loop, if specified, takes an integer value greater than 0, keeps executing the command at an interval of that many seconds until explicitly terminated by the admin/user

• num-iterations, takes an integer value greater than 0, runs the command that many times at an interval specified by the loop option

Compatibility, Deprecation, and Migration Plan

• What impact (if any) will there be on existing users? - None
• If we are changing behavior how will we phase out the older behavior? - No change in existing behavior
• If we need special migration tools, describe them here. - None required
• When will we remove the existing behavior? - Not applicable

Rejected Alternatives

ConsumerOffsetChecker will be deprecated. The work is tracked at

Rejected Alternatives

NoneIf 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.