← Back to branch summary

~ubuntu-branches/ubuntu/quantal/slurm-llnl/quantal

« back to all changes in this revision

Viewing changes to doc/man/man1/sreport.1

  • Committer: Bazaar Package Importer
  • Author(s): Gennaro Oliva
  • Date: 2011-04-08 11:21:17 UTC
  • mfrom: (3.3.16 sid)
  • Revision ID: james.westby@ubuntu.com-20110408112117-nfnyq9dtm55hqoaw
Tags: 2.2.4-1
http://bugs.debian.org/575822
* New upstream releases 
* Cleaning spare file and directories, not belonging to the sources
  generated by the building process and not removed by distclean.
  Added debian/clean with spare files and rm -rf inside debian/rules
  for directories.
* Added new packages libslurm-perl, libslurmdb-perl, slurm-llnl-torque
  (Closes: #575822) thanks to Julien Blache

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/man1/sreport.1
1
 
.TH SREPORT "1" "February 2009" "sreport 2.0" "Slurm components"
 
1
.TH SREPORT "1" "October 2010" "sreport 2.0" "Slurm components"
2
2
 
3
3
.SH "NAME"
4
4
sreport \- Generate reports from the slurm accounting data.
7
7
\fBsreport\fR [\fIOPTIONS\fR...] [\fICOMMAND\fR...]
8
8
 
9
9
.SH "DESCRIPTION"
10
 
\fBsreport\fR is used to generate certain reports. It provides a view into accounting data gathered from slurm via
11
 
the account information maintained within a database with the interface
12
 
being provided by the \fBslurmdbd\fR (Slurm Database daemon).
 
10
\fBsreport\fR is used to generate reports of job usage and cluster
 
11
utilization for SLURM jobs saved to the SLURM Database,
 
12
\fBslurmdbd\fR.
13
13
 
14
14
.SH "OPTIONS"
15
15
 
33
33
Print no warning or informational messages, only error messages.
34
34
.TP
35
35
\fB\-t <format>\fR
36
 
Specify the output time format.
37
 
Time format options are case insensitive and may be abbreviated.
38
 
The default format is Minutes.
 
36
Specify the output time format. Time format options are case
 
37
insensitive and may be abbreviated. The default format is Minutes.
39
38
Supported time format options are listed in the \fBtime\fP command
40
39
section below.
41
40
.TP
84
83
 
85
84
.TP
86
85
\fBtime <time_format>\fP
87
 
Specify the output time format.
88
 
Time format options are case insensitive and may be abbreviated.
89
 
The default format is Minutes.
 
86
Specify the output time format. Time format options are case
 
87
insensitive and may be abbreviated. The default format is Minutes.
90
88
Supported time format options include:
 
89
 
91
90
.RS
92
91
.TP 10
93
92
\fBSecPer\fR
132
131
\fBjob\fP \<REPORT\> \<OPTIONS\>
133
132
 
134
133
\fBuser\fP \<REPORT\> \<OPTIONS\>
135
 
.RE
136
134
 
137
135
.TP
138
136
\<REPORT\> options for each type include:
139
 
\fBcluster\fP     \- AccountUtilizationByUser, UserUtilizationByAccount,
 
137
 
 
138
.B cluster
 
139
\- AccountUtilizationByUser, UserUtilizationByAccount,
140
140
UserUtilizationByWckey, Utilization, WCKeyUtilizationByUser
141
141
 
142
 
\fBjob\fP         \- SizesByAccount, SizesByWckey
143
 
 
144
 
\fBreservation\fP \- Utilization
145
 
 
146
 
\fBuser\fP      \- TopUsage
147
 
 
148
 
.TP
149
 
 
150
 
 
151
 
.TP
152
 
REPORT DESCRIPTION
153
 
.RS
 
142
.B job
 
143
\- SizesByAccount, SizesByAccountAndWcKey, SizesByWckey
 
144
 
 
145
.B reservation
 
146
\- Utilization
 
147
 
 
148
.B user
 
149
\- TopUsage
 
150
 
 
151
.SH "REPORT DESCRIPTION"
 
152
 
154
153
.TP
155
154
.B cluster AccountUtilizationByUser
156
155
This report will display account utilization as it appears on the
189
188
the root account and you will receive the sub accounts for the
190
189
accounts listed.
191
190
.TP
 
191
.B job SizesByAccountAndWckey
 
192
This report is very similar to SizesByAccount with the difference being
 
193
each account is pair with wckeys so the identifier is account:wckey
 
194
instead of just account so there will most likely be multiple accounts
 
195
listed depending on the number of wckeys used.
 
196
.TP
192
197
.B job SizesByWckey
193
198
This report will dispay the amount of time for each wckey for job ranges
194
199
specified by the 'grouping=' option.
207
212
Each report type has various options...
208
213
 
209
214
.TP
210
 
COMMON FOR ALL TYPES
211
 
.RS
 
215
.B OPTIONS FOR ALL REPORT TYPES
 
216
 
212
217
.TP
213
218
.B All_Clusters
214
219
Use all monitored clusters. Default is local cluster.
215
220
.TP
216
221
.B Clusters=<OPT>
217
222
List of clusters to include in report.  Default is local cluster.
 
223
 
218
224
.TP
219
225
.B End=<OPT>
220
226
Period ending for report. Default is 23:59:59 of previous day.
221
227
Valid time formats are...
 
228
.sp
222
229
HH:MM[:SS] [AM|PM]
 
230
.br
223
231
MMDD[YY] or MM/DD[/YY] or MM.DD[.YY]
 
232
.br
224
233
MM/DD[/YY]\-HH:MM[:SS]
225
 
.na
 
234
.br
226
235
YYYY\-MM\-DD[THH:MM[:SS]]
227
 
.ad
 
236
 
228
237
.TP
229
238
.B Format=<OPT>
230
239
Comma separated list of fields to display in report.
232
241
When using the format option for listing various fields you can put a
233
242
%NUMBER afterwards to specify how many characters should be printed.
234
243
 
235
 
i.e. format=name%30 will print 30 characters of field name right
 
244
e.g. format=name%30 will print 30 characters of field name right
236
245
justified.  A \-30 will print 30 characters left justified.
237
246
 
238
247
.TP
239
248
.B Start=<OPT>
240
249
Period start for report.  Default is 00:00:00 of previous day.
241
250
Valid time formats are...
 
251
.sp
242
252
HH:MM[:SS] [AM|PM]
 
253
.br
243
254
MMDD[YY] or MM/DD[/YY] or MM.DD[.YY]
244
 
.na
245
 
MM/DD[/YY]\-HH:MM[:SS] YYYY\-MM\-DD[THH:MM[:SS]]
 
255
.br
 
256
MM/DD[/YY]\-HH:MM[:SS]
 
257
.br
 
258
YYYY\-MM\-DD[THH:MM[:SS]]
246
259
.ad
247
 
.RE
 
260
.TP
 
261
.B OPTIONS SPECIFICALLY FOR CLUSTER REPORTS
248
262
 
249
263
.TP
250
 
CLUSTER
251
 
.RS
252
 
.TP
253
264
.B Accounts=<OPT>
254
265
When used with the UserUtilizationByAccount, or
255
266
AccountUtilizationByUser, List of accounts to include in report.
266
277
.B Wckeys=<OPT>
267
278
When used with the UserUtilizationByWckey or WCKeyUtilizationByUser,
268
279
List of wckeys to include in report. Default is all.
269
 
.RE
270
280
 
271
281
.TP
272
 
JOB
273
 
.RS
 
282
.B OPTIONS SPECIFICALLY FOR JOB REPORTS
 
283
 
274
284
.TP
275
285
.B Accounts=<OPT>
276
 
List of accounts to use for the report Default is all.  The SizesByAccount
 
286
List of accounts to use for the report Default is all.  The SizesByAccount(*)
277
287
report only displays 1 hierarchical level. If accounts are specified
278
288
the next layer of accounts under those specified will be displayed,
279
 
not the accounts specified.  In the SizesByAccount reports the default
 
289
not the accounts specified.  In the SizesByAccount(*) reports the default
280
290
for accounts is root.  This explanation does not apply when ran with
281
291
the FlatView option.
282
292
.TP
283
293
.B FlatView
284
 
When used with the SizesbyAccount will not group accounts in a
 
294
When used with the SizesbyAccount(*) will not group accounts in a
285
295
hierarchical level, but print each account where jobs ran on a
286
296
separate line without any hierarchy.
287
297
.TP
289
299
List of group ids to include in report.  Default is all.
290
300
.TP
291
301
.B Grouping=<OPT>
292
 
Comma separated list of size groupings.   (i.e. 50,100,150 would group job cpu count 1-49, 50-99, 100-149, > 150).
 
302
Comma separated list of size groupings.   (e.g. 50,100,150 would group
 
303
job cpu count 1-49, 50-99, 100-149, > 150).  grouping=individual will
 
304
result in a single column for each job size found.
293
305
.TP
294
306
.B Jobs=<OPT>
295
307
List of jobs/steps to include in report.  Default is all.
311
323
List of wckeys to use for the report.  Default is all.  The
312
324
SizesbyWckey report all users summed together.  If you want only
313
325
certain users specify them them with the Users= option.
314
 
.RE
315
326
 
316
327
.TP
317
 
RESERVATION
 
328
.B OPTIONS SPECIFICALLY FOR RESERVATION REPORTS
318
329
.TP
319
330
.B Names=<OPT>
320
331
List of reservations to use for the report. Default is all.
321
332
.TP
322
333
.B Nodes=<OPT>
323
334
Only show reservations that used these nodes. Default is all.
324
 
.RE
 
335
 
325
336
 
326
337
.TP
327
 
USER
328
 
.RS
 
338
.B OPTIONS SPECIFICALLY FOR USER REPORTS
 
339
 
329
340
.TP
330
341
.B Accounts=<OPT>
331
342
List of accounts to use for the report. Default is all.
340
351
.TP
341
352
.B Users=<OPT>
342
353
List of users jobs to include in report.  Default is all.
343
 
.RE
344
 
 
345
 
.TP
346
 
 
347
 
.SH "Format Options for Each Report"
348
 
 
349
 
\fBCluster\fP
350
 
       AccountUtilizationByUser
351
 
       UserUtilizationByAccount
352
 
             \- Accounts, Cluster, CPUCount, Login, Proper, Used
353
 
       UserUtilizationByWckey
354
 
       WCKeyUtilizationByUser
355
 
             \- Cluster, CPUCount, Login, Proper, Used, Wckey
356
 
       Utilization
357
 
             \- Allocated, Cluster, CPUCount, Down, Idle, Overcommited,
358
 
               PlannedDown, Reported, Reserved
359
 
 
360
 
\fBJob\fP
361
 
       SizesByAccount
362
 
             \- Account, Cluster
363
 
       SizesByWckey
364
 
             \- Wckey, Cluster
365
 
 
366
 
\fBReservation\fP
367
 
       Utilization
368
 
             \- Allocated, Associations, Cluster, CPUCount, CPUTime,
369
 
                End, Idle, Name, Nodes, Start, TotalTime
370
 
 
371
 
\fBUser\fP
372
 
       TopUsage
373
 
             \- Account, Cluster, Login, Proper, Used
 
354
 
 
355
.SH "FORMAT OPTIONS FOR EACH REPORT"
 
356
 
 
357
\fBFORMAT OPTIONS FOR CLUSTER REPORTS\fP
 
358
.in 10
 
359
AccountUtilizationByUser:
 
360
.br
 
361
UserUtilizationByAccount:
 
362
.in 14
 
363
Accounts, Cluster, CPUCount, Login, Proper, Used
 
364
 
 
365
.in 10
 
366
UserUtilizationByWckey:
 
367
.br
 
368
WCKeyUtilizationByUser:
 
369
.in 14
 
370
Cluster, CPUCount, Login, Proper, Used, Wckey
 
371
 
 
372
.in 10
 
373
Utilization:
 
374
.in 14
 
375
Allocated, Cluster, CPUCount, Down, Idle, Overcommited, PlannedDown, Reported, Reserved
 
376
 
 
377
.TP
 
378
\fBFORMAT OPTIONS FOR JOB REPORTS\fP
 
379
.in 10
 
380
SizesByAccount, SizesByAccountAndWckey:
 
381
.in 14
 
382
Account, Cluster
 
383
 
 
384
.in 10
 
385
SizesByWckey:
 
386
.in 14
 
387
Wckey, Cluster
 
388
 
 
389
.TP
 
390
\fBFORMAT OPTIONS FOR RESERVATION REPORTS\fP
 
391
.in 10
 
392
Utilization:
 
393
.in 14
 
394
Allocated, Associations, Cluster, CPUCount, CPUTime, End, Idle, Name, Nodes, Start, TotalTime
 
395
 
 
396
.TP
 
397
\fBFORMAT OPTIONS FOR USER REPORTS\fP
 
398
.in 10
 
399
TopUsage:
 
400
.in 14
 
401
Account, Cluster, Login, Proper, Used
374
402
 
375
403
.TP
376
404
All commands and options are case-insensitive.
377
 
.TP
378
405
 
 
406
.in 0
379
407
.SH "EXAMPLES"
380
408
.TP
381
409
\fBsreport job sizesbyaccount\fP
397
425
.TP
398
426
\fBsreport user topusage start=2/16/09 end=2/23/09 \-t percent account=lc\fP
399
427
Report top usage in percent of the lc account during the specified week
400
 
.TP
401
428
 
402
429
.SH "COPYING"
403
 
Copyright (C) 2009 Lawrence Livermore National Security.
 
430
Copyright (C) 2009\-2010 Lawrence Livermore National Security.
404
431
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
405
432
CODE\-OCEC\-09\-009. All rights reserved.
406
433
.LP