.TH "work_queue_status" 1 "" "CCTools 8.0.0 DEVELOPMENT" "Cooperative Computing Tools"

.SH NAME
.LP
\fBwork_queue_status\fP - display status of currently running Work Queue applications.

.SH SYNOPSIS
.LP
\FC\fBwork_queue_status [options] [manager] [port]\fP\FT

.SH DESCRIPTION
.LP

\fBwork_queue_status\fP displays the status of currently running Work Queue applications.
When run with no options, it queries the global catalog server to list the currently running
Work Queue managers.  When given an address and a port, it queries a manager directly to obtain
more detailed information about tasks and workers.


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


.SH OPTIONS
.LP
.LP
.TP
.BI \ --where \ <expr>
.
 Show only Work Queue managers matching this expression.
.TP
.B \ -Q, --statistics
.
Show summary information about queues. (default)
.TP
.B \ -M, --project-name=<name>
.
Filter results of -Q for managers matching <name>.
.TP
.B \ -W, --workers
.
Show details of all workers connected to the manager.
.TP
.B \ -T, --tasks
.
Show details of all tasks in the queue.
.TP
.B \ -A, --able-workers
.
List categories of the given manager, size of largest task, and workers that can run it.
.TP
.B \ -R, --resources
.
Show available resources for each manager.
.TP
.B \ --capacity
.
Show resource capacities for each manager.
.TP
.B \ -l, --verbose
.
Long output.
.TP
\fB-C\fP, \fB-\-catalog\fP=\fI<catalog>\fP
.
Set catalog server to <catalog>. Format: HOSTNAME:PORT
.TP
\fB-d\fP, \fB-\-debug\fP=\fI<flag>\fP
.
Enable debugging for the given subsystem. Try -d all as a start.
.TP
\fB-t\fP, \fB-\-timeout\fP=\fI<time>\fP
.
RPC timeout (default=300s).
.TP
\fB-o\fP, \fB-\-debug-file\fP=\fI<file>\fP
.
Send debugging to this file. (can also be :stderr, or :stdout)
.TP
\fB-O\fP, \fB-\-debug-rotate-max\fP=\fI<bytes>\fP
.
Rotate debug file once it reaches this size.
.TP
.B \ -v, --version
.
Show work_queue_status version.
.TP
.B \ -h, --help
.
Show this help message.


.SH EXAMPLES
.LP

Without arguments, \FCwork_queue_status\FT shows a summary of all of the
projects currently reporting to the default catalog server. Waiting, running,
and complete columns refer to number of tasks:

.fam C
.nf
.nh
.IP "" 8
$ work_queue_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
.fi
.hy
.fam
.P

With the \FC-R\FT option, a summary of the resources available to each manager is shown:

.fam C
.nf
.nh
.IP "" 8
$ work_queue_status -R
MANAGER                         CORES      MEMORY          DISK
shrimp                         228        279300          932512
crustacea                      4200       4136784         9049985
.fi
.hy
.fam
.P

With the \FC--capacity\FT option, a summary of the resource capacities for each manager is shown:

.fam C
.nf
.nh
.IP "" 8
$ work_queue_status --capacity
MANAGER                         TASKS      CORES      MEMORY          DISK
refine                         ???        ???        ???             ???
shrimp                         99120      99120      781362960       1307691584
crustacea                      318911     318911     326564864       326564864
.fi
.hy
.fam
.P

Use the \FC-W\FT option to list the workers connected to a particular manager.
Completed and running columns refer to numbers of tasks:

.fam C
.nf
.nh
.IP "" 8
$ work_queue_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
.fi
.hy
.fam
.P

With the \FC-T\FT option, a list of all the tasks submitted to the queue is shown:

.fam C
.nf
.nh
.IP "" 8
$ work_queue_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
...
.fi
.hy
.fam
.P


The \FC-A\FT option shows a summary of the resources observed per task
category.

.fam C
.nf
.nh
.IP "" 8
$ work_queue_status -T 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
.fi
.hy
.fam
.P

With the -A option:

.IP \(bu 4
Running and waiting correspond to number of tasks in the category.
.IP \(bu 4
Fit-workers shows the number of connected workers able to run the largest task in the category.
.IP \(bu 4
max-cores, max-memory, and max-disk show the corresponding largest value in the category.


The value may have the following prefixes:

.IP \(bu 4
No prefix. The maximum value was manually specified.
.IP \(bu 4
~ All the task have run with at most this quantity of resources.
.IP \(bu 4
> There is at least one task that has used more than this quantity of resources, but the maximum remains unknown.



Finally, the \FC-l\FT option shows statistics of the queue in a JSON object:

.fam C
.nf
.nh
.IP "" 8
$ work_queue_status -l cclws16.cse.nd.edu 9001
{"categories":[{"max_disk":"3500","max_memory":"1024","max_cores":"1",...
.fi
.hy
.fam
.P

.SH EXIT STATUS
.LP
On success, returns zero.  On failure, returns non-zero.

.SH COPYRIGHT
.LP

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

.SH SEE ALSO
.LP


.IP \(bu 4
\fBCooperative Computing Tools Documentation\fP
.IP \(bu 4
\fBWork Queue User Manual\fP
.IP \(bu 4
\fBwork_queue_worker(1)\fP \fBwork_queue_status(1)\fP \fBwork_queue_factory(1)\fP \fBcondor_submit_workers(1)\fP \fBsge_submit_workers(1)\fP \fBtorque_submit_workers(1)\fP