MINOR: Update inconsistent description for kafka-streams-application-reset and kafka-producer-perf-test by Yunyung · Pull Request #20445 · apache/kafka

Yunyung · 2025-08-29T16:42:00Z

The value placeholder for the --bootstrap-server argument in the usage
output (e.g., when running with --help) has been corrected from the
plural form (BOOTSTRAP-SERVERS) to the consistent singular form
(BOOTSTRAP-SERVER).

Reviewers: Chia-Ping Tsai chia7712@gmail.com

…nd command-line

Yunyung · 2025-08-29T16:44:15Z

kafka-streams-application-reset.sh

Before:

After:

kafka-producer-perf-test.sh

(See --bootstrap-server)
Before:

usage: kafka-producer-perf-test
       [-h] [--bootstrap-server BOOTSTRAP-SERVERS] --topic TOPIC --num-records NUM-RECORDS [--payload-delimiter PAYLOAD-DELIMITER] --throughput THROUGHPUT [--producer-props PROP-NAME=PROP-VALUE [PROP-NAME=PROP-VALUE ...]]
       [--command-property PROP-NAME=PROP-VALUE [PROP-NAME=PROP-VALUE ...]] [--producer.config CONFIG-FILE] [--command-config CONFIG-FILE] [--print-metrics] [--transactional-id TRANSACTIONAL-ID] [--transaction-duration-ms TRANSACTION-DURATION] [--warmup-records WARMUP-RECORDS]
       [--reporting-interval INTERVAL-MS] (--record-size RECORD-SIZE | --payload-file PAYLOAD-FILE | --payload-monotonic)

After:

usage: kafka-producer-perf-test
       [-h] [--bootstrap-server BOOTSTRAP-SERVER] --topic TOPIC --num-records NUM-RECORDS [--payload-delimiter PAYLOAD-DELIMITER] --throughput THROUGHPUT [--producer-props PROP-NAME=PROP-VALUE [PROP-NAME=PROP-VALUE ...]]
       [--command-property PROP-NAME=PROP-VALUE [PROP-NAME=PROP-VALUE ...]] [--producer.config CONFIG-FILE] [--command-config CONFIG-FILE] [--print-metrics] [--transactional-id TRANSACTIONAL-ID] [--transaction-duration-ms TRANSACTION-DURATION] [--warmup-records WARMUP-RECORDS]
       [--reporting-interval INTERVAL-MS] (--record-size RECORD-SIZE | --payload-file PAYLOAD-FILE | --payload-monotonic)

DL1231

Thanks for the patch, left a small comment.

DL1231 · 2025-08-30T03:41:14Z

tools/src/main/java/org/apache/kafka/tools/ProducerPerformance.java

                .type(String.class)
-                .metavar("BOOTSTRAP-SERVERS")
+                .metavar("BOOTSTRAP-SERVER")
                .dest("bootstrapServers")


nit: bootstrapServer

ConfigPostProcessor.bootstrapServers -> bootstrapServer

Done. Thanks for the review.

frankvicky

Please fix the build error.

Yunyung · 2025-08-30T11:25:10Z

Done. Thanks.

m1a2st

Thanks for this patch, left a comment

m1a2st · 2025-08-31T03:13:46Z

tools/src/main/java/org/apache/kafka/tools/StreamsResetter.java

                if (CommandLineUtils.isPrintVersionNeeded(this)) {
                    CommandLineUtils.printVersionAndExit();
                }
+                CommandLineUtils.checkRequiredArgs(parser, options, bootstrapServerOption);


Could you also add a test to verify that the bootstrap-server argument is required and that the command fails with a proper error message if it is missing?

Yunyung · 2025-08-31T15:47:30Z

I’ve added the test and made slight updates to the code and docs. Also updated the "After" screenshot above. Thanks for the review.

…ootstrap-server

chia7712 · 2025-09-24T16:54:09Z

tools/src/main/java/org/apache/kafka/tools/StreamsResetter.java

                .ofType(String.class)
-                .describedAs("server to connect to");
+                .describedAs("server to connect to")
+                .required();


Is this breaking change included by the KIP?

I'll revert the change that requires bootstrapServer, since the previous KIP-865 is ambiguous and highly dependent on the implementation. It's better not to introduce the breaking change here.

That is, this PR only updates the docs and text. Thanks.

Updated. And also update the screenshot above.

We should keep the word REQUIRED since the bootstrapServerOption is now completely required. That should be addressed in #16437 😄

Sure. I've reverted the latest commit, thanks!

Sorry, my last comment was incorrect. It has a default value, so the config is definitely optional

String bootstrapServerValue = "localhost:9092";

No worries, I was lost too, haha.

Updated.

…ootstrap-server

This reverts commit a20c3cb.

This reverts commit 376819d.

…ootstrap-server

chia7712 · 2025-11-01T20:39:40Z

@frankvicky @DL1231 @m1a2st Sorry about that - I forgot to add you to reviewers. my bad :(

…reset and kafka-producer-perf-test (apache#20445) The value placeholder for the --bootstrap-server argument in the usage output (e.g., when running with --help) has been corrected from the plural form (BOOTSTRAP-SERVERS) to the consistent singular form (BOOTSTRAP-SERVER). Reviewers: Chia-Ping Tsai <chia7712@gmail.com>

MINOR: Update inconsistent description for bootstrap-server in docs a…

1c8d5c8

…nd command-line

github-actions bot added triage PRs from the community tools small Small PRs labels Aug 29, 2025

DL1231 reviewed Aug 30, 2025

View reviewed changes

Address DL1231's comment

9b98ed6

frankvicky reviewed Aug 30, 2025

View reviewed changes

Fix build error

6c7397a

m1a2st reviewed Aug 31, 2025

View reviewed changes

github-actions bot removed the triage PRs from the community label Aug 31, 2025

Yunyung added 2 commits August 31, 2025 23:35

Imporve code and docs

e195b57

Add required bootstrap-server test

15d552f

Merge branch 'trunk' into MINOR-Update-inconsistent-description-for-b…

bd82e9a

…ootstrap-server

chia7712 reviewed Sep 24, 2025

View reviewed changes

Yunyung added 2 commits September 29, 2025 08:42

Merge branch 'trunk' into MINOR-Update-inconsistent-description-for-b…

e9ca16d

…ootstrap-server

Revert breaking change for bootstrap-server

a20c3cb

Yunyung changed the title ~~MINOR: Update inconsistent description for bootstrap-server in docs and command-line~~ MINOR: Update inconsistent description for kafka-streams-application-reset and kafka-producer-perf-test Sep 29, 2025

Yunyung added 3 commits September 30, 2025 00:00

Revert "Revert breaking change for bootstrap-server"

376819d

This reverts commit a20c3cb.

Address chia's comment (Revert)

acb0283

This reverts commit 376819d.

Merge branch 'trunk' into MINOR-Update-inconsistent-description-for-b…

7b1b3eb

…ootstrap-server

chia7712 approved these changes Nov 1, 2025

View reviewed changes

chia7712 merged commit 1e547de into apache:trunk Nov 1, 2025
28 checks passed

Comments

Conversation

Yunyung commented Aug 29, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Yunyung commented Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

kafka-streams-application-reset.sh

kafka-producer-perf-test.sh

Uh oh!

DL1231 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

frankvicky left a comment

Choose a reason for hiding this comment

Uh oh!

Yunyung commented Aug 30, 2025

Uh oh!

m1a2st left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Yunyung commented Aug 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

chia7712 commented Nov 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Yunyung commented Aug 29, 2025 •

edited by github-actions bot

Loading

Yunyung commented Aug 29, 2025 •

edited

Loading

Yunyung commented Aug 31, 2025 •

edited

Loading