Status

Current state: Draft

Discussion thread: here [Change the link from the KIP proposal email archive to your own email thread]

JIRA: here [Change the link from KAFKA-1 to your own ticket]

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

Motivation

When using the Kafka command-line tools to do simple performance tests, it quickly becomes evident that kafka-producer-perf-test.sh  and the equivalent consumer tools do not follow the same conventions for command-line arguments. Strangely, kafka-producer-perf-test.sh  does not support the --bootstrap-server  argument which all of the other tools do, instead requiring --producer.props bootstrap.servers= (note the "s" on "bootstrap.servers" because it's the name of the producer config). This means that simple familiarity with the other tools isn't sufficient to get the command line for this tool correct without a little trial and error.

There are a few other inconsistencies where different names are used for the same thing in different tools.

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

  • The network protocol and api behavior

  • Any class in the public packages under clientsConfiguration, especially client configuration

    • 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

  • Command line tools and arguments

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

Proposed Changes

The following table shows the existing and proposed options.

Tools

Existing option for bootstrap server

Proposed option for bootstrap server

Existing option for properties

Proposed option for properties

Existing option for config file

Proposed option for config file

kafka-acls.sh

--bootstrap-server




--command-config


kafka-broker-api-versions.sh

--bootstrap-server




--command-config


kafka-client-metrics.sh

--bootstrap-server




--command-config


kafka-configs.sh

--bootstrap-server




--command-config


kafka-console-consumer.sh

--bootstrap-server


--consumer-property


--consumer.config

--consumer-config

kafka-console-producer.sh

--bootstrap-server


--producer-property


--producer.config

--producer-config

kafka-console-share-consumer.sh

--bootstrap-server


--consumer-property


--consumer-config


kafka-consumer-groups.sh

--bootstrap-server




--command-config


kafka-consumer-perf-test.sh

--bootstrap-server




--consumer.config

--command-config

kafka-delegation-tokens.sh

--bootstrap-server




--command-config


kafka-delete-records.sh

--bootstrap-server




--command-config


kafka-features.sh

--bootstrap-server




--command-config


kafka-get-offsets.sh

--bootstrap-server




--command-config


kafka-groups.sh

--bootstrap-server




--command-config


kafka-leader-election-sh

--bootstrap-server




--admin.config

--command-config

kafka-log-dirs.sh

--bootstrap-server




--command-config


kafka-metadata-quorum.sh

--bootstrap-server




--command-config


kafka-producer-perf-test.sh


--bootstrap-server

--producer-props

--producer-property

--producer.config

--producer-config

kafka-reassign-partitions.sh

--bootstrap-server




--command-config


kafka-share-consumer-perf-test.sh

--bootstrap-server




--consumer.config

--command-config

kafka-share-groups.sh

--bootstrap-server




--command-config


kafka-streams-application-reset.sh

--bootstrap-server




--config-file

--command-config

kafka-topics.sh

--bootstrap-server




--command-config


kafka-transactions.sh

--bootstrap-server




--command-config


kafka-verifiable-consumer.sh

--bootstrap-server




--consumer.config

--command-config

kafka-verifiable-produer.sh

--bootstrap-server




--producer.config

--command-config

kafka-verifiable-share-consumer.sh

--bootstrap-server




--command-config


The proposed changes are:

  • Add --bootstrap-server  to kafka-producer-perf-test.sh  bringing it into line with all the other tools
  • Replace --producer-props  with --producer-properties  in kafka-producer-perf-test.sh , bringing it into line with the other tools that accept producer or consumer properties
  • For all tools, with the exception of those which support either --producer-properties  or --consumer-properties , replace the existing option for specifying a configuration properties file with --command-config  

Compatibility, Deprecation, and Migration Plan

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

Test Plan

Describe in few sentences how the KIP will be tested. We are mostly interested in system tests (since unit-tests are specific to implementation details). How will we know that the implementation works as expected? How will we know nothing broke?

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