1sreport(1) Slurm Commands sreport(1)
2
6 sreport - Generate reports from the slurm accounting data.
7
10 sreport [OPTIONS...] [COMMAND...]
11
14 sreport is used to generate reports of job usage and cluster utiliza‐
15 tion for Slurm jobs saved to the Slurm Database, slurmdbd.
16
19 -a, --all_clusters
20 Use all clusters instead of only the cluster from which the com‐
21 mand was executed.
22 --federation
24 Generate a report for the federation if a member of one.
25 -h, --help
27 Print a help message describing the usage of sreport.
28 --local
30 Generate a report for the local cluster, even if part of a fed‐
31 eration. Overrides --federation
32 -M, --cluster
34 The cluster(s) to generate reports for. Default is local clus‐
35 ter, unless the local cluster is currently part of a federation
36 and in that case generate a report for all clusters in the cur‐
37 rent federation. If the clusters included in a federation vary
38 through time, use this option to identify the clusters to be
39 included in report. Implies --local.
40 -n, --noheader
42 Don't display header when listing results.
43 -p, --parsable
45 Output will be '|' delimited with a '|' at the end.
46 -P, --parsable2
48 Output will be '|' delimited without a '|' at the end.
49 -Q, --quiet
51 Print no warning or informational messages, only error messages.
52 -t <format>
54 Specify the output time format. Time format options are case
55 insensitive and may be abbreviated. The default format is Min‐
56 utes. Supported time format options are listed in the time com‐
57 mand section below.
58 -T, --tres <tres_names>
60 Trackable resource (TRES) to report values for. By default CPU
61 resource use is reported (except for reservation reports. All
62 TRES types reserved by a reservation will be shown by default
63 unless overridden with this option). Multiple TRES names may be
64 separated using a comma separated list for all reports except
65 the job reports, which can only support a single TRES name, or
66 "ALL" for all TRES.
67 The "Reported" Billing TRES is calculated from the largest
69 Billing TRES of each node multiplied by the time frame. For
70 example, if a node is part of multiple partitions and each has a
71 different TRESBillingWeights defined the Billing TRES for the
72 node will be the highest of the partitions. If TRESBilling‐
73 Weights is not defined on any partition for a node then the
74 Billing TRES will be equal to the number of CPUs on the node.
75 TRES node usage is no longer reported in percent format or in
77 Cluster Utilization. Please use TRES CPU instead. The main
78 issue with using node is in most configurations multiple jobs
79 are able to run on the same node. This makes TRES node account‐
80 ing count the same node multiple times in the same period. In
81 exclusive node configurations, CPU accounting returns the same
82 usage node accounting would.
83 -v, --verbose
86 Print detailed event logging.
87 -V , --version
89 Print version information and exit.
90
93 <keyword> may be omitted from the execute line and sreport will
94 execute in interactive mode. sreport will process commands as
95 entered until explicitly terminated.
96 exit Terminate the execution of sreport. Identical to the quit com‐
99 mand.
100 help Display a description of sreport options and commands.
103 nonparsable
106 Return output to normal after parsable or parsable2 has been
107 set.
108 parsable
111 Output will be | delimited with an ending '|'.
112 parsable2
115 Output will be | delimited without an ending '|'.
116 quiet Print no warning or informational messages, only fatal error
119 messages.
120 quit Terminate the execution of sreport. Identical to the exit com‐
123 mand.
124 time <time_format>
127 Specify the output time format. Time format options are case
128 insensitive and may be abbreviated. The default format is Min‐
129 utes. Supported time format options include:
130 SecPer Seconds/Percentage of Total
133 MinPer Minutes/Percentage of Total
135 HourPer Hours/Percentage of Total
137 Seconds Seconds
139 Minutes Minutes
141 Hours Hours
143 Percent Percentage of Total
145 verbose
148 Enable detailed event logging.
149 version
152 Display the sreport version number.
153 !! Repeat the last command executed.
156
159 Valid report types are:
160 cluster <REPORT> <OPTIONS>
161 job <REPORT> <OPTIONS>
163 reservation <REPORT> <OPTIONS>
165 user <REPORT> <OPTIONS>
167 <REPORT> options for each type include:
170 cluster - AccountUtilizationByUser, UserUtilizationByAccount,
172 UserUtilizationByWckey, Utilization, WCKeyUtilizationByUser
173 job - SizesByAccount, SizesByAccountAndWcKey, SizesByWckey
175 reservation - Utilization
177 user - TopUsage
179
182 cluster AccountUtilizationByUser
183 This report will display account utilization as it appears on
184 the hierarchical tree. Starting with the specified account or
185 the root account by default this report will list the underlying
186 usage with a sum on each level. Use the 'tree' option to span
187 the tree for better visibility. NOTE: If there were reserva‐
188 tions allowing a whole account any idle time in the reservation
189 given to the association for the account, not the user associa‐
190 tions in the account, so it can be possible a parent account can
191 be larger than the sum of it's children.
192 cluster UserUtilizationByAccount
194 This report will display users by account in order of utiliza‐
195 tion without grouping multiple accounts by user into one, but
196 displaying them on separate lines.
197 cluster UserUtilizationByWCKey
199 This report will display users by wckey in order of utilization
200 without grouping multiple wckey by user into one, but displaying
201 them on separate lines.
202 cluster Utilization
204 This report will display total usage divided by Allocated, Down,
205 Idle, and Reserved time for selected clusters. Reserved time
206 refers to time that a job was waiting for resources after the
207 job had become eligible. If the value is not of importance for
208 you the number should be grouped with idle time.
209 cluster WCKeyUtilizationByUser
211 This report will display wckey utilization sorted by WCKey name
212 for each user on each cluster.
213 job SizesByAccount
216 This report will display the amount of time used for job ranges
217 specified by the 'grouping=' option. Only a single level in the
218 tree is displayed defaulting to the root dir. If you specify
219 other accounts with the 'account=' option sreport will use those
220 accounts as the root account and you will receive the sub
221 accounts for the accounts listed.
222 job SizesByAccountAndWckey
224 This report is very similar to SizesByAccount with the differ‐
225 ence being each account is pair with wckeys so the identifier is
226 account:wckey instead of just account so there will most likely
227 be multiple accounts listed depending on the number of wckeys
228 used.
229 job SizesByWckey
231 This report will display the amount of time for each wckey for
232 job ranges specified by the 'grouping=' option.
233 reservation Utilization
236 This report will display total usage for reservations on the
237 systems.
238 user TopUsage
241 Displays the top users on a cluster. Use the group option to
242 group accounts together. The default is to have a different
243 line for each user account combination.
244 Each report type has various options...
247 OPTIONS FOR ALL REPORT TYPES
250 All_Clusters
253 Use all monitored clusters. Default is local cluster.
254 Clusters=<OPT>
256 List of clusters to include in report. Default is local clus‐
257 ter.
258 End=<OPT>
261 Period ending for report. Default is 23:59:59 of previous day.
262 Valid time formats are...
263 HH:MM[:SS] [AM|PM]
265 MMDD[YY] or MM/DD[/YY] or MM.DD[.YY]
266 MM/DD[/YY]-HH:MM[:SS]
267 YYYY-MM-DD[THH:MM[:SS]]
268 Format=<OPT>
271 Comma separated list of fields to display in report.
272 When using the format option for listing various fields you can
274 put a %NUMBER afterwards to specify how many characters should
275 be printed.
276 e.g. format=name%30 will print 30 characters of field name right
278 justified. A -30 will print 30 characters left justified.
279 Start=<OPT>
282 Period start for report. Default is 00:00:00 of previous day.
283 Valid time formats are...
284 HH:MM[:SS] [AM|PM]
286 MMDD[YY] or MM/DD[/YY] or MM.DD[.YY]
287 MM/DD[/YY]-HH:MM[:SS]
288 YYYY-MM-DD[THH:MM[:SS]]
289 OPTIONS SPECIFICALLY FOR CLUSTER REPORTS
291 Accounts=<OPT>
294 When used with the UserUtilizationByAccount, or AccountUtiliza‐
295 tionByUser, List of accounts to include in report. Default is
296 all.
297 Tree When used with the AccountUtilizationByUser report will span the
299 accounts as they are in the hierarchy.
300 Users=<OPT>
302 When used with any report other than Utilization, List of users
303 to include in report. Default is all.
304 Wckeys=<OPT>
306 When used with the UserUtilizationByWckey or WCKeyUtilization‐
307 ByUser, List of wckeys to include in report. Default is all.
308 OPTIONS SPECIFICALLY FOR JOB REPORTS
311 Accounts=<OPT>
314 List of accounts to use for the report Default is all. The
315 SizesByAccount(*) report only displays 1 hierarchical level. If
316 accounts are specified the next layer of accounts under those
317 specified will be displayed, not the accounts specified. In the
318 SizesByAccount(*) reports the default for accounts is root.
319 This explanation does not apply when ran with the FlatView
320 option.
321 FlatView
323 When used with the SizesbyAccount(*) will not group accounts in
324 a hierarchical level, but print each account where jobs ran on a
325 separate line without any hierarchy.
326 GID=<OPT>
328 List of group ids to include in report. Default is all.
329 Grouping=<OPT>
331 Comma separated list of size groupings. (e.g. 50,100,150 would
332 group job cpu count 1-49, 50-99, 100-149, > 150). group‐
333 ing=individual will result in a single column for each job size
334 found.
335 Jobs=<OPT>
337 List of jobs/steps to include in report. Default is all.
338 Nodes=<OPT>
340 Only show jobs that ran on these nodes. Default is all.
341 Partitions=<OPT>
343 List of partitions jobs ran on to include in report. Default is
344 all.
345 PrintJobCount
347 When used with the Sizes report will print number of jobs ran
348 instead of time used.
349 Users=<OPT>
351 List of users jobs to include in report. Default is all.
352 Wckeys=<OPT>
354 List of wckeys to use for the report. Default is all. The
355 SizesbyWckey report all users summed together. If you want only
356 certain users specify them them with the Users= option.
357 OPTIONS SPECIFICALLY FOR RESERVATION REPORTS
360 Names=<OPT>
362 List of reservations to use for the report. Default is all.
363 Nodes=<OPT>
365 Only show reservations that used these nodes. Default is all.
366 OPTIONS SPECIFICALLY FOR USER REPORTS
370 Accounts=<OPT>
373 List of accounts to use for the report. Default is all.
374 Group Group all accounts together for each user. Default is a sepa‐
376 rate entry for each user and account reference.
377 TopCount=<OPT>
379 Used in the TopUsage report. Change the number of users dis‐
380 played. Default is 10.
381 Users=<OPT>
383 List of users jobs to include in report. Default is all.
384
387 FORMAT OPTIONS FOR CLUSTER REPORTS
388 AccountUtilizationByUser:
389 UserUtilizationByAccount:
390 Accounts, Cluster, Login, Proper, TresCount, Used
391 UserUtilizationByWckey:
393 WCKeyUtilizationByUser:
394 Cluster, Login, Proper, TresCount, Used, Wckey
395 Utilization:
397 Allocated, Cluster, Down, Idle, Overcommited, PlannedDown,
398 Reported, Reserved, TresCount, TresName
399 FORMAT OPTIONS FOR JOB REPORTS
402 SizesByAccount, SizesByAccountAndWckey:
403 Account, Cluster
404 SizesByWckey:
406 Wckey, Cluster
407 FORMAT OPTIONS FOR RESERVATION REPORTS
410 Utilization:
411 Allocated, Associations, Cluster, End, Flags, Idle, Name, Nodes,
412 ReservationId, Start, TotalTime, TresCount, TresName, TresTime
413 FORMAT OPTIONS FOR USER REPORTS
416 TopUsage:
417 Account, Cluster, Login, Proper, Used
418 All commands and options are case-insensitive.
421
424 Some sreport options may be set via environment variables. These envi‐
425 ronment variables, along with their corresponding options, are listed
426 below. (Note: commandline options will always override these settings)
427 SREPORT_CLUSTER Same as -M, --cluster
429 SREPORT_FEDERATION Same as --federation
431 SREPORT_LOCAL Same as --local
433 SREPORT_TRES Same as -t, --tres
435 SLURM_CONF The location of the Slurm configuration file.
437
440 sreport job sizesbyaccount
441 sreport cluster utilization
443 sreport user top
445 sreport job sizesbyaccount All_Clusters users=gore1 account=environ
447 PrintJobCount
448 Report number of jobs by user gore1 within the environ account
449 sreport cluster AccountUtilizationByUser cluster=zeus user=gore1
451 start=2/23/08 end=2/24/09 format=Accounts,Clus‐
452 ter,TresCount,Login,Proper,Used
453 Report cluster account utilization with the specified fields
454 during the specified 24 hour day of February 23, 2009, by user
455 gore1
456 sreport cluster AccountUtilizationByUser cluster=zeus accounts=lc
458 start=2/23/08 end=2/24/09
459 Report cluster account utilization by user in the LC account on
460 cluster zeus
461 sreport user topusage start=2/16/09 end=2/23/09 -t percent account=lc
463 Report top usage in percent of the lc account during the speci‐
464 fied week
465
468 Copyright (C) 2009-2010 Lawrence Livermore National Security. Produced
469 at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
470 Copyright (C) 2010-2015 SchedMD LLC.
471 This file is part of Slurm, a resource management program. For
473 details, see <https://slurm.schedmd.com/>.
474 Slurm is free software; you can redistribute it and/or modify it under
476 the terms of the GNU General Public License as published by the Free
477 Software Foundation; either version 2 of the License, or (at your
478 option) any later version.
479 Slurm is distributed in the hope that it will be useful, but WITHOUT
481 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
482 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
483 for more details.
484
487 sacct(1), slurmdbd(8)
488April 2017 Slurm Commands sreport(1)