Rechercher une page de manuel
sreport
Langue: en
Version: 263965 (debian - 07/07/09)
Section: 1 (Commandes utilisateur)
Sommaire
NAME
sreport - Used to generate reports from the slurm accounting data.SYNOPSIS
sreport [OPTIONS...] [COMMAND...]DESCRIPTION
sreport is used to generate certain reports. More can be added at any time. It provides a view into accounting data gathered from slurm via the account information maintained within a database with the interface being provided by the slurmdbd (Slurm Database daemon).OPTIONS
- -a, --all_clusters
- Use all clusters instead of only cluster from where the command was run.
- -h, --help
- Print a help message describing the usage of sreport. This is equivalent to the help command.
- -n, --no_header
- Don't display header when listing results.
- -p, --parsable
- Output will be '|' delimited with a '|' at the end.
- -P, --parsable2
- Output will be '|' delimited without a '|' at the end.
- -q, --quiet
- Print no warning or informational messages, only error messages. This is equivalent to the quiet command.
- -t <format>
- Specify the output time format. Time format options are case insensitive and may be abbreviated. The default format is Minutes. Supported time format options are listed with the time command below.
- -v, --verbose
- Print detailed event logging. This is equivalent to the verbose command.
- -V , --version
- Print version information and exit. This is equivalent to the version command.
COMMANDS
- exit
- Terminate the execution of sreport. Identical to the quit command.
- help
- Display a description of sreport options and commands.
- quiet
- Print no warning or informational messages, only fatal error messages.
- quit
- Terminate the execution of sreport. Identical to the exit command.
- time <time_format>
- Specify the output time format. Time format options are case insensitive and may be abbreviated. The default format is Minutes. Supported time format options include:
-
- SecPer
- Seconds/Percentage of Total
- MinPer
- Minutes/Percentage of Total
- HourPer
- Hours/Percentage of Total
- Seconds
- Seconds
- Minutes
- Minutes
- Hours
- Hours
- Percent
- Percentage of Total
-
- verbose
- Print detailed event logging. This includes time-stamps on data structures, record counts, etc. This is an independent command with no options meant for use in interactive mode.
- version
- Display the version number of sreport being executed.
-q or --quiet: equivalent to - !!
- Repeat the last command executed.
REPORT TYPES
- cluster, job, and user
- Various reports are as follows...
cluster - AccountUtilizationByUser, UserUtilizationByAccount,
UserUtilizationByWckey, Utilization, WCKeyUtilizationByUser
job - SizesByAccount, SizesByWckey
user - TopUsage- REPORT DESCRIPTION
-
-
- cluster AccountUtilizationByUser
- This report will display account utilization as it appears on the hierarchical tree. Starting with the specified account or the root account by default this report will list the underlying usage with a sum on each level. Use the 'tree' option to span the tree for better visibility.
- cluster UserUtilizationByAccount
- This report will display users by account in order of utilization without grouping multiple accounts by user into one, but displaying them on separate lines.
- cluster UserUtilizationByWCKey
- This report will display users by wckey in order of utilization without grouping multiple wckey by user into one, but displaying them on separate lines.
- cluster Utilization
- This report will display total usage divided by Allocated, Down, Idle, and resrved time for selected clusters. Reserved time refers to time that a job was waiting for resources after the job had become eligible. If the value is not of importance for you the number should be grouped with idle time.
- cluster WCKeyUtilizationByUser
- This report will display wckey utilization sorted by WCKey name for each user on each cluster.
- job SizesByAccount
- This report will dispay the amount of time used for job ranges specified by the 'grouping=' option. Only a single level in the tree is displayed defaulting to the root dir. If you specify other accounts with the 'account=' option sreport will use those accounts as the root account and you will receive the sub accounts for the accounts listed.
- job SizesByWckey
- This report will dispay the amount of time for each wckey for job ranges specified by the 'grouping=' option.
- user TopUsage
- Displays the top users on a cluster. Use the group option to group accounts together. The default is to have a different line for each user account combination.
- Each report type has various options...
- COMMON FOR ALL TYPES
-
-
- All_Clusters
- Use all monitored clusters default is local cluster.
- Clusters=<OPT>
- List of clusters to include in report. Default is local cluster.
- End=<OPT>
- Period ending for report. Default is 23:59:59 of previous day. Valid time formats are... HH:MM[:SS] [AM|PM] MMDD[YY] or MM/DD[/YY] or MM.DD[.YY] MM/DD[/YY]-HH:MM[:SS]
- Format=<OPT>
- Comma separated list of fields to display in report.
- Start=<OPT>
- Period start for report. Default is 00:00:00 of previous day. Valid time formats are... HH:MM[:SS] [AM|PM] MMDD[YY] or MM/DD[/YY] or MM.DD[.YY] MM/DD[/YY]-HH:MM[:SS]
-
- CLUSTER
-
-
- Accounts=<OPT>
- When used with the UserUtilizationByAccount, or AccountUtilizationByUser, List of accounts to include in report. Default is all.
- Tree
- When used with the AccountUtilizationByUser report will span the accounts as they in the hierarchy.
- Users=<OPT>
- When used with any report other than Utilization, List of users to include in report. Default is all.
- Wckeys=<OPT>
- When used with the UserUtilizationByWckey or WCKeyUtilizationByUser, List of wckeys to include in report. Default is all.
-
- JOB
-
-
- Accounts=<OPT>
- List of accounts to use for the report Default is all. The SizesByAccount report only displays 1 hierarchical level. If accounts are specified the next layer of accounts under those specified will be displayed, not the accounts specified. In the SizesByAccount reports the default for accounts is root. This explanation does not apply when ran with the FlatView option.
- FlatView
- When used with the SizesbyAccount will not group accounts in a hierarchical level, but print each account where jobs ran on a separate line without any hierarchy.
- GID=<OPT>
- List of group ids to include in report. Default is all.
- Grouping=<OPT>
- Comma separated list of size groupings. (i.e. 50,100,150 would group job cpu count 1-49, 50-99, 100-149, > 150).
- Jobs=<OPT>
- List of jobs/steps to include in report. Default is all.
- Partitions=<OPT>
- List of partitions jobs ran on to include in report. Default is all.
- PrintJobCount
- When used with the Sizes report will print number of jobs ran instead of time used.
- Users=<OPT>
- List of users jobs to include in report. Default is all.
- Wckeys=<OPT>
- List of wckeys to use for the report. Default is all. The SizesbyWckey report all users summed together. If you want only certain users specify them them with the Users= option.
-
- USER
-
-
- Accounts=<OPT>
- List of accounts to use for the report. Default is all.
- Group
- Group all accounts together for each user. Default is a separate entry for each user and account reference.
- TopCount=<OPT>
- Used in the TopUsage report. Change the number of users displayed. Default is 10.
- Users=<OPT>
- List of users jobs to include in report. Default is all.
-
-
Format Options for Each Report
Cluster
AccountUtilizationByUser
UserUtilizationByAccount
- Accounts, Cluster, CPUCount, Login, Proper, Used
UserUtilizationByWckey
WCKeyUtilizationByUser
- Cluster, CPUCount, Login, Proper, Used, Wckey
Utilization
- Allocated, Cluster, CPUCount, Down, Idle, Overcommited,
PlannedDown, Reported, Reserved
Job
SizesByAccount
- Account, Cluster
SizesByWckey
- Wckey, Cluster
User
TopUsage
- Account, Cluster, Login, Proper, Used
EXAMPLES
- sreport job sizesbyaccount
- report cluster utilization
- sreport user top
- sreport job sizesbyaccount All_Clusters users=gore1 account=environ PrintJobCount
- Report number of jobs by user gore1 within the environ account
- sreport cluster AccountUtilizationByUser cluster=zeus user=gore1 start=2/23/08 end=2/24/09 format=Accounts,Cluster,CPU_Count,Login,Proper,Used
- Report cluster account utilization with the specified fields during the specified 24 hour day of February 23, 2009, by user gore1
- sreport cluster AccountUtilizationByUser cluster=zeus accounts=lc start=2/23/08 end=2/24/09
- Report cluster account utilization by user in the LC account on cluster zeus
- sreport user topusage start=2/16/09 end=2/23/09 -t percent account=lc
- Report top usage in percent of the lc account during the specified week
COPYING
Copyright (C) 2008 Lawrence Livermore National Security. Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). LLNL-CODE-402394.This file is part of SLURM, a resource management program. For details, see <https://computing.llnl.gov/linux/slurm/>.
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), slurmdbe(8)Contenus ©2006-2024 Benjamin Poulain
Design ©2006-2024 Maxime Vantorre