vine_status(1)

💖 vine_status(1) 💖

okay bestie, gather round, because this is vine_status from the Cooperative Computing Tools, and she is literally the group chat of your TaskVine cluster. she tells you what's running, who's working, and what's still waiting. no cap. 🦋

---

✨ NAME ✨

vine_status — display status of currently running TaskVine applications.

---

🌸 SYNOPSIS 🌸

vine_status [options] [manager] [port]

---

💅 DESCRIPTION 💅

vine_status shows you the status of the TaskVine applications that are running right now. Run it with zero options and she goes and asks the global catalog server to list all the TaskVine managers currently up and at it. Give her an address and a port and she'll query that manager directly, so you get the juicy detailed tea about tasks and workers.

so here's the stuff she shows you:

• Hostname and port number of the application.
• Number of waiting tasks.
• Number of completed tasks.
• Number of connected workers.
• Number of tasks currently being executed.
• Timestamp of when there was last communication with the application.

---

🎀 OPTIONS 🎀

• --where=<expr> — only show TaskVine managers that match this expression.
• -Q, --statistics — show summary info about managers. (this one is the default, bestie)
• -M, --project-name=<name> — filter what -Q gives you down to managers matching <name>.
• -W, --workers — show the deets of every worker connected to the manager.
• -T, --tasks — show the deets of every task the manager knows about.
• -A, --able-workers — list the categories of the given manager, the size of the largest task, and the workers that can actually run it.
• -R, --resources — show the available resources for each manager.
• --capacity — show resource capacities for each manager.
• -l, --verbose — long output.
• -C, --catalog=<catalog> — set the catalog server to <catalog>. Format: HOSTNAME:PORT
• -C, --catalog=<catalog> — set the catalog server to <catalog>. Format: HOSTNAME:PORT
• -d, --debug=<flag> — enable debugging for the given subsystem. try -d all as a start.
• -t, --timeout=<time> — RPC timeout (default=300s).
• -o, --debug-file=<file> — send debugging to this file. (can also be :stderr, or :stdout)
• -O, --debug-rotate-max=<bytes> — rotate the debug file once it reaches this size.
• -v, --version — show vine_status version.
• -h, --help — show this help message.
• --ssl — enable tls connection to manager (the manager should support it).
• --tls-sni=<> — SNI domain name if it's different from the manager hostname. implies --ssl.

okay so real talk: -C,--catalog=<catalog> is listed twice up there and we are not editing the source material, so it stays twice. iconic behavior, honestly. 💀

---

🌈 EXAMPLES 🌈

🍓 no arguments

with no arguments at all, vine_status shows you a summary of all the projects currently reporting to the default catalog server. the Waiting, Running, and Complete columns are all about numbers of tasks:

$ vine_status
PROJECT            HOST                   PORT WAITING RUNNING COMPLETE WORKERS
shrimp             cclws16.cse.nd.edu     9001     963      37        2      33
crustacea          terra.solar.edu        9000       0    2310    32084     700

🧚 with -R

with the -R option you get a summary of the resources available to each manager:

$ vine_status -R
MANAGER                         CORES      MEMORY          DISK
shrimp                         228        279300          932512
crustacea                      4200       4136784         9049985

🫶 with --capacity

with the --capacity option, you get a summary of the resource capacities for each manager:

$ vine_status --capacity
MANAGER                         TASKS      CORES      MEMORY          DISK
refine                         ???        ???        ???             ???
shrimp                         99120      99120      781362960       1307691584
crustacea                      318911     318911     326564864       326564864

👑 with -W

use the -W option to list the workers connected to one particular manager. the Completed and Running columns are numbers of tasks:

$ vine_status -W cclws16.cse.nd.edu 9001
HOST                     ADDRESS          COMPLETED RUNNING
mccourt02.helios.nd.edu  10.176.48.102:40         0 4
cse-ws-23.cse.nd.edu     129.74.155.120:5         0 0
mccourt50.helios.nd.edu  10.176.63.50:560         4 4
dirt02.cse.nd.edu        129.74.20.156:58         4 4
cclvm03.virtual.crc.nd.e 129.74.246.235:3         0 0

⭐ with -T

with the -T option, you get a list of every task submitted to the manager:

$ vine_status -T cclws16.cse.nd.edu 9001
ID       STATE    PRIORITY HOST                     COMMAND
1000     WAITING         0 ???                      ./rmapper-cs -M fast -M 50bp 1
999      WAITING         0 ???                      ./rmapper-cs -M fast -M 50bp 1
21       running         0 cse-ws-35.cse.nd.edu     ./rmapper-cs -M fast -M 50bp 3
20       running         0 cse-ws-35.cse.nd.edu     ./rmapper-cs -M fast -M 50bp 2
19       running         0 cse-ws-35.cse.nd.edu     ./rmapper-cs -M fast -M 50bp 2
18       running         0 cse-ws-35.cse.nd.edu     ./rmapper-cs -M fast -M 50bp 2

💜 with -A

the -A option shows a summary of the resources observed per task category.

$ vine_status -A cclws16.cse.nd.edu 9001
CATEGORY        RUNNING    WAITING  FIT-WORKERS  MAX-CORES MAX-MEMORY   MAX-DISK
analysis            216        784           54          4      ~1011      ~3502
merge                20         92           30         ~1      ~4021      21318
default               1         25           54         >1       ~503       >243

with the -A option:

• Running and waiting correspond to the number of tasks in the category.
• Fit-workers shows the number of connected workers that are able to run the largest task in the category.
• max-cores, max-memory, and max-disk show the corresponding largest value in the category.

the value might have one of these prefixes:

• No prefix. the maximum value was manually specified.
• ~ all the tasks have run with at most this quantity of resources.
• ＞ there is at least one task that has used more than this quantity of resources, but the maximum remains unknown.

🔥 with -l

finally, the -l option shows statistics of the manager as a JSON object:

$ vine_status -l cclws16.cse.nd.edu 9001
{"categories":[{"max_disk":"3500","max_memory":"1024","max_cores":"1",...

---

😭 EXIT STATUS 😭

On success, returns zero. On failure, returns non-zero.

---

🎀 COPYRIGHT 🎀

The Cooperative Computing Tools are Copyright (C) 2022 The University of Notre Dame. This software is distributed under the GNU General Public License. See the file COPYING for details.

---

🦋 SEE ALSO 🦋

• Cooperative Computing Tools Documentation
• TaskVine User Manual
• vine_worker(1) vine_status(1) vine_factory(1) vine_graph_log(1)

---

and that's the whole page, bestie! this one is CCTools 7.15.9 FINAL, so go forth and status-check your managers 💖✨👑