There are several commands available that allow you to check the status of your job, monitor execution of a running job, and collect performance statistics for your job. You can also delete a job if necessary.
You can monitor the batch queues and check the status of your job using the commands
showq. There is also a command to get an extremely unreliable estimate of the time your job will start. This section also addresses the question of why a job may have a long queue wait and explains a little about how job scheduling works.
qstat command to check the status of your jobs. You can see whether your job is queued or running, along with information about requested resources. If the job is running you can see elapsed time and resources used.
Here are some examples for user usr1234 and job 123456.
qstat lists all jobs in the system:
To list all the jobs belonging to a particular user:
qstat -u usr1234
To list the status of a particular job, in standard or alternate (more useful!) format:
qstat -a 123456
To get all the details about a particular job (full status):
qstat -f 123456
showq command lists job information from the point of view of the scheduler. Jobs are grouped according to their state: running, idle, or blocked.
To list all jobs in the system:
To list all jobs belonging to a particular user (-u flag may be combined with others):
showq -u usr1234
Idle jobs are those that are eligible to run; they are listed in priority order. Note that the priority order may change over time. Note also that jobs may be run out of order if resources are not immediately available to run the highest priority job (“backfill”). This is done in such a way that it does not delay the start of the highest priority job.
To list details about idle jobs:
showq -i showq -i -u usr1234
Blocked jobs are those that are not currently eligible to run. There are several reasons a job may be blocked.
To list blocked jobs:
showq -b showq -b -u usr1234
showstart command gives an estimate for the start time of a job. Unfortunately, these estimates are not at all accurate except for the highest priority job in the queue. If the time shown is exactly midnight two or three days in the future, it is meaningless. Otherwise the estimate may be off by a large amount in either direction.
There are many reasons that your job may have to wait in the queue longer than you would like. Here are some of them.
Priority is a complicated function of many factors, including the processor count and walltime requested, the length of time the job has been waiting, and how much other computing has been done by the user and their group over the last several days.
During each scheduling iteration, the scheduler will identify the highest priority job that cannot currently be run and find a time in the future to reserve for it. Once that is done, the scheduler will then try to backfill as many lower priority jobs as it can without affecting the highest priority job's start time. This keeps the overall utilization of the system high while still allowing reasonable turnaround time for high priority jobs. Short jobs and jobs requesting few resources are the easiest to backfill.
A small number of nodes are set aside during the day for jobs with a walltime limit of 1 hour or less, primarily for debugging purposes.
You can monitor a running batch job almost as easily as you can monitor a program running interactively. The
qpeek command allows you to see the output that would normally appear on your display. The
pdsh command allows you to monitor your job’s CPU and memory usage, among other things. These commands are run from the login node.
A job’s stdout and stderr data streams, which normally show up on the screen, are written to log files. These log files are stored on a server until the job ends, so you can’t look at them directly. The
qpeek command allows you to peek at their contents. If you used the PBS header line to join the stdout and stderr streams (
#PBS -j oe), the two streams are combined in the output log.
Here are a few examples for job 123456. You can use the
-e flag with any of them to get the error log instead of the output log. (This is not applicable if you used “
#PBS -j oe”.)
To display the current contents of the output log (stdout) for job 123456:
To display the current contents of the error log (stderr) for job 123456:
qpeek -e 123456
To display just the beginning (“head”) of the output log for job 123456:
qpeek -h 123456
To display just the end (“tail”) of the output log for job 123456:
qpeek -t 123456
To display the end of the output log and keep listening (“
tail -f”) – terminate with Ctrl-C:
qpeek -f 123456
If you’re in the habit of monitoring your programs using
ps or something similar, you may find the
pdsh command helpful.
pdsh stands for “Parallel Distributed Shell”. It lets you run a command in parallel on all the nodes assigned to your job, with the results displayed on your screen. It is primarily used with parallel jobs.
pdsh is used primarily on Oakley.
Caution: The commands that you run should be quick and simple to avoid interfering with the job. This is especially true if your job is sharing a node with other jobs.
Two useful commands often used with
uptime, which displays system load, and
free, which gives memory usage; see also the
man pages for these commands. There are also options for
top that make it usable with
Since this is a parallel command, the output for the various nodes will appear in an unpredictable order.
Examples for job 123456 on Oakley (similar for Ruby and Owens):
pdsh -j 123456 uptime pdsh -j 123456 free -mo pdsh -j 123456 top -b -n 1 -u usr1234
qstat command provides information about CPU, memory, and walltime usage for running jobs. With the
-a flag, it shows elapsed time (wall time) in hours and minutes. With no flag, it shows “Time Used”, an accounting metric, in hours, minutes, and seconds. With the
-f flag, it shows resources used, with information aggregated across all the nodes the job is running on.
qstat -a 123456 qstat -f 123456
Situations may arise in which you want to delete one of your jobs from the PBS queue. Perhaps you set the resource limits incorrectly, neglected to copy an input file, or had incorrect or missing commands in the batch file. Or maybe the program is taking too long to run (infinite loop).
The PBS command to delete a batch job is
qdel. It applies to both queued and running jobs.
If you are unable to delete one of your jobs, it may be because of a hardware problem or system software crash. In this case you should contact OSC Help.
You can alter certain attributes of your job while it’s in the queue using the
qalter command. This can be useful if you want to make a change without losing your place in the queue. You cannot make any alterations to the executable portion of the script, nor can you make any changes after the job starts running.
The syntax is:
The options argument consists of one or more PBS directives in the form of command-line options.
For example, to change the walltime limit on job 123456 to 5 hours and have email sent when the job ends (only):
qalter -l walltime=5:00:00 -m e 123456
If you want to prevent a job from running but leave it in the queue, you can place a hold on it using the
qhold command. The job will remain blocked until you release it with the
qrls command. A hold can be useful if you need to modify the input file for a job, for example, but you don’t want to lose your place in the queue.
qhold 123456 qrls 123456
There are commands you can include in your batch script to collect job statistics or performance information.
date command prints the current date and time. It can be informative to include it at the beginning and end of the executable portion of your script as a rough measure of time spent in the job.
time utility is used to measure the performance of a single command. It can be used for serial or parallel processes. Add
/usr/bin/time to the beginning of a command in the batch script:
/usr/bin/time myprog arg1 arg2
The result is provided in the following format:
These results are appended to the job's error log file. Note: Use the full path “
/usr/bin/time” to get all the information shown.
The job accounting utility
ja prints job accounting information inside a PBS job, including CPU time, memory, virtual memory, and walltime used. This information is also included in the email sent when a jobs ends (if email is requested). While the job is running, the same information is available with the
qstat -f command.