martin-g commented on code in PR #1593: URL: https://github.com/apache/datafusion-ballista/pull/1593#discussion_r3146241573
########## docs/source/user-guide/cli.md: ########## @@ -130,3 +137,37 @@ Available commands inside Ballista CLI are: ```bash > \h function_table ``` + +## Terminal User Interface (TUI) + +When Ballista CLI is built with the `tui` feature, you can launch an interactive terminal user interface +that provides a visual overview of the Ballista cluster. + +### Launching the TUI + +```bash +ballista-cli --tui +``` + +### TUI Features + +The TUI provides the following views: + +- **Executors**: Lists all registered executors with their host, port, CPU cores, memory, and current job count. Supports sorting by any column. +- **Jobs**: Displays active and completed jobs with their status, start time, and duration. Supports sorting and shows job details on selection. +- **Metrics**: Fetches and displays Prometheus metrics from the scheduler, including query execution statistics. +- **Scheduler Info**: Shows the current scheduler state and configuration. + +### TUI Navigation + +| Key | Action | +|-----|--------| +| `Tab` | Switch between Executors, Jobs, and Metrics tabs | Review Comment: This is not correct! `Tab` does not switch. There are keybindings: - `j` for Jobs - `e` for Executors - `m` for Metrics ########## docs/source/user-guide/cli.md: ########## @@ -130,3 +137,37 @@ Available commands inside Ballista CLI are: ```bash > \h function_table ``` + +## Terminal User Interface (TUI) + +When Ballista CLI is built with the `tui` feature, you can launch an interactive terminal user interface +that provides a visual overview of the Ballista cluster. + +### Launching the TUI + +```bash +ballista-cli --tui +``` + +### TUI Features + +The TUI provides the following views: + +- **Executors**: Lists all registered executors with their host, port, CPU cores, memory, and current job count. Supports sorting by any column. +- **Jobs**: Displays active and completed jobs with their status, start time, and duration. Supports sorting and shows job details on selection. +- **Metrics**: Fetches and displays Prometheus metrics from the scheduler, including query execution statistics. +- **Scheduler Info**: Shows the current scheduler state and configuration. + +### TUI Navigation + +| Key | Action | +|-----|--------| +| `Tab` | Switch between Executors, Jobs, and Metrics tabs | +| `↑` / `↓` | Navigate rows in the current table | +| `←` / `→` | Change sort column | Review Comment: This is also not correct! `1` sorts the first column. Pressing it once sorts, pressing it twice reverses the sorting, pressing it a third time removes the sorting for this column. `2` is for the second column. `3` for the third one and so on. ########## docs/source/user-guide/cli.md: ########## @@ -130,3 +137,37 @@ Available commands inside Ballista CLI are: ```bash > \h function_table ``` + +## Terminal User Interface (TUI) + +When Ballista CLI is built with the `tui` feature, you can launch an interactive terminal user interface +that provides a visual overview of the Ballista cluster. + +### Launching the TUI + +```bash +ballista-cli --tui +``` + +### TUI Features + +The TUI provides the following views: + +- **Executors**: Lists all registered executors with their host, port, CPU cores, memory, and current job count. Supports sorting by any column. +- **Jobs**: Displays active and completed jobs with their status, start time, and duration. Supports sorting and shows job details on selection. +- **Metrics**: Fetches and displays Prometheus metrics from the scheduler, including query execution statistics. +- **Scheduler Info**: Shows the current scheduler state and configuration. + +### TUI Navigation + +| Key | Action | +|-----|--------| +| `Tab` | Switch between Executors, Jobs, and Metrics tabs | +| `↑` / `↓` | Navigate rows in the current table | +| `←` / `→` | Change sort column | +| `Enter` | Open details popup for the selected job | Review Comment: This is not yet implemented :-) #1574 -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
