Versions Compared

Old Version 3

changes.mady.by.user Unknown User (schofielaj)

Saved on

compared with

New Version Current

changes.mady.by.user Unknown User (schofielaj)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: --reader-property in console producer

Table of Contents

Status

Current state: Under discussionAccepted

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

...

  • Add --bootstrap-server  to kafka-producer-perf-test.sh  bringing it into line with all the other tools. Because users will already have config files which specify the bootstrap server and there's no need to break these, the new --bootstrap-server  flag is optional. If provided, it takes precedence over specifying bootstrap.servers  in the configuration file. The order of precedence for configuring the bootstrap server from highest to lowest is --bootstrap-server , then --command-property (previously called --producer-props ), then --command-config .
  • Introduce consistent use of --command-property  as a way of providing individual configuration properties without use of a configuration file. Replace --producer-props  with --producercommand-property  in kafka-producer-perf-test.sh . Add --command-property  to kafka-consumer-perf-test.sh  , bringing it into line with the other tools that accept producer or consumer propertiesand kafka-share-consumer-perf-test.sh .
  • For the console producer and consumer tools, replace --producer-property  and --consumer-property  with --command-property .
  • For all tools which support a properties file, replace the existing option for specifying a configuration properties file with --command-config  . This eliminates the guesswork about whether a particular tool uses the producer, consumer or admin APIs and then chose to pass this knowledge into the original names of the command-line arguments.
  • Add --reporting-interval  to kafka-producer-perf-test.sh . The tools already has a reporting interval hard-coded to 5000ms, so this simply makes it configurable like for the consumer performance tests, with a default of 5000ms.
  • Replace --property  with --formatter-property  in kafka-console-consumer.sh  and kafka-console-share-consumer.sh . This argument is used to configure the formatter, so this names it accordingly.
  • Replace --property  with --reader-property  in kafka-console-producer.sh . This argument is used to configure the message reader, so this names it accordingly and also matches the existing --reader-config  argument.
  • Replace  --messages  with --num-records  in kafka-consumer-perf-test.sh  and kafka-share-consumer-perf-test.sh .

Proposed Changes

The following table shows the existing and proposed options. The changes are in GREEN.

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-cluster.sh

--bootstrap-server




--config

--command-config

kafka-configs.sh

--bootstrap-server




--command-config


kafka-console-consumer.sh

--bootstrap-server


--consumer-property

--command-property

--consumer.config

--command-config

kafka-console-producer.sh

--bootstrap-server


--producer-property

--command-property

--producer.config

--command-config

kafka-console-share-consumer.sh

--bootstrap-server


--consumer-property

--command-property

--consumer-config

--command-config

kafka-consumer-groups.sh

--bootstrap-server




--command-config


kafka-consumer-perf-test.sh

--bootstrap-server



--command-property

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

--producercommand-property

--producer.config

--command-config

kafka-reassign-partitions.sh

--bootstrap-server




--command-config


kafka-share-consumer-perf-test.sh

--bootstrap-server



--command-property

--consumer.config

--command-config

kafka-share-groups.sh

--bootstrap-server




--command-config


kafka-streams-application-reset.sh

--bootstrap-server




--config-file

--command-config

kafka-streams-groups.sh

--bootstrap-server




--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-producer.sh

--bootstrap-server




--producer.config

--command-config

kafka-verifiable-share-consumer.sh

--bootstrap-server




--command-config


...

The existing options will be deprecated until the next major Apache Kafka release, and then they will be removed. During the deprecation period, using the old parameter names will cause a deprecation message to be displayed. It is an error to use both the old name and the new name together - they are mutually exclusive.

All uses of the command-line tools in the Apache Kafka codebase such as system tests will be migrated over to the new parameter names.

...

The KIP will be tested with unit tests. 

For tests such as system tests which use these command-line tools, the tests will be migrated across to the new parameter names providing additional validation.

Rejected Alternatives

An alternative for tools such as kafka-verifiable-producer.sh  would be rename --producer.config  to --producer-config  instead of --command-config . This was rejected because some of the tools such as kafka-verifiable-share-consumer.sh  actually use multiple APIs (consumer and admin in this case) so the clean simplicity of --command-config  was chosen instead for all tools.