You are here: References > nitrostat

3.3 nitrostat

nitrostat is a utility found in the /opt/nitro/bin directory that will display the status of a Nitro job or of individual tasks. nitrostat lets you quickly find specific tasks or list all failed, invalid, or timed out tasks. nitrostat also offers a "wait" mode that will monitor the task log for tasks matching the specified criteria until the job completes.

3.3.1 Running nitrostat

To run nitrostat, you'll need to know the job ID of the job you want to monitor. For example, if you have a job with ID "3145", you can monitor the job progress with the following command:

/opt/nitro/bin/nitrostat 3145 -w

nitrostat assumes that the job information can be found in $HOME/nitro/<job id>.

If you have specified a different location for the job directory using the Nitro "‑‑job‑dir" command line option, then you'll need to specify the same location using the nitrostat "‑‑job‑dir" command line option.

For example, if your job directory is in $HOME/projects/survey03 then use the following command:

/opt/nitro/bin/nitrostat 3145 --job-dir $HOME/projects/survey03 -w

nitrostat will show the following information when job status is requested:

Nitro Job Progress Report

Start Time  : 2015-06-17 09:10:11-0600

Current Time: 2015-06-17 09:10:42-0600

Elapsed Time: 31 seconds (00:00:31)

Job Id      : 23576

Coordinator : node01

Task Log    : /home/jdoe/projects/survey03/23576/nitro_23576.tasklog.txt

Task File   : /home/jdoe/projects/survey03/survey03.tasks

  File Size : 123366

  Est Tasks : 3016

  Processed : 75%

Tasks

------------

Pending     : 500

Running     : 500

Completed   : 1250

  Success   : 1250

  Failure   : 0

  InsufRes  : 0

  Timeout   : 0

  Invalid   : 0

  Tasks/sec : 40.3

Total Tasks : 2250

Workers

-------

Host   Port  Pid    Thrds Status  Assigned Running Completed  Success  Failure  InsufRes Timeout Tasks/sec AsgmtDur

node02 47000 6851     12  running     1250     250      1000     1000        0         0       0      36.0      8.0

node03 47000 14988     4  running      500     250       250      250        0         0       0       9.3     27.0

3.3.2 Searching for Task Records

You can use nitrostat to search the task log by task name, task ID, or label using regular expressions. You can also combine criteria to further refine your search.

For example, if you want to search for tasks containing the task name "Survey03" and the label "NYC" you can specify the command line as follows:

/opt/nitro/bin/nitrostat Job01 --name Survey03 --label NYC

The following identifies the nitrostat command line options.

‑‑all, ‑a – Shows all tasks.
‑‑completed, ‑c – Shows completed tasks.
‑‑failed, ‑f – Shows failed tasks.
‑‑invalid, ‑i – Shows invalid tasks.
‑‑timedout, ‑o – Shows tasks that timed out (exceeded maxtime).
‑‑wait, ‑w – Continues updating results until entire job is completed.
‑‑name, ‑n <task name> – Shows task(s) with the specified task name.
‑‑task, ‑t <task id> – Shows the task with the specified task ID.
label, ‑l <label list> – Shows all tasks that contain the specified label. <label list> is a comma-separated list of labels that may not contain spaces.
‑‑working‑dir, ‑d <directory> — Uses the specified working directory to locate the job and task log files. The default working directory is $HOME/nitro.
‑‑regex – If set, uses regular expression as the matching mode for <task name>, <task id>, and <label list>. The default is literal (exact string).