Skip to content

ARTEMIS-6130 Clarify artemis check queue command options #6544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
brusdev wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −2
Open

ARTEMIS-6130 Clarify artemis check queue command options #6544

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/check/QueueCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ public class QueueCheck extends CheckAbstract {
@Option(names = "--up", description = "Check that the queue exists and is not paused. This check is executed by default if there are no other checks.")
private boolean up;

@Option(names = "--browse", description = "Number of the messages to browse or -1 to check that the queue is browsable.")
@Option(names = "--browse", description = "Number of the messages to browse or -1 to browse at most 1 message only if it is immediately available (succeeding also if no messages are available).")

@clebertsuconic clebertsuconic Jun 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@brusdev Is there a default value? perhaps you could specify (default = X) on the description).

@vitorpmoreira vitorpmoreira Jun 29, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think so, at least not through the cli. You must pass the --consume value. If you don't, you'll get an error.
image

If you pass a value lower than -1, you'll get an error.
image

@brusdev brusdev Jun 30, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I confirm there is no default value. @clebertsuconic are you suggesting adding a default value?

private Integer browse;

@Option(names = "--consume", description = "Number of the messages to consume or -1 to check that the queue is consumable.")
@Option(names = "--consume", description = "Number of the messages to consume or -1 to consume at most 1 message only if it is immediately available (succeeding also if no messages are available).")

@clebertsuconic clebertsuconic Jun 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

private Integer consume;

@Option(names = "--produce", description = "Number of the messages to produce.")
Expand Down
Loading