sstat man page

sstat — Display various status information of a running job/step.

Synopsis

sstat [OPTIONS...]

Description

Status information for running jobs invoked with Slurm.

The sstat command displays job status information for your analysis. The sstat command displays information pertaining to CPU, Task, Node, Resident Set Size (RSS) and Virtual Memory (VM). You can tailor the output with the use of the --fields= option to specify the fields to be shown.

For the root user, the sstat command displays job status data for any job running on the system.

For the non-root user, the sstat output is limited to the user's jobs.

NOTE:  The sstat command requires that the jobacct_gather plugin be installed and operational.

NOTE:  The sstat command is not supported on Cray ALPS or IBM BlueGene systems.

-a, --allsteps

Print all steps for the given job(s) when no step is specified.

-e, --helpformat

Print a list of fields that can be specified with the '--format' option.

-h, --help

Displays a general help message.

-i, --pidformat

Predefined format to list the pids running for each job step. (JobId,Nodes,Pids)

-j, --jobs

Format is <job(.step)>. Stat this job step or comma-separated list of job steps. This option is required.  The step portion will default to lowest step running if not specified, unless the --allsteps flag is set where not specifying a step will result in all running steps to be displayed. NOTE: A step id of 'batch' will display the information about the batch step. NOTE: A step id of 'extern' will display the information about the extern step.  This step is only available when using PrologFlags=contain

-n, --noheader

No heading will be added to the output. The default action is to display a header.

--noconvert

Don't convert units from their original type (e.g. 2048M won't be converted to 2G).

-o, --format, --fields

Comma separated list of fields. (use '--helpformat' for a list of available fields).

NOTE: When using the format option for listing various fields you can put a %NUMBER afterwards to specify how many characters should be printed.

i.e. format=name%30 will print 30 characters of field name right justified.  A -30 will print 30 characters left justified.

-p, --parsable

output will be '|' delimited with a '|' at the end

-P, --parsable2

output will be '|' delimited without a '|' at the end

--usage

Display a command usage summary.

-v, --verbose

Primarily for debugging purposes, report the state of various variables during processing.

-V, --version

Print version.

Job Status Fields

The following are the field options:

AveCPU

Average (system + user) CPU time of all tasks in job.

AveCPUFreq

Average weighted CPU frequency of all tasks in job, in kHz.

AveDiskRead

Average number of bytes read by all tasks in job.

AveDiskWrite

Average number of bytes written by all tasks in job.

AvePages

Average number of page faults of all tasks in job.

AveRSS

Average resident set size of all tasks in job.

AveVMSize

Average Virtual Memory size of all tasks in job.

ConsumedEnergy

Total energy consumed by all tasks in job, in joules. Note: Only in case of exclusive job allocation this value  reflects the jobs' real energy consumption.

JobID

The number of the job or job step. It is in the form: job.jobstep.

MaxDiskRead

Maximum number of bytes read by all tasks in job.

MaxDiskReadNode

The node on which the maxdiskread occurred.

MaxDiskReadTask

The task ID where the maxdiskread occurred.

MaxDiskWrite

Maximum number of bytes written by all tasks in job.

MaxDiskWriteNode

The node on which the maxdiskwrite occurred.

MaxDiskWriteTask

The task ID where the maxdiskwrite occurred.

MaxPages

Maximum number of page faults of all tasks in job.

MaxPagesNode

The node on which the maxpages occurred.

MaxPagesTask

The task ID where the maxpages occurred.

MaxRSS

Maximum resident set size of all tasks in job.

MaxRSSNode

The node on which the maxrss occurred.

MaxRSSTask

The task ID where the maxrss occurred.

MaxVMSize

Maximum Virtual Memory size of all tasks in job.

MaxVMSizeNode

The node on which the maxvsize occurred.

MaxVMSizeTask

The task ID where the maxvsize occurred.

MinCPU

Minimum (system + user) CPU time of all tasks in job.

MinCPUNode

The node on which the mincpu occurred.

MinCPUTask

The task ID where the mincpu occurred.

NTasks

Total number of tasks in a job or step.

ReqCPUFreq

Requested CPU frequency for the step, in kHz.

Environment Variables

Some sstat options may be set via environment variables. These environment variables, along with their corresponding options, are listed below. (Note: commandline options will always override these settings)

SLURM_CONF

The location of the Slurm configuration file.

Examples

sstat --format=AveCPU,AvePages,AveRSS,AveVMSize,JobID -j 11

25:02.000  0K         1.37M      5.93M      9.0

sstat -p --format=AveCPU,AvePages,AveRSS,AveVMSize,JobID -j 11

25:02.000|0K|1.37M|5.93M|9.0|

Copying

Copyright (C) 2009 Lawrence Livermore National Security. Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
Copyright (C) 2010-2013 SchedMD LLC.

This file is part of Slurm, a resource management program. For details, see <https://slurm.schedmd.com/>.

Slurm is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Slurm is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

See Also

sacct(1)

Referenced By

sacct(1), slurm(1).

Slurm Commands April 2015