Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
S
Slurm
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
tud-zih-energy
Slurm
Commits
26414b3a
Commit
26414b3a
authored
14 years ago
by
Don Lipari
Browse files
Options
Downloads
Patches
Plain Diff
Improved the formatting of the sreport man page
parent
d91a389f
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/man/man1/sreport.1
+73
-50
73 additions, 50 deletions
doc/man/man1/sreport.1
with
73 additions
and
50 deletions
doc/man/man1/sreport.1
+
73
−
50
View file @
26414b3a
.TH SREPORT "1" "
February
200
9
" "sreport 2.0" "Slurm components"
.TH SREPORT "1" "
October
20
1
0" "sreport 2.0" "Slurm components"
.SH "NAME"
.SH "NAME"
sreport \- Generate reports from the slurm accounting data.
sreport \- Generate reports from the slurm accounting data.
...
@@ -7,9 +7,9 @@ sreport \- Generate reports from the slurm accounting data.
...
@@ -7,9 +7,9 @@ sreport \- Generate reports from the slurm accounting data.
\fBsreport\fR [\fIOPTIONS\fR...] [\fICOMMAND\fR...]
\fBsreport\fR [\fIOPTIONS\fR...] [\fICOMMAND\fR...]
.SH "DESCRIPTION"
.SH "DESCRIPTION"
\fBsreport\fR is used to generate
certain reports. It provides a view into accounting data gathered from slurm via
\fBsreport\fR is used to generate
reports of job usage and cluster
the account information maintained within a database with the interface
utilization for SLURM jobs saved to the SLURM Database,
being provided by the \fBslurmdbd\fR (Slurm Database daemon)
.
\fBslurmdbd\fR
.
.SH "OPTIONS"
.SH "OPTIONS"
...
@@ -33,9 +33,8 @@ Output will be '|' delimited without a '|' at the end.
...
@@ -33,9 +33,8 @@ Output will be '|' delimited without a '|' at the end.
Print no warning or informational messages, only error messages.
Print no warning or informational messages, only error messages.
.TP
.TP
\fB\-t <format>\fR
\fB\-t <format>\fR
Specify the output time format.
Specify the output time format. Time format options are case
Time format options are case insensitive and may be abbreviated.
insensitive and may be abbreviated. The default format is Minutes.
The default format is Minutes.
Supported time format options are listed in the \fBtime\fP command
Supported time format options are listed in the \fBtime\fP command
section below.
section below.
.TP
.TP
...
@@ -84,10 +83,10 @@ Identical to the \fBexit\fR command.
...
@@ -84,10 +83,10 @@ Identical to the \fBexit\fR command.
.TP
.TP
\fBtime <time_format>\fP
\fBtime <time_format>\fP
Specify the output time format.
Specify the output time format. Time format options are case
Time format options are case insensitive and may be abbreviated.
insensitive and may be abbreviated. The default format is Minutes.
The default format is Minutes.
Supported time format options include:
Supported time format options include:
.RS
.RS
.TP 10
.TP 10
\fBSecPer\fR
\fBSecPer\fR
...
@@ -132,25 +131,25 @@ Valid report types are:
...
@@ -132,25 +131,25 @@ Valid report types are:
\fBjob\fP \<REPORT\> \<OPTIONS\>
\fBjob\fP \<REPORT\> \<OPTIONS\>
\fBuser\fP \<REPORT\> \<OPTIONS\>
\fBuser\fP \<REPORT\> \<OPTIONS\>
.RE
.TP
.TP
\<REPORT\> options for each type include:
\<REPORT\> options for each type include:
\fBcluster\fP \- AccountUtilizationByUser, UserUtilizationByAccount,
UserUtilizationByWckey, Utilization, WCKeyUtilizationByUser
\fBjob\fP \- SizesByAccount, SizesByWckey
.B cluster
\- AccountUtilizationByUser, UserUtilizationByAccount,
UserUtilizationByWckey, Utilization, WCKeyUtilizationByUser
\fBreservation\fP \- Utilization
.B job
\- SizesByAccount, SizesByWckey
\fBuser\fP \- TopUsage
.B reservation
\- Utilization
.TP
.B user
\- TopUsage
.SH "REPORT DESCRIPTION"
.TP
REPORT DESCRIPTION
.RS
.TP
.TP
.B cluster AccountUtilizationByUser
.B cluster AccountUtilizationByUser
This report will display account utilization as it appears on the
This report will display account utilization as it appears on the
...
@@ -208,21 +207,27 @@ Each report type has various options...
...
@@ -208,21 +207,27 @@ Each report type has various options...
.TP
.TP
COMMON FOR ALL TYPES
COMMON FOR ALL TYPES
.RS
.TP
.TP
.B All_Clusters
.B All_Clusters
Use all monitored clusters. Default is local cluster.
Use all monitored clusters. Default is local cluster.
.TP
.TP
.B Clusters=<OPT>
.B Clusters=<OPT>
List of clusters to include in report. Default is local cluster.
List of clusters to include in report. Default is local cluster.
.TP
.TP
.B End=<OPT>
.B End=<OPT>
Period ending for report. Default is 23:59:59 of previous day.
Period ending for report. Default is 23:59:59 of previous day.
Valid time formats are...
Valid time formats are...
.sp
HH:MM[:SS] [AM|PM]
HH:MM[:SS] [AM|PM]
.sp
MMDD[YY] or MM/DD[/YY] or MM.DD[.YY]
MMDD[YY] or MM/DD[/YY] or MM.DD[.YY]
.sp
MM/DD[/YY]\-HH:MM[:SS]
MM/DD[/YY]\-HH:MM[:SS]
.sp
YYYY\-MM\-DD[THH:MM[:SS]]
YYYY\-MM\-DD[THH:MM[:SS]]
.TP
.TP
.B Format=<OPT>
.B Format=<OPT>
Comma separated list of fields to display in report.
Comma separated list of fields to display in report.
...
@@ -237,15 +242,18 @@ justified. A \-30 will print 30 characters left justified.
...
@@ -237,15 +242,18 @@ justified. A \-30 will print 30 characters left justified.
.B Start=<OPT>
.B Start=<OPT>
Period start for report. Default is 00:00:00 of previous day.
Period start for report. Default is 00:00:00 of previous day.
Valid time formats are...
Valid time formats are...
.sp
HH:MM[:SS] [AM|PM]
HH:MM[:SS] [AM|PM]
.sp
MMDD[YY] or MM/DD[/YY] or MM.DD[.YY]
MMDD[YY] or MM/DD[/YY] or MM.DD[.YY]
.sp
MM/DD[/YY]\-HH:MM[:SS]
MM/DD[/YY]\-HH:MM[:SS]
.sp
YYYY\-MM\-DD[THH:MM[:SS]]
YYYY\-MM\-DD[THH:MM[:SS]]
.RE
.TP
.TP
CLUSTER
CLUSTER
.RS
.TP
.TP
.B Accounts=<OPT>
.B Accounts=<OPT>
When used with the UserUtilizationByAccount, or
When used with the UserUtilizationByAccount, or
...
@@ -263,11 +271,10 @@ include in report. Default is all.
...
@@ -263,11 +271,10 @@ include in report. Default is all.
.B Wckeys=<OPT>
.B Wckeys=<OPT>
When used with the UserUtilizationByWckey or WCKeyUtilizationByUser,
When used with the UserUtilizationByWckey or WCKeyUtilizationByUser,
List of wckeys to include in report. Default is all.
List of wckeys to include in report. Default is all.
.RE
.TP
.TP
JOB
JOB
.RS
.TP
.TP
.B Accounts=<OPT>
.B Accounts=<OPT>
List of accounts to use for the report Default is all. The SizesByAccount
List of accounts to use for the report Default is all. The SizesByAccount
...
@@ -310,7 +317,6 @@ List of users jobs to include in report. Default is all.
...
@@ -310,7 +317,6 @@ List of users jobs to include in report. Default is all.
List of wckeys to use for the report. Default is all. The
List of wckeys to use for the report. Default is all. The
SizesbyWckey report all users summed together. If you want only
SizesbyWckey report all users summed together. If you want only
certain users specify them them with the Users= option.
certain users specify them them with the Users= option.
.RE
.TP
.TP
RESERVATION
RESERVATION
...
@@ -320,11 +326,11 @@ List of reservations to use for the report. Default is all.
...
@@ -320,11 +326,11 @@ List of reservations to use for the report. Default is all.
.TP
.TP
.B Nodes=<OPT>
.B Nodes=<OPT>
Only show reservations that used these nodes. Default is all.
Only show reservations that used these nodes. Default is all.
.RE
.TP
.TP
USER
USER
.RS
.TP
.TP
.B Accounts=<OPT>
.B Accounts=<OPT>
List of accounts to use for the report. Default is all.
List of accounts to use for the report. Default is all.
...
@@ -339,42 +345,59 @@ Default is 10.
...
@@ -339,42 +345,59 @@ Default is 10.
.TP
.TP
.B Users=<OPT>
.B Users=<OPT>
List of users jobs to include in report. Default is all.
List of users jobs to include in report. Default is all.
.RE
.TP
.SH "Format Options for Each Report"
.SH "Format Options for Each Report"
\fBCluster\fP
\fBCluster\fP
AccountUtilizationByUser
.in 10
UserUtilizationByAccount
AccountUtilizationByUser:
\- Accounts, Cluster, CPUCount, Login, Proper, Used
.br
UserUtilizationByWckey
UserUtilizationByAccount:
WCKeyUtilizationByUser
.in 14
\- Cluster, CPUCount, Login, Proper, Used, Wckey
Accounts, Cluster, CPUCount, Login, Proper, Used
Utilization
\- Allocated, Cluster, CPUCount, Down, Idle, Overcommited,
.in 10
PlannedDown, Reported, Reserved
UserUtilizationByWckey:
.br
WCKeyUtilizationByUser:
.in 14
Cluster, CPUCount, Login, Proper, Used, Wckey
.in 10
Utilization:
.in 14
Allocated, Cluster, CPUCount, Down, Idle, Overcommited, PlannedDown, Reported, Reserved
.TP
\fBJob\fP
\fBJob\fP
SizesByAccount
.in 10
\- Account, Cluster
SizesByAccount:
SizesByWckey
.in 14
\- Wckey, Cluster
Account, Cluster
.in 10
SizesByWckey:
.in 14
Wckey, Cluster
.TP
\fBReservation\fP
\fBReservation\fP
Utilization
.in 10
\- Allocated, Associations, Cluster, CPUCount, CPUTime,
Utilization:
End, Idle, Name, Nodes, Start, TotalTime
.in 14
Allocated, Associations, Cluster, CPUCount, CPUTime, End, Idle, Name, Nodes, Start, TotalTime
.TP
\fBUser\fP
\fBUser\fP
TopUsage
.in 10
\- Account, Cluster, Login, Proper, Used
TopUsage:
.in 14
Account, Cluster, Login, Proper, Used
.TP
.TP
All commands and options are case-insensitive.
All commands and options are case-insensitive.
.TP
.in 0
.SH "EXAMPLES"
.SH "EXAMPLES"
.TP
.TP
\fBsreport job sizesbyaccount\fP
\fBsreport job sizesbyaccount\fP
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment