milenkovicm commented on code in PR #1593: URL: https://github.com/apache/datafusion-ballista/pull/1593#discussion_r3204367769
########## docs/source/user-guide/cli.md: ########## @@ -28,6 +28,12 @@ Use Cargo to install: cargo install ballista-cli ``` +The TUI feature is enabled by default. To install without it: Review Comment: Do we need this in the manual ? ########## docs/source/user-guide/cli.md: ########## @@ -130,3 +137,91 @@ 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, job search (`/`), and shows job details on selection. +- **Job Stages**: When viewing a job, press `Enter` to see its execution stages with input/output rows, elapsed compute, and task percentiles. +- **Stage Tasks & Plan**: Within the Job Stages view, press `t` to see individual task details or `p` to view the stage execution plan. +- **Job Plans**: For completed jobs, press `p` to view the Stage, Physical, or Logical query plans. +- **Job Stages Graph**: Press `g` to visualize the job's stage execution graph. +- **Metrics**: Fetches and displays Prometheus metrics from the scheduler, including query execution statistics. +- **Scheduler Info**: Shows the current scheduler state and configuration. + +### TUI Navigation + +#### Global Keybindings Review Comment: Do we need to mention key bindings, they look obvious when when in tui mode? Also we risk to get document outdated quite quickly ########## docs/source/user-guide/cli.md: ########## @@ -130,3 +137,91 @@ 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 +``` + Review Comment: Should we mention `\tui` when we start cli? -- 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]
