swif2 status

Display status information about the workflow.

Usage

swif2 status <workflow> [options]

Control what status information is displayed by specifying one or more of the flags listed below. If no specific subset of status information is requested, then the summary will be displayed. Also note that you can choose to display the information in XML, JSON, or simple text format. Both XML and JSON formats will return a structure containing the sub-reports. The "simple" format will display the requested sub-reports in a series of flattened (name = value) pairs, with each section titled by the report name followed by a colon (:).

Arguments

Flag	Value	Comment
-summary		Request workflow overview
-problems		Request problem details.
-jobs		Request detailed information about all jobs.
-transfers		Request transfer pipeline status for active job attempts.
-storage		Request input cache storage usage.
-display	xml\|json\|simple	Specify format for retrieved report.

Reports

Summary

Key	Type	Value
workflow_id	integer
workflow_name	string
workflow_user	string
workflow_site	string
workflow_site_login	string
workflow_site_storage	string
frozen	boolean
suspended	boolean
phase	integer
phase_limit	integer
job_limit	integer
error_limit	integer
max_concurrent	integer
jobs	integer	Total number of jobs in the workflow.
undispatched	integer	Number of jobs that do not have an active attempt, and which are not done or abandoned.
dispatched	integer	Number of active job attempts, including those preparing, running, and in error state.
dispatched_preparing	integer	Number of job attempts that are preparing to launch
dispatched_running	integer	Number of job attempts that have `RUNNING` slurm jobs.
dispatched_pending	integer	Number of job attempts that have `PENDING` slurm jobs.
dispatched_other	integer	Numner of job attempts that have slurm jobs in some state other than `PENDING` or `RUNNING`.
dispatched_reaping	integer	Number of job attempts that are being finalized by transferring outputs and cleaning up.
succeeded	integer	Number of jobs with fully successful job attempts.
abandoned	integer	Number of jobs that have been abandoned.
problems	integer	Number of unresolved problem job attempts.
problem_types	string	Comma-seaparted list of problem types for unresolved job attempts.
attempts	integer	Total number of past and active job attempts that have been made for jobs in this workflow
xfer_mb_from_tape	integer	Amount of data currently being fetched from tape.
xfer_mb_to_site	integer	Amount of data currently being sent to site.
xfer_globus_jobs_to_site	integer	Number of globus requests transferring to site.
xfer_mb_from_site	integer	Amount of data currently being extracted from site.
xfer_mb_to_tape	integer	Amount of data currently being written to tape.
xfer_globus_jobs_from_site	integer	Number of globus requests transferring from site.
input_mb_processed	integer	Amount of input data successfully processed by job attempts.
output_mb_generated	integer	Amount of data produced by successful job attempts.
create_ts	timestamp	When the workflow was created.
update_ts	timestamp	Timestamp of most recent job attempt update.

Problems

Key	Type	Value
job_id	integer
job_name	string
job_attempt_problem	string	Consult overview documentation for possible values.
job_attempt_problem_details	string	Specific error message.

Jobs

Key	Type	Value
job_id	integer
job_name	string
workflow_name	string
workflow_user	string
job_phase	integer
site_job_command	string	The command passed to slurm.
site_job_batch_flags	string	Pass-through sbatch arguments.
site_job_account	string	Account specified in sbatch submission.
site_job_partition	string	Partition specified in sbatch submission.
site_job_cpu_cores	integer	Requested number of cores.
site_job_time_secs	integer	Requested wall time allocation.
site_job_ram_bytes	integer	Requested memory allocation.
site_job_disk_bytes	integer	Requested disk space allocation.
site_job_exclusive	boolean	True iff exclusive node is required.
site_job_constraint	string	Requested constraint.
site_job_stdout	string	Location for standard output.
site_job_stderr	string	Location for standard error.
job_status	string	One of the possible job status states as described in overview documentation.
job_attempt_status	string	Status of most recent job attempt.
job_attempt_problem	string	Problem classification of most recent job attempt.
job_attempt_problem_details	string	Specific error message of most recent job attempt.
num_attempts	integer	Total number of job attempts created for this job.
tags	list	Tag (name,value) pairs associated with this job.
antecedents	list	Job (status,id) pairs of antecedent jobs.
conditions	list	(status,uri) pairs of conditions.
inputs	list	Inputs specified for job.
outputs	list	Outputs specified for job.
attempts	list	Details of all attempts for this job.

Job Attempts

Key	Type	Value
job_id
job_attempt_id
slurm_id
job_attempt_status
job_attempt_problem
job_attempt_problem_details
job_attempt_problem_resolution
job_attempt_cleanup
job_attempt_update_ts
site_id
site_job_command
site_job_batch_flags
site_job_account
site_job_partition
site_job_cpu_cores
site_job_time_secs
site_job_disk_bytes
site_job_ram_bytes
site_job_exclusive
site_job_constraint
site_job_stdout
site_job_stderr
slurm_nodelist
slurm_avecpu
slurm_avediskread
slurm_avers
slurm_avevmsize
slurm_cputime
slurm_elapsed
slurm_end
slum_exitcode
slurm_start
slurm_state
slurm_maxdiskread
slurm_maxdiskwrite
slurm_maxpage
slurm_maxrss
slurm_maxvmsize
slurm_exitsignal
slurm_avediskwrite
slurm_gather_ts

Input Transfers

Shows the pipeline status for input files of active job attempts. Each row represents a stage in the transfer pipeline.

Key	Type	Value
stage	string	Pipeline stage: `locating`, `caching`, `transferring`, `ready`, or `failed`.
files	integer	Number of input files in this stage.
gb	decimal	Total size in GB.
oldest	timestamp	Earliest timestamp entering this stage.
newest	timestamp	Latest timestamp entering this stage.

Stages: locating means the source file's existence is being verified on the filesystem; caching means the file is being staged from tape to disk; transferring means the file is being pushed to the compute site via Globus or Rucio; ready means the file has been delivered; failed means a transfer error occurred.

Output Transfers

Shows the pipeline status for output files of active job attempts.

Key	Type	Value
stage	string	Pipeline stage: `pulling`, `taping`, `copying`, `done`, or `failed`.
files	integer	Number of output files in this stage.
gb	decimal	Total size in GB.
oldest	timestamp	Earliest timestamp entering this stage.
newest	timestamp	Latest timestamp entering this stage.

Stages: pulling means the file is being retrieved from the compute site; taping means the file is being archived to tape; copying means the file is being written to its final filesystem location; done means the file has reached permanent storage; failed means a transfer error occurred.

Transfer Errors

Shows recent transfer error messages for this workflow, grouped by error text.

Key	Type	Value
direction	string	`input` or `output`.
error	string	The error message.
count	integer	Number of files with this error.

Input Cache

Shows how much space the workflow's input files occupy on each site storage area.

Key	Type	Value
storage	string	Site storage area name.
files	integer	Number of cached input files for this workflow.
gb	decimal	Total size in GB.
capacity_gb	decimal	Storage area capacity in GB (null if unlimited).
oldest	timestamp	Timestamp of oldest cached file.
newest	timestamp	Timestamp of newest cached file.