Skip to content

tools - traffic_ctl, traffic_layout: use ArgParse groups to handle mutually exclusive options. #12623

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
brbzull0 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

tools - traffic_ctl, traffic_layout: use ArgParse groups to handle mutually exclusive options. #12623

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9a9b0c
tools - traffic_ctl, traffic_layout: use ArgParse groups to handle
brbzull0 Oct 29, 2025
826c4ae
Use add_mutex_group fn
brbzull0 Nov 5, 2025
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
14 changes: 9 additions & 5 deletions src/traffic_ctl/traffic_ctl.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,11 +177,15 @@ main([[maybe_unused]] int argc, const char **argv)
// server commands
server_command.add_command("backtrace", "Show a full stack trace of the traffic_server process",
[&]() { CtrlUnimplementedCommand("backtrace"); });
server_command.add_command("status", "Show the proxy status", Command_Execute).add_example_usage("traffic_ctl server status");
server_command.add_command("drain", "Drain the requests", Command_Execute)
.add_example_usage("traffic_ctl server drain [OPTIONS]")
.add_option("--no-new-connection", "-N", "Wait for new connections down to threshold before starting draining")
.add_option("--undo", "-U", "Recover server from the drain mode");
server_command.add_command("status", "Show the proxy status", [&]() { command->execute(); })
.add_example_usage("traffic_ctl server status");
auto &drain_cmd = server_command.add_command("drain", "Drain the requests", [&]() { command->execute(); });
drain_cmd.add_example_usage("traffic_ctl server drain [OPTIONS]");

drain_cmd.add_mutex_group("drain_mode", false, "Drain mode options");
drain_cmd.add_option_to_group("drain_mode", "--no-new-connection", "-N",
"Wait for new connections down to threshold before starting draining");
drain_cmd.add_option_to_group("drain_mode", "--undo", "-U", "Recover server from the drain mode");

auto &debug_command =
server_command.add_command("debug", "Enable/Disable ATS for diagnostic messages at runtime").require_commands();
Expand Down
11 changes: 6 additions & 5 deletions src/traffic_layout/traffic_layout.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,12 @@ main([[maybe_unused]] int argc, const char **argv)
.add_option("--version", "-V", "Print version string");

// info command
engine.parser.add_command("info", "Show the layout as default", [&]() { engine.info(); })
.add_option("--features", "", "Show the compiled features")
.add_option("--versions", "", "Show various library and other versioning information")
.add_option("--json", "-j", "Produce output in JSON format (when supported)")
.set_default();
auto &info_cmd = engine.parser.add_command("info", "Show the layout as default", [&]() { engine.info(); });
info_cmd.add_mutex_group("display_mode", false, "Display mode options");
info_cmd.add_option_to_group("display_mode", "--features", "", "Show the compiled features");
info_cmd.add_option_to_group("display_mode", "--versions", "", "Show various library and other versioning information");

info_cmd.add_option("--json", "-j", "Produce output in JSON format (when supported)").set_default();
// init command
engine.parser.add_command("init", "Initialize(create) the runroot sandbox", [&]() { engine.create_runroot(); })
.add_option("--absolute", "-a", "Produce absolute path in the runroot.yaml")
Expand Down