prakashtanaji commented on code in PR #22607:
URL: https://github.com/apache/kafka/pull/22607#discussion_r3432757662
##########
tools/src/main/java/org/apache/kafka/tools/consumer/group/ConsumerGroupCommandOptions.java:
##########
@@ -208,7 +206,7 @@ private ConsumerGroupCommandOptions(String[] args) {
@SuppressWarnings({"CyclomaticComplexity", "NPathComplexity"})
void checkArgs() {
- CommandLineUtils.maybePrintHelpOrVersion(this, "This tool helps to
list all consumer groups, describe a consumer group, delete consumer group
info, or reset consumer group offsets.");
+ CommandLineUtils.maybePrintHelpOrVersion(this, "This tool helps to
list, describe, reset and delete consumer groups.");
Review Comment:
..., reset(offsets of) ...
##########
tools/src/main/java/org/apache/kafka/tools/consumer/group/ConsumerGroupCommandOptions.java:
##########
@@ -28,57 +28,55 @@
import static org.apache.kafka.tools.ToolsUtils.minus;
public class ConsumerGroupCommandOptions extends CommandDefaultOptions {
+ private static final String NL = System.lineSeparator();
private static final String BOOTSTRAP_SERVER_DOC = "The server(s) to
connect to. REQUIRED for all options except for --validate-regex.";
- private static final String GROUP_DOC = "The consumer group we wish to act
on.";
- private static final String TOPIC_DOC = "The topic whose consumer group
information should be deleted or topic whose should be included in the reset
offset process. " +
- "In `reset-offsets` case, partitions can be specified using this
format: `topic1:0,1,2`, where 0,1,2 are the partition to be included in the
process. " +
- "Reset-offsets also supports multiple topic inputs.";
- private static final String ALL_TOPICS_DOC = "Consider all topics assigned
to a group in the `reset-offsets` process.";
+ private static final String GROUP_DOC = "The consumer group id.";
+ private static final String TOPIC_DOC = "The topic whose offset
information should be deleted or reset. " +
+ "In `reset-offsets` case, partitions can be specified using this
format: `topic:0,1,2`, where 0,1,2 are the partitions to be included. " +
+ "Reset-offsets also supports multiple topics.";
+ private static final String ALL_TOPICS_DOC = "Apply to all topics.";
private static final String LIST_DOC = "List all consumer groups.";
private static final String DESCRIBE_DOC = "Describe consumer group and
list offset lag (number of messages not yet processed) related to given group.";
private static final String ALL_GROUPS_DOC = "Apply to all consumer
groups.";
- private static final String NL = System.lineSeparator();
- private static final String DELETE_DOC = "Pass in groups to delete topic
partition offsets and ownership information " +
- "over the entire consumer group. For instance --group g1 --group g2";
+ private static final String DELETE_DOC = "Delete topic partition offsets
and ownership information for one or more consumer groups.";
private static final String TIMEOUT_MS_DOC = "The timeout that can be set
for some use cases. For example, it can be used when describing the group " +
"to specify the maximum amount of time in milliseconds to wait before
the group stabilizes (when the group is just created, " +
"or is going through some changes).";
private static final String COMMAND_CONFIG_DOC = "Property file containing
configs to be passed to Admin Client and Consumer.";
- private static final String RESET_OFFSETS_DOC = "Reset offsets of consumer
group. Supports one consumer group at the time, and instances should be
inactive" + NL +
+ private static final String RESET_OFFSETS_DOC = "Reset offsets of consumer
group. Supports one consumer group at a time, and instances should be inactive"
+ NL +
"Has 2 execution options: --dry-run (the default) to plan which
offsets to reset, and --execute to update the offsets. " +
"Additionally, the --export option is used to export the offsets in
CSV format." + NL +
"You must choose one of the following reset specifications:
--to-datetime, --by-duration, --to-earliest, " +
"--to-latest, --shift-by, --from-file, --to-current, --to-offset." +
NL +
- "To define the scope use --all-topics or --topic. One scope must be
specified unless you use '--from-file'.";
- private static final String DRY_RUN_DOC = "Only show results without
executing changes on Consumer Groups. Supported operations: reset-offsets.";
- private static final String EXECUTE_DOC = "Execute operation. Supported
operations: reset-offsets.";
- private static final String EXPORT_DOC = "Export offset information in CSV
format. Supported operations: reset-offsets.";
+ "To define the scope, use --all-topics or --topic. The scope must be
specified unless you use --from-file.";
+ private static final String DRY_RUN_DOC = "Output offset reset information
without executing the operation. Supported operations: reset-offsets.";
Review Comment:
since only one supported operation. say "Supported operation: reset-offsets"
##########
tools/src/main/java/org/apache/kafka/tools/consumer/group/ConsumerGroupCommandOptions.java:
##########
@@ -28,57 +28,55 @@
import static org.apache.kafka.tools.ToolsUtils.minus;
public class ConsumerGroupCommandOptions extends CommandDefaultOptions {
+ private static final String NL = System.lineSeparator();
private static final String BOOTSTRAP_SERVER_DOC = "The server(s) to
connect to. REQUIRED for all options except for --validate-regex.";
- private static final String GROUP_DOC = "The consumer group we wish to act
on.";
- private static final String TOPIC_DOC = "The topic whose consumer group
information should be deleted or topic whose should be included in the reset
offset process. " +
- "In `reset-offsets` case, partitions can be specified using this
format: `topic1:0,1,2`, where 0,1,2 are the partition to be included in the
process. " +
- "Reset-offsets also supports multiple topic inputs.";
- private static final String ALL_TOPICS_DOC = "Consider all topics assigned
to a group in the `reset-offsets` process.";
+ private static final String GROUP_DOC = "The consumer group id.";
+ private static final String TOPIC_DOC = "The topic whose offset
information should be deleted or reset. " +
+ "In `reset-offsets` case, partitions can be specified using this
format: `topic:0,1,2`, where 0,1,2 are the partitions to be included. " +
+ "Reset-offsets also supports multiple topics.";
+ private static final String ALL_TOPICS_DOC = "Apply to all topics.";
private static final String LIST_DOC = "List all consumer groups.";
private static final String DESCRIBE_DOC = "Describe consumer group and
list offset lag (number of messages not yet processed) related to given group.";
private static final String ALL_GROUPS_DOC = "Apply to all consumer
groups.";
- private static final String NL = System.lineSeparator();
- private static final String DELETE_DOC = "Pass in groups to delete topic
partition offsets and ownership information " +
- "over the entire consumer group. For instance --group g1 --group g2";
+ private static final String DELETE_DOC = "Delete topic partition offsets
and ownership information for one or more consumer groups.";
private static final String TIMEOUT_MS_DOC = "The timeout that can be set
for some use cases. For example, it can be used when describing the group " +
"to specify the maximum amount of time in milliseconds to wait before
the group stabilizes (when the group is just created, " +
"or is going through some changes).";
private static final String COMMAND_CONFIG_DOC = "Property file containing
configs to be passed to Admin Client and Consumer.";
- private static final String RESET_OFFSETS_DOC = "Reset offsets of consumer
group. Supports one consumer group at the time, and instances should be
inactive" + NL +
+ private static final String RESET_OFFSETS_DOC = "Reset offsets of consumer
group. Supports one consumer group at a time, and instances should be inactive"
+ NL +
"Has 2 execution options: --dry-run (the default) to plan which
offsets to reset, and --execute to update the offsets. " +
"Additionally, the --export option is used to export the offsets in
CSV format." + NL +
"You must choose one of the following reset specifications:
--to-datetime, --by-duration, --to-earliest, " +
"--to-latest, --shift-by, --from-file, --to-current, --to-offset." +
NL +
- "To define the scope use --all-topics or --topic. One scope must be
specified unless you use '--from-file'.";
- private static final String DRY_RUN_DOC = "Only show results without
executing changes on Consumer Groups. Supported operations: reset-offsets.";
- private static final String EXECUTE_DOC = "Execute operation. Supported
operations: reset-offsets.";
- private static final String EXPORT_DOC = "Export offset information in CSV
format. Supported operations: reset-offsets.";
+ "To define the scope, use --all-topics or --topic. The scope must be
specified unless you use --from-file.";
+ private static final String DRY_RUN_DOC = "Output offset reset information
without executing the operation. Supported operations: reset-offsets.";
+ private static final String EXECUTE_DOC = "Execute the offset reset
operation. Supported operations: reset-offsets.";
+ private static final String EXPORT_DOC = "Generate offset reset
information in CSV format for export to a file. Supported operations:
reset-offsets.";
private static final String RESET_TO_OFFSET_DOC = "Reset offsets to a
specific offset.";
private static final String RESET_FROM_FILE_DOC = "Reset offsets to values
defined in CSV file.";
private static final String RESET_TO_DATETIME_DOC = "Reset offsets to
offset from datetime. Format: 'YYYY-MM-DDThh:mm:ss.sss'";
- private static final String RESET_BY_DURATION_DOC = "Reset offsets to
offset by duration from current timestamp. Format: 'PnDTnHnMnS'";
+ private static final String RESET_BY_DURATION_DOC = "Reset offsets by
duration from current timestamp. Format: 'PnDTnHnMnS'";
private static final String RESET_TO_EARLIEST_DOC = "Reset offsets to
earliest offset.";
private static final String RESET_TO_LATEST_DOC = "Reset offsets to latest
offset.";
private static final String RESET_TO_CURRENT_DOC = "Reset offsets to
current offset.";
private static final String RESET_SHIFT_BY_DOC = "Reset offsets shifting
current offset by 'n', where 'n' can be positive or negative.";
- private static final String MEMBERS_DOC = "Describe members of the group.
This option may be used with '--describe' and '--bootstrap-server' options
only." + NL +
+ private static final String MEMBERS_DOC = "Describe members of the group.
This option may be used with the --describe option only." + NL +
"Example: --bootstrap-server localhost:9092 --describe --group group1
--members";
- private static final String VERBOSE_DOC = "Provide additional information,
if any, when describing the group. This option may be used " +
- "with '--offsets'/'--members'/'--state' and '--bootstrap-server'
options only." + NL + "Example: --bootstrap-server localhost:9092 --describe
--group group1 --members --verbose";
+ private static final String VERBOSE_DOC = "Provide additional information,
if any, when describing the group. This option may be used with the --describe
option only.";
private static final String OFFSETS_DOC = "Describe the group and list all
topic partitions in the group along with their offset lag. " +
- "This is the default sub-action of and may be used with '--describe'
and '--bootstrap-server' options only." + NL +
+ "This is the default sub-action of and may be used with the --describe
option only." + NL +
"Example: --bootstrap-server localhost:9092 --describe --group group1
--offsets";
- private static final String STATE_DOC = "When specified with '--describe',
includes the state of the group." + NL +
+ private static final String STATE_DOC = "When specified with --describe,
includes the state of the group." + NL +
Review Comment:
use common wordings instead, which is used at rest of the places - "it
displays"
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
