From d2ee5a9fac7357372ce4178968f04f5091871a94 Mon Sep 17 00:00:00 2001 From: Sebastien GODARD Date: Tue, 28 Jul 2020 18:01:43 +0200 Subject: [PATCH] Update style for manual pages Signed-off-by: Sebastien GODARD --- man/cifsiostat.in | 177 ++-- man/iostat.in | 488 ++++------ man/mpstat.1 | 299 +++--- man/pidstat.1 | 585 ++++-------- man/sa1.in | 79 +- man/sa2.in | 68 +- man/sadc.in | 259 +++--- man/sadf.in | 444 ++++----- man/sar.in | 2278 ++++++++++++++------------------------------- man/sysstat.in | 137 ++- man/tapestat.1 | 208 ++--- 11 files changed, 1701 insertions(+), 3321 deletions(-) diff --git a/man/cifsiostat.in b/man/cifsiostat.in index e5fecff..7160b92 100644 --- a/man/cifsiostat.in +++ b/man/cifsiostat.in @@ -1,199 +1,154 @@ +.\" cifsiostat manual page - (C) 2020 Sebastien Godard (sysstat orange.fr) .TH CIFSIOSTAT 1 "JULY 2020" Linux "Linux User's Manual" -*- nroff -*- .SH NAME cifsiostat \- Report CIFS statistics. + .SH SYNOPSIS .ie 'yes'@WITH_DEBUG@' \{ .B cifsiostat [ -h ] [ -k | -m ] [ -t ] [ -V ] [ --debuginfo ] [ --dec={ 0 | 1 | 2 } ] [ --human ] [ --pretty ] [ -.I interval -.B [ -.I count -.B ] ] +.IB "interval " "[ " "count " "] ]" .\} .el \{ .B cifsiostat [ -h ] [ -k | -m ] [ -t ] [ -V ] [ --dec={ 0 | 1 | 2 } ] [ --human ] [ --pretty ] [ -.I interval -.B [ -.I count -.B ] ] +.IB "interval " "[ " "count " "] ]" .\} + .SH DESCRIPTION The .B cifsiostat command displays statistics about read and write operations on CIFS filesystems. - -The -.I interval +.PP +.RI "The " "interval" parameter specifies the amount of time in seconds between each report. The first report contains statistics for the time since system startup (boot). Each subsequent report contains statistics collected during the interval since the previous report. A report consists of a CIFS header row followed by a line of statistics for each CIFS filesystem that is mounted. -The -.I count -parameter can be specified in conjunction with the -.I interval -parameter. If the -.I count -parameter is specified, the value of -.I count -determines the number of reports generated at -.I interval -seconds apart. If the -.I interval -parameter is specified without the -.I count -parameter, the -.B cifsiostat -command generates reports continuously. +.RI "The " "count " "parameter can be specified in conjunction with the " "interval " +.RI "parameter. If the " "count " "parameter is specified, the value of " "count " +.RI "determines the number of reports generated at " "interval " "seconds apart. If the " "interval " +.RI "parameter is specified without the " "count " "parameter, the " +.BR "cifsiostat " "command generates reports continuously." .SH REPORT The CIFS report provides statistics for each mounted CIFS filesystem. The report shows the following fields: -.B Filesystem: -.RS +.IP Filesystem: This columns shows the mount point of the CIFS filesystem. - -.RE -.B rB/s (rkB/s, rMB/s) -.RS +.IP rB/s (rkB/s, rMB/s) Indicate the average number of bytes (kilobytes, megabytes) read per second. - -.RE -.B wB/s (wkB/s, wMB/s) -.RS +.IP wB/s (wkB/s, wMB/s) Indicate the average number of bytes (kilobytes, megabytes) written per second. - -.RE -.B rop/s -.RS +.IP rop/s Indicate the number of 'read' operations that were issued to the filesystem per second. - -.RE -.B wop/s -.RS +.IP wop/s Indicate the number of 'write' operations that were issued to the filesystem per second. - -.RE -.B fo/s -.RS +.IP fo/s Indicate the number of open files per second. - -.RE -.B fc/s -.RS +.IP fc/s Indicate the number of closed files per second. - -.RE -.B fd/s -.RS +.IP fd/s Indicate the number of deleted files per second. -.RE -.RE + .SH OPTIONS .if 'yes'@WITH_DEBUG@' \{ -.IP --debuginfo +.TP +.B --debuginfo Print debug output to stderr. .\} -.IP "--dec={ 0 | 1 | 2 }" +.TP +.B --dec={ 0 | 1 | 2 } Specify the number of decimal places to use (0 to 2, default value is 2). -.IP -h +.TP +.B -h This option is equivalent to specifying -.BR "--human --pretty" . -.IP --human +.BR "--human --pretty" "." +.TP +.B --human Print sizes in human readable format (e.g. 1.0k, 1.2M, etc.) The units displayed with this option supersede any other default units (e.g. kilobytes, sectors...) associated with the metrics. -.IP -k +.TP +.B -k Display statistics in kilobytes per second. -.IP -m +.TP +.B -m Display statistics in megabytes per second. -.IP --pretty +.TP +.B --pretty Make the CIFS report easier to read by a human. -.IP -t +.TP +.B -t Print the time for each report displayed. The timestamp format may depend -on the value of the S_TIME_FORMAT environment variable (see below). -.IP -V +on the value of the +.BR "S_TIME_FORMAT " "environment variable (see below)." +.TP +.B -V Print version number then exit. .SH ENVIRONMENT -The -.B cifsiostat -command takes into account the following environment variables: - -.IP S_COLORS +.RB "The " "cifsiostat " "command takes into account the following environment variables: " +.TP +.B S_COLORS By default statistics are displayed in color when the output is connected to a terminal. Use this variable to change the settings. Possible values for this variable are -.IR never , -.IR always -or -.IR auto -(the latter is equivalent to the default settings). - +.BR "never" ", " "always " "or " "auto " "(the latter is equivalent to the default settings)." +.br Please note that the color (being red, yellow, or some other color) used to display a value is not indicative of any kind of issue simply because of the color. It only indicates different ranges of values. - -.IP S_COLORS_SGR +.TP +.B S_COLORS_SGR Specify the colors and other attributes used to display statistics on the terminal. Its value is a colon-separated list of capabilities that defaults to -.BR I=32;22:N=34;1:Z=34;22 . +.BR "I=32;22:N=34;1:Z=34;22" "." Supported capabilities are: - .RS .TP .B I= SGR substring for filesystem names. - .TP .B N= SGR substring for non-zero statistics values. - .TP .B Z= SGR substring for zero values. .RE - -.IP S_TIME_FORMAT +.TP +.B S_TIME_FORMAT If this variable exists and its value is -.BR ISO +.B ISO then the current locale will be ignored when printing the date in the report header. The .B cifsiostat command will use the ISO 8601 format (YYYY-MM-DD) instead. -The timestamp displayed with option -t will also be compliant with ISO 8601 -format. +.RB "The timestamp displayed with option " "-t " "will also be compliant with ISO 8601 format." .SH BUG -.I /proc -filesystem must be mounted for -.B cifsiostat -to work. - -Although -.B cifsiostat +.IR "/proc " "filesystem must be mounted for" +.BR "cifsiostat " "to work." +.PP +.RB "Although " "cifsiostat" speaks of kilobytes (kB), megabytes (MB)..., it actually uses kibibytes (kiB), mebibytes (MiB)... A kibibyte is equal to 1024 bytes, and a mebibyte is equal to 1024 kibibytes. + .SH FILE -.I /proc/fs/cifs/Stats -contains CIFS statistics. +.IR "/proc/fs/cifs/Stats " "contains CIFS statistics." + .SH AUTHORS Written by Ivana Varekova (varekova redhat.com) - +.br Maintained by Sebastien Godard (sysstat orange.fr) + .SH SEE ALSO -.BR sar (1), -.BR pidstat (1), -.BR mpstat (1), -.BR vmstat (8), -.BR iostat (1), -.BR tapestat (1), -.BR nfsiostat (1) +.BR "sar" "(1), " "pidstat" "(1), " "mpstat" "(1), " "vmstat" "(8), " "iostat" "(1)," +.BR "tapestat" "(1), " "nfsiostat" "(1)" .I https://github.com/sysstat/sysstat - +.br .I http://pagesperso-orange.fr/sebastien.godard/ diff --git a/man/iostat.in b/man/iostat.in index b55b2fe..8b474f1 100644 --- a/man/iostat.in +++ b/man/iostat.in @@ -1,41 +1,25 @@ +.\" iostat manual page - (C) 1998-2020 Sebastien Godard (sysstat orange.fr) .TH IOSTAT 1 "JULY 2020" Linux "Linux User's Manual" -*- nroff -*- .SH NAME iostat \- Report Central Processing Unit (CPU) statistics and input/output statistics for devices and partitions. + .SH SYNOPSIS .ie 'yes'@WITH_DEBUG@' \{ .B iostat [ -c ] [ -d ] [ -h ] [ -k | -m ] [ -N ] [ -s ] [ -t ] [ -V ] [ -x ] [ -y ] [ -z ] .B [ --dec={ 0 | 1 | 2 } ] [ -j { ID | LABEL | PATH | UUID | ... } ] [ -o JSON ] -.B [ [ -H ] -g -.I group_name -.B ] [ --human ] [ --pretty ] [ -p [ -.I device -.B [,...] | ALL ] ] [ -.I device -.B [...] | ALL ] [ --debuginfo ] [ -.I interval -.B [ -.I count -.B ] ] +.BI "[ [ -H ] -g " "group_name " "] [ --human ] [ --pretty ] [ -p [ " "device" "[,...] | ALL ] ] [" +.IB "device " "[...] | ALL ] [ --debuginfo ] [ " "interval " "[ " "count " "] ] " .\} .el \{ .B iostat [ -c ] [ -d ] [ -h ] [ -k | -m ] [ -N ] [ -s ] [ -t ] [ -V ] [ -x ] [ -y ] [ -z ] .B [ --dec={ 0 | 1 | 2 } ] [ -j { ID | LABEL | PATH | UUID | ... } ] [ -o JSON ] -.B [ [ -H ] -g -.I group_name -.B ] [ --human ] [ --pretty ] [ -p [ -.I device -.B [,...] | ALL ] ] [ -.I device -.B [...] | ALL ] [ -.I interval -.B [ -.I count -.B ] ] +.BI "[ [ -H ] -g " "group_name " "] [ --human ] [ --pretty ] [ -p [ " "device" "[,...] | ALL ] ] [" +.IB "device " "[...] | ALL ] [ " "interval " "[ " "count " "] ]" .\} + .SH DESCRIPTION -The -.B iostat +.RB "The " "iostat" command is used for monitoring system input/output device loading by observing the time the devices are active in relation to their average transfer rates. The @@ -43,7 +27,7 @@ to their average transfer rates. The command generates reports that can be used to change system configuration to better balance the input/output load between physical disks. - +.PP The first report generated by the .B iostat command provides statistics @@ -60,25 +44,15 @@ CPU statistics. On multiprocessor systems, CPU statistics are calculated system-wide as averages among all processors. A device header row is displayed followed by a line of statistics for each device that is configured. - +.PP The .I interval parameter specifies the amount of time in seconds between each report. The -.I count -parameter can be specified in conjunction with the -.I interval -parameter. If the -.I count -parameter is specified, the value of -.I count -determines the number of reports generated at -.I interval -seconds apart. If the -.I interval -parameter is specified without the -.I count -parameter, the +.IR "count " "parameter can be specified in conjunction with the " "interval" +.RI "parameter. If the " "count " "parameter is specified, the value of " "count" +.RI "determines the number of reports generated at " "interval " "seconds apart. If the" +.IR "interval " "parameter is specified without the " "count " "parameter, the" .B iostat command generates reports continuously. @@ -87,60 +61,42 @@ The .B iostat command generates two types of reports, the CPU Utilization report and the Device Utilization report. + .IP "CPU Utilization Report" The first report generated by the .B iostat -command is the CPU -Utilization Report. For multiprocessor systems, the CPU values are +command is the CPU Utilization Report. For multiprocessor systems, the CPU values are global averages among all processors. The report has the following format: - -.B %user -.RS .RS +.IP %user Show the percentage of CPU utilization that occurred while executing at the user level (application). -.RE - -.B %nice -.RS +.IP %nice Show the percentage of CPU utilization that occurred while executing at the user level with nice priority. -.RE - -.B %system -.RS +.IP %system Show the percentage of CPU utilization that occurred while executing at the system level (kernel). -.RE - -.B %iowait -.RS +.IP %iowait Show the percentage of time that the CPU or CPUs were idle during which the system had an outstanding disk I/O request. -.RE - -.B %steal -.RS +.IP %steal Show the percentage of time spent in involuntary wait by the virtual CPU or CPUs while the hypervisor was servicing another virtual processor. -.RE - -.B %idle -.RS +.IP %idle Show the percentage of time that the CPU or CPUs were idle and the system did not have an outstanding disk I/O request. .RE -.RE +.PP .IP "Device Utilization Report" The second report generated by the .B iostat -command is the Device Utilization -Report. The device report provides statistics on a per physical device +command is the Device Utilization Report. +The device report provides statistics on a per physical device or partition basis. Block devices and partitions for which statistics are to be displayed may be entered on the command line. -If no device nor partition -is entered, then statistics are displayed +If no device nor partition is entered, then statistics are displayed for every device used by the system, and providing that the kernel maintains statistics for it. If the @@ -149,273 +105,184 @@ keyword is given on the command line, then statistics are displayed for every device defined by the system, including those that have never been used. Transfer rates are shown in 1K blocks by default, unless the environment -variable POSIXLY_CORRECT is set, in which case 512-byte blocks are used. -The report may show the following fields, -depending on the flags used: - -.B Device: -.RS -.RS -This column gives the device (or partition) name as listed in the /dev -directory. - -.RE -.B tps -.RS +variable +.B POSIXLY_CORRECT +is set, in which case 512-byte blocks are used. +The report may show the following fields, depending on the flags used: +.RS +.IP Device: +This column gives the device (or partition) name as listed in the +.IR "/dev " "directory." +.IP tps Indicate the number of transfers per second that were issued to the device. A transfer is an I/O request to the device. Multiple logical requests can be combined into a single I/O request to the device. A transfer is of indeterminate size. - -.RE -.B Blk_read/s (kB_read/s, MB_read/s) -.RS +.IP "Blk_read/s (kB_read/s, MB_read/s)" Indicate the amount of data read from the device expressed in a number of blocks (kilobytes, megabytes) per second. Blocks are equivalent to sectors and therefore have a size of 512 bytes. - -.RE -.B Blk_wrtn/s (kB_wrtn/s, MB_wrtn/s) -.RS +.IP "Blk_wrtn/s (kB_wrtn/s, MB_wrtn/s)" Indicate the amount of data written to the device expressed in a number of blocks (kilobytes, megabytes) per second. - -.RE -.B Blk_dscd/s (kB_dscd/s, MB_dscd/s) -.RS +.IP "Blk_dscd/s (kB_dscd/s, MB_dscd/s)" Indicate the amount of data discarded for the device expressed in a number of blocks (kilobytes, megabytes) per second. - -.RE -.B Blk_read (kB_read, MB_read) -.RS +.IP "Blk_read (kB_read, MB_read)" The total number of blocks (kilobytes, megabytes) read. - -.RE -.B Blk_wrtn (kB_wrtn, MB_wrtn) -.RS +.IP "Blk_wrtn (kB_wrtn, MB_wrtn)" The total number of blocks (kilobytes, megabytes) written. - -.RE -.B Blk_dscd (kB_dscd, MB_dscd) -.RS +.IP "Blk_dscd (kB_dscd, MB_dscd)" The total number of blocks (kilobytes, megabytes) discarded. - -.RE -.B r/s -.RS +.IP r/s The number (after merges) of read requests completed per second for the device. - -.RE -.B w/s -.RS +.IP w/s The number (after merges) of write requests completed per second for the device. - -.RE -.B d/s -.RS +.IP d/s The number (after merges) of discard requests completed per second for the device. - -.RE -.B f/s -.RS +.IP f/s The number (after merges) of flush requests completed per second for the device. This counts flush requests executed by disks. Flush requests are not tracked for partitions. Before being merged, flush operations are counted as writes. - -.RE -.B sec/s (kB/s, MB/s) -.RS +.IP "sec/s (kB/s, MB/s)" The number of sectors (kilobytes, megabytes) read from, written to or discarded for the device per second. - -.RE -.B rsec/s (rkB/s, rMB/s) -.RS +.IP "rsec/s (rkB/s, rMB/s)" The number of sectors (kilobytes, megabytes) read from the device per second. - -.RE -.B wsec/s (wkB/s, wMB/s) -.RS +.IP "wsec/s (wkB/s, wMB/s)" The number of sectors (kilobytes, megabytes) written to the device per second. - -.RE -.B dsec/s (dkB/s, dMB/s) -.RS +.IP "dsec/s (dkB/s, dMB/s)" The number of sectors (kilobytes, megabytes) discarded for the device per second. - -.RE -.B rqm/s -.RS +.IP rqm/s The number of I/O requests merged per second that were queued to the device. - -.RE -.B rrqm/s -.RS +.IP rrqm/s The number of read requests merged per second that were queued to the device. - -.RE -.B wrqm/s -.RS +.IP wrqm/s The number of write requests merged per second that were queued to the device. - -.RE -.B drqm/s -.RS +.IP drqm/s The number of discard requests merged per second that were queued to the device. - -.RE -.B %rrqm -.RS +.IP %rrqm The percentage of read requests merged together before being sent to the device. - -.RE -.B %wrqm -.RS +.IP %wrqm The percentage of write requests merged together before being sent to the device. - -.RE -.B %drqm -.RS +.IP %drqm The percentage of discard requests merged together before being sent to the device. - -.RE -.B areq-sz -.RS +.IP areq-sz The average size (in kilobytes) of the I/O requests that were issued to the device. .br -Note: In previous versions, this field was known as avgrq-sz and was expressed in -sectors. - -.RE -.B rareq-sz -.RS -The average size (in kilobytes) of the read requests that were issued to the -device. - -.RE -.B wareq-sz -.RS -The average size (in kilobytes) of the write requests that were issued to the -device. - -.RE -.B dareq-sz -.RS -The average size (in kilobytes) of the discard requests that were issued to the -device. - -.RE -.B await -.RS +Note: In previous versions, this field was known as avgrq-sz and was expressed in sectors. +.IP rareq-sz +The average size (in kilobytes) of the read requests that were issued to the device. +.IP wareq-sz +The average size (in kilobytes) of the write requests that were issued to the device. +.IP dareq-sz +The average size (in kilobytes) of the discard requests that were issued to the device. +.IP await The average time (in milliseconds) for I/O requests issued to the device to be served. This includes the time spent by the requests in queue and the time spent servicing them. - -.RE -.B r_await -.RS +.IP r_await The average time (in milliseconds) for read requests issued to the device to be served. This includes the time spent by the requests in queue and the time spent servicing them. - -.RE -.B w_await -.RS +.IP w_await The average time (in milliseconds) for write requests issued to the device to be served. This includes the time spent by the requests in queue and the time spent servicing them. - -.RE -.B d_await -.RS +.IP d_await The average time (in milliseconds) for discard requests issued to the device to be served. This includes the time spent by the requests in queue and the time spent servicing them. - -.RE -.B f_await -.RS +.IP f_await The average time (in milliseconds) for flush requests issued to the device to be served. The block layer combines flush requests and executes at most one at a time. Thus flush operations could be twice as long: Wait for current flush request, then execute it, then wait for the next one. - -.RE -.B aqu-sz -.RS +.IP aqu-sz The average queue length of the requests that were issued to the device. .br Note: In previous versions, this field was known as avgqu-sz. - -.RE -.B %util -.RS +.IP %util Percentage of elapsed time during which I/O requests were issued to the device (bandwidth utilization for the device). Device saturation occurs when this value is close to 100% for devices serving requests serially. But for devices serving requests in parallel, such as RAID arrays and modern SSDs, this number does not reflect their performance limits. .RE -.RE + .SH OPTIONS -.IP -c +.TP +.B -c Display the CPU utilization report. -.IP -d +.TP +.B -d Display the device utilization report. .if 'yes'@WITH_DEBUG@' \{ -.IP --debuginfo +.TP +.B --debuginfo Print debug output to stderr. .\} -.IP "--dec={ 0 | 1 | 2 }" +.TP +.B --dec={ 0 | 1 | 2 } Specify the number of decimal places to use (0 to 2, default value is 2). -.IP "-g group_name { device [...] | ALL } +.TP +.BI "-g " "group_name " "{ " "device " "[...] | ALL }" Display statistics for a group of devices. The .B iostat command reports statistics for each individual device in the list then a line of global statistics for the group displayed as -.B group_name +.I group_name and made up of all the devices in the list. The .B ALL keyword means that all the block devices defined by the system shall be included in the group. -.IP -H -This option must be used with option -g and indicates that only global +.TP +.B -H +This option must be used with option +.B -g +and indicates that only global statistics for the group are to be displayed, and not statistics for individual devices in the group. -.IP -h +.TP +.B -h This option is equivalent to specifying -.BR "--human --pretty" . -.IP --human +.BR "--human --pretty" "." +.TP +.B --human Print sizes in human readable format (e.g. 1.0k, 1.2M, etc.) The units displayed with this option supersede any other default units (e.g. kilobytes, sectors...) associated with the metrics. -.IP "-j { ID | LABEL | PATH | UUID | ... } [ device [...] | ALL ]" -Display persistent device names. Options -.BR ID , -.BR LABEL , -etc. specify the type of the persistent name. These options are not limited, +.TP +.BI "-j { ID | LABEL | PATH | UUID | ... } [ " "device " "[...] | ALL ]" +Display persistent device names. Keywords +.BR "ID" ", " "LABEL" ", " +etc. specify the type of the persistent name. These keywords are not limited, only prerequisite is that directory with required persistent names is present in -.IR /dev/disk . +.IR "/dev/disk" "." Optionally, multiple devices can be specified in the chosen persistent name type. Because persistent device names are usually long, option .B --pretty is implicitly set with this option. -.IP -k +.TP +.B -k Display statistics in kilobytes per second. -.IP -m +.TP +.B -m Display statistics in megabytes per second. -.IP -N +.TP +.B -N Display the registered device mapper names for any device mapper devices. Useful for viewing LVM2 statistics. -.IP "-o JSON" +.TP +.B -o JSON Display the statistics in JSON (Javascript Object Notation) format. JSON output field order is undefined, and new fields may be added in the future. -.IP "-p [ { device [,...] | ALL } ]" -The -p option displays statistics for +.TP +.BI "-p [ { " "device" "[,...] | ALL } ]" +Display statistics for block devices and all their partitions that are used by the system. If a device name is entered on the command line, then statistics for it and all its partitions are displayed. Last, the @@ -426,22 +293,30 @@ never been used. If option .B -j is defined before this option, devices entered on the command line can be specified with the chosen persistent name type. -.IP --pretty +.TP +.B --pretty Make the Device Utilization Report easier to read by a human. -.IP -s +.TP +.B -s Display a short (narrow) version of the report that should fit in 80 characters wide screens. -.IP -t +.TP +.B -t Print the time for each report displayed. The timestamp format may depend -on the value of the S_TIME_FORMAT environment variable (see below). -.IP -V +on the value of the +.BR "S_TIME_FORMAT " "environment variable (see below)." +.TP +.B -V Print version number then exit. -.IP -x +.TP +.B -x Display extended statistics. -.IP -y +.TP +.B -y Omit first report with statistics since system boot, if displaying multiple records at given interval. -.IP -z +.TP +.B -z Tell .B iostat to omit output for any devices for which there was no activity @@ -451,129 +326,104 @@ during the sample period. The .B iostat command takes into account the following environment variables: - -.IP POSIXLY_CORRECT +.TP +.B POSIXLY_CORRECT When this variable is set, transfer rates are shown in 512-byte blocks instead of the default 1K blocks. - -.IP S_COLORS +.TP +.B S_COLORS By default statistics are displayed in color when the output is connected to a terminal. Use this variable to change the settings. Possible values for this variable are -.IR never , -.IR always -or -.IR auto +.IR "never" ", " "always " "or " "auto" (the latter is equivalent to the default settings). - +.br Please note that the color (being red, yellow, or some other color) used to display a value is not indicative of any kind of issue simply because of the color. It only indicates different ranges of values. - -.IP S_COLORS_SGR +.TP +.B S_COLORS_SGR Specify the colors and other attributes used to display statistics on the terminal. Its value is a colon-separated list of capabilities that defaults to -.BR H=31;1:I=32;22:M=35;1:N=34;1:Z=34;22 . +.BR "H=31;1:I=32;22:M=35;1:N=34;1:Z=34;22" "." Supported capabilities are: - .RS .TP .B H= SGR (Select Graphic Rendition) substring for percentage values greater than or equal to 75%. - .TP .B I= SGR substring for device names. - .TP .B M= SGR substring for percentage values in the range from 50% to 75%. - .TP .B N= SGR substring for non-zero statistics values. - .TP .B Z= SGR substring for zero values. .RE - -.IP S_TIME_FORMAT +.TP +.B S_TIME_FORMAT If this variable exists and its value is -.BR ISO +.B ISO then the current locale will be ignored when printing the date in the report header. The .B iostat command will use the ISO 8601 format (YYYY-MM-DD) instead. -The timestamp displayed with option -t will also be compliant with ISO 8601 -format. +The timestamp displayed with option +.B -t +will also be compliant with ISO 8601 format. .SH EXAMPLES +.TP .B iostat -.RS Display a single history since boot report for all CPU and Devices. - -.RE +.TP .B iostat -d 2 -.RS Display a continuous device report at two second intervals. - -.RE +.TP .B iostat -d 2 6 -.RS Display six reports at two second intervals for all devices. - -.RE +.TP .B iostat -x sda sdb 2 6 -.RS Display six reports of extended statistics at two second intervals for devices sda and sdb. - -.RE +.TP .B iostat -p sda 2 6 -.RS Display six reports at two second intervals for device sda and all its partitions (sda1, etc.) -.SH BUGS -.I /proc -filesystem must be mounted for -.B iostat -to work. +.SH BUGS +.IR "/proc " "filesystem must be mounted for" +.BR "iostat " "to work." +.PP Kernels older than 2.6.x are no longer supported. - -Although -.B iostat +.PP +.RB "Although " "iostat" speaks of kilobytes (kB), megabytes (MB)..., it actually uses kibibytes (kiB), mebibytes (MiB)... A kibibyte is equal to 1024 bytes, and a mebibyte is equal to 1024 kibibytes. -.SH FILES -.I /proc/stat -contains system statistics. -.I /proc/uptime -contains system uptime. - -.I /proc/diskstats -contains disks statistics. - -.I /sys -contains statistics for block devices. - -.I /proc/self/mountstats -contains statistics for network filesystems. +.SH FILES +.IR "/proc/stat " "contains system statistics." +.br +.IR "/proc/uptime " "contains system uptime." +.br +.IR "/proc/diskstats " "contains disks statistics." +.br +.IR "/sys " "contains statistics for block devices." +.br +.IR "/proc/self/mountstats " "contains statistics for network filesystems." +.br +.IR "/dev/disk " "contains persistent device names." -.I /dev/disk -contains persistent device names. .SH AUTHOR Sebastien Godard (sysstat orange.fr) -.SH SEE ALSO -.BR sar (1), -.BR pidstat (1), -.BR mpstat (1), -.BR vmstat (8), -.BR tapestat (1), -.BR nfsiostat (1), -.BR cifsiostat (1) +.SH SEE ALSO +.BR "sar" "(1), " "pidstat" "(1), " "mpstat" "(1), " "vmstat" "(8), " "tapestat" "(1), " "nfsiostat" "(1)," +.BR "cifsiostat" "(1)" +.PP .I https://github.com/sysstat/sysstat - +.br .I http://pagesperso-orange.fr/sebastien.godard/ diff --git a/man/mpstat.1 b/man/mpstat.1 index 17549f7..7f5c7cd 100644 --- a/man/mpstat.1 +++ b/man/mpstat.1 @@ -1,330 +1,241 @@ -.TH MPSTAT 1 "JUNE 2020" Linux "Linux User's Manual" -*- nroff -*- +.\" mpstat manual page - (C) 2000-2020 Sebastien Godard (sysstat orange.fr) +.TH MPSTAT 1 "JULY 2020" Linux "Linux User's Manual" -*- nroff -*- .SH NAME mpstat \- Report processors related statistics. + .SH SYNOPSIS .B mpstat [ -A ] [ --dec={ 0 | 1 | 2 } ] [ -n ] [ -u ] [ -T ] [ -V ] [ -I { -.I keyword -.B [,...] | ALL } ] [ -N { -.I node_list -.B | ALL } ] [ -o JSON ] [ -P { -.I cpu_list -.B | ALL } ] [ -.I interval -.B [ -.I count -.B ] ] +.IB "keyword" "[,...] | ALL } ] [ -N { " "node_list " "| ALL } ] [ -o JSON ] [ -P {" +.IB "cpu_list " "| ALL } ] [ " "interval " "[ " "count " "] ]" + .SH DESCRIPTION -The -.B mpstat +.RB "The " "mpstat" command writes to standard output activities for each available processor, processor 0 being the first one. Global average activities among all processors are also reported. -The -.B mpstat +.RB "The " "mpstat" command can be used both on SMP and UP machines, but in the latter, only global average activities will be printed. If no activity has been selected, then the default report is the CPU utilization report. - -The -.I interval +.PP +.RI "The " "interval" parameter specifies the amount of time in seconds between each report. A value of 0 (or no parameters at all) indicates that processors statistics are -to be reported for the time since system startup (boot). -The -.I count -parameter can be specified in conjunction with the -.I interval +to be reported for the time since system startup (boot). The +.IR "count " "parameter can be specified in conjunction with the " "interval" parameter if this one is not set to zero. The value of .I count determines the number of reports generated at -.I interval -seconds apart. If the -.I interval +.IR "interval " "seconds apart. If the " "interval" parameter is specified without the -.I count -parameter, the +.IR "count " "parameter, the" .B mpstat command generates reports continuously. .SH OPTIONS -.IP -A +.TP +.B -A This option is equivalent to specifying -.BR "-n -u -I ALL". +.BR "-n -u -I ALL" "." This option also implies specifying -.BR "-N ALL -P ALL" +.B "-N ALL -P ALL" unless these options are explicitly set on the command line. -.IP "--dec={ 0 | 1 | 2 }" +.TP +.B --dec={ 0 | 1 | 2 } Specify the number of decimal places to use (0 to 2, default value is 2). -.IP "-I { keyword [,...] | ALL }" +.TP +.BI "-I { " "keyword" "[,...] | ALL }" Report interrupts statistics. - -Possible keywords are -.BR CPU , -.BR SCPU , -and -.BR SUM . - -With the -.B CPU +.RI "Possible " "keywords " "are" +.BR "CPU" ", " "SCPU" ", and " "SUM" "." +.PP +.RS +.RB "With the " "CPU" keyword, the number of each individual interrupt received per -second by the CPU or CPUs is displayed. Interrupts are those listed -in /proc/interrupts file. - -With the -.B SCPU +second by the CPU or CPUs is displayed. Interrupts are those listed in +.IR "/proc/interrupts " "file." +.PP +.RB "With the " "SCPU" keyword, the number of each individual software interrupt received per second by the CPU or CPUs is displayed. This option works only -with kernels 2.6.31 and later. Software interrupts are those listed -in /proc/softirqs file. - -With the -.B SUM -keyword, the -.B mpstat +with kernels 2.6.31 and later. Software interrupts are those listed in +.IR "/proc/softirqs " "file." +.PP +.RB "With the " "SUM " "keyword, the " "mpstat" command reports the total number of interrupts per processor. The following values are displayed: -.B CPU -.RS -.RS +.IP CPU Processor number. The keyword -.I all -indicates that statistics are calculated as averages among all -processors. -.RE +.B all +indicates that statistics are calculated as averages among all processors. -.B intr/s -.RS +.IP intr/s Show the total number of interrupts received per second by the CPU or CPUs. .RE - -The -.B ALL +.IP +.RB "The " "ALL" keyword is equivalent to specifying all the keywords above and therefore all the interrupts statistics are displayed. -.RE -.RE -.IP "-N { node_list | ALL }" +.TP +.BI "-N { " "node_list " "| ALL }" Indicate the NUMA nodes for which statistics are to be reported. .I node_list is a list of comma-separated values or range of values (e.g., -.BR 0,2,4-7,12- ). -Note that node -.B all +.BR "0,2,4-7,12-" "). Note that node " "all" is the global average among all nodes. The .B ALL keyword indicates that statistics are to be reported for all nodes. -.IP -n +.TP +.B -n Report summary CPU statistics based on NUMA node placement. The following values are displayed: - -.B NODE -.RS .RS +.IP NODE Logical NUMA node number. The keyword -.I all +.B all indicates that statistics are calculated as averages among all nodes. .RE - -All the other fields are the same as those displayed with option -u -(see below). -.RE -.IP "-o JSON" +.IP +All the other fields are the same as those displayed with option +.BR "-u " "(see below)." +.TP +.B -o JSON Display the statistics in JSON (Javascript Object Notation) format. JSON output field order is undefined, and new fields may be added in the future. -.IP "-P { cpu_list | ALL }" +.TP +.BI "-P { " "cpu_list " "| ALL }" Indicate the processors for which statistics are to be reported. .I cpu_list is a list of comma-separated values or range of values (e.g., -.BR 0,2,4-7,12- ). +.BR "0,2,4-7,12-" ")." Note that processor 0 is the first processor, and processor .B all is the global average among all processors. -The -.B ALL +.RB "The " "ALL" keyword indicates that statistics are to be reported for all processors. Offline processors are not displayed. -.IP -T -Display topology elements in the CPU report (see option -u below). The -following elements are displayed: - -.B CORE -.RS +.TP +.B -T +Display topology elements in the CPU report (see option +.B -u +below). The following elements are displayed: .RS +.IP CORE Logical core number. -.RE - -.B SOCK -.RS +.IP SOCK Logical socket number. -.RE - -.B NODE -.RS +.IP NODE Logical NUMA node number. .RE -.RE -.IP -u +.TP +.B -u Report CPU utilization. The following values are displayed: - -.B CPU -.RS .RS +.IP CPU Processor number. The keyword .I all -indicates that statistics are calculated as averages among all -processors. -.RE - -.B %usr -.RS +indicates that statistics are calculated as averages among all processors. +.IP %usr Show the percentage of CPU utilization that occurred while executing at the user level (application). -.RE - -.B %nice -.RS +.IP %nice Show the percentage of CPU utilization that occurred while executing at the user level with nice priority. -.RE - -.B %sys -.RS +.IP %sys Show the percentage of CPU utilization that occurred while executing at the system level (kernel). Note that this does not include time spent servicing hardware and software interrupts. -.RE - -.B %iowait -.RS +.IP %iowait Show the percentage of time that the CPU or CPUs were idle during which the system had an outstanding disk I/O request. -.RE - -.B %irq -.RS -Show the percentage of time spent by the CPU or CPUs to service hardware -interrupts. -.RE - -.B %soft -.RS -Show the percentage of time spent by the CPU or CPUs to service software -interrupts. -.RE - -.B %steal -.RS +.IP %irq +Show the percentage of time spent by the CPU or CPUs to service hardware interrupts. +.IP %soft +Show the percentage of time spent by the CPU or CPUs to service software interrupts. +.IP %steal Show the percentage of time spent in involuntary wait by the virtual CPU or CPUs while the hypervisor was servicing another virtual processor. -.RE - -.B %guest -.RS -Show the percentage of time spent by the CPU or CPUs to run a virtual -processor. -.RE - -.B %gnice -.RS -Show the percentage of time spent by the CPU or CPUs to run a niced -guest. -.RE - -.B %idle -.RS +.IP %guest +Show the percentage of time spent by the CPU or CPUs to run a virtual processor. +.IP %gnice +Show the percentage of time spent by the CPU or CPUs to run a niced guest. +.IP %idle Show the percentage of time that the CPU or CPUs were idle and the system did not have an outstanding disk I/O request. .RE -.RE -.IP -V +.TP +.B -V Print version number then exit. .SH ENVIRONMENT -The -.B mpstat +.RB "The " "mpstat" command takes into account the following environment variable: - -.IP S_COLORS +.TP +.B S_COLORS By default statistics are displayed in color when the output is connected to a terminal. Use this variable to change the settings. Possible values for this variable are -.IR never , -.IR always -or -.IR auto +.IR "never" ", " "always " "or " "auto" (the latter is equivalent to the default settings). - +.br Please note that the color (being red, yellow, or some other color) used to display a value is not indicative of any kind of issue simply because of the color. It only indicates different ranges of values. - -.IP S_COLORS_SGR +.TP +.B S_COLORS_SGR Specify the colors and other attributes used to display statistics on the terminal. Its value is a colon-separated list of capabilities that defaults to -.BR H=31;1:I=32;22:M=35;1:N=34;1:Z=34;22 . +.BR "H=31;1:I=32;22:M=35;1:N=34;1:Z=34;22" "." Supported capabilities are: - .RS .TP .B H= SGR (Select Graphic Rendition) substring for percentage values greater than or equal to 75%. - .TP .B I= SGR substring for CPU number. - .TP .B M= SGR substring for percentage values in the range from 50% to 75%. - .TP .B N= SGR substring for non-zero statistics values. - .TP .B Z= SGR substring for zero values. .RE - -.IP S_TIME_FORMAT +.TP +.B S_TIME_FORMAT If this variable exists and its value is .BR ISO then the current locale will be ignored when printing the date in the report header. -The -.B mpstat +.RB "The " "mpstat" command will use the ISO 8601 format (YYYY-MM-DD) instead. The timestamp will also be compliant with ISO 8601 format. .SH EXAMPLES +.TP .B mpstat 2 5 -.RS Display five reports of global statistics among all processors at two second intervals. -.RE - +.TP .B mpstat -P ALL 2 5 -.RS Display five reports of statistics for all processors at two second intervals. .SH BUGS -.I /proc -filesystem must be mounted for the -.B mpstat -command to work. +.IR "/proc " "filesystem must be mounted for the" +.BR "mpstat " "command to work." .SH FILES -.IR /proc -contains various files with system statistics. +.IR "/proc " "contains various files with system statistics." .SH AUTHOR Sebastien Godard (sysstat orange.fr) -.SH SEE ALSO -.BR sar (1), -.BR pidstat (1), -.BR iostat (1), -.BR vmstat (8) +.SH SEE ALSO +.BR "sar" "(1), " "pidstat" "(1), " "iostat" "(1), " "vmstat" "(8)" +.PP .I https://github.com/sysstat/sysstat - +.br .I http://pagesperso-orange.fr/sebastien.godard/ diff --git a/man/pidstat.1 b/man/pidstat.1 index 61d5e19..d1dfab4 100644 --- a/man/pidstat.1 +++ b/man/pidstat.1 @@ -1,27 +1,18 @@ -.TH PIDSTAT 1 "JUNE 2020" Linux "Linux User's Manual" -*- nroff -*- +.\" pidstat manual page - (C) 2007-2020 Sebastien Godard (sysstat orange.fr) +.TH PIDSTAT 1 "JULY 2020" Linux "Linux User's Manual" -*- nroff -*- .SH NAME pidstat \- Report statistics for Linux tasks. + .SH SYNOPSIS .B pidstat [ -d ] [ -H ] [ -h ] [ -I ] [ -l ] [ -R ] [ -r ] [ -s ] [ -t ] [ -U [ -.I username -.B ] ] [ -u ] [ -V ] [ -v ] -.B [ -w ] [ -C -.I comm -.B ] [ -G -.I process_name -.B ] [ --dec={ 0 | 1 | 2 } ] [ --human ] [ -p { -.I pid -.B [,...] | SELF | ALL } ] [ -T { TASK | CHILD | ALL } ] [ -.I interval -.B [ -.I count -.B ] ] [ -e -.I program -.I args -.B ] +.IB "username " "] ] [ -u ] [ -V ] [ -v ] [ -w ] [ -C " "comm " "] [ -G " "process_name" +.BI "] [ --dec={ 0 | 1 | 2 } ] [ --human ] [ -p { " "pid" "[,...]" +.B | SELF | ALL } ] [ -T { TASK | CHILD | ALL } ] [ +.IB "interval " "[ " "count " "] ] [ -e " "program" +.IB "args " "]" + .SH DESCRIPTION -The -.B pidstat +.RB "The " "pidstat" command is used for monitoring individual tasks currently being managed by the Linux kernel. It writes to standard output activities for every task selected with option @@ -32,315 +23,207 @@ has been used. Not selecting any tasks is equivalent to specifying .B -p ALL but only active tasks (tasks with non-zero statistics values) will appear in the report. - -The -.B pidstat +.PP +.RB "The " "pidstat" command can also be used for monitoring the child processes of selected tasks. Read about option -.B -T -below. - -The -.I interval +.BR "-T " "below." +.PP +.RI "The " "interval" parameter specifies the amount of time in seconds between each report. A value of 0 (or no parameters at all) indicates that tasks statistics are -to be reported for the time since system startup (boot). -The -.I count -parameter can be specified in conjunction with the -.I interval -parameter if this one is not set to zero. The value of -.I count -determines the number of reports generated at -.I interval -seconds apart. If the -.I interval -parameter is specified without the -.I count +to be reported for the time since system startup (boot). The +.IR "count " "parameter can be specified in conjunction with the" +.IR "interval " "parameter if this one is not set to zero. The value of" +.IR "count " "determines the number of reports generated at" +.IR "interval " "seconds apart. If the " "interval " "parameter is specified without the " "count" parameter, the .B pidstat command generates reports continuously. - +.PP You can select information about specific task activities using flags. Not specifying any flags selects only CPU activity. .SH OPTIONS -.IP "-C comm" +.TP +.BI "-C " "comm" Display only tasks whose command name includes the string -.IR comm . -This string can be a regular expression. -.IP -d +.IR "comm" ". This string can be a regular expression." +.TP +.B -d Report I/O statistics (kernels 2.6.20 and later only). The following values may be displayed: - -.B UID -.RS .RS +.IP UID The real user identification number of the task being monitored. -.RE - -.B USER -.RS +.IP USER The name of the real user owning the task being monitored. -.RE - -.B PID -.RS +.IP PID The identification number of the task being monitored. -.RE - -.B kB_rd/s -.RS -Number of kilobytes the task has caused to be read from disk -per second. -.RE - -.B kB_wr/s -.RS +.IP kB_rd/s +Number of kilobytes the task has caused to be read from disk per second. +.IP kB_wr/s Number of kilobytes the task has caused, or shall cause to be written to disk per second. -.RE - -.B kB_ccwr/s -.RS +.IP kB_ccwr/s Number of kilobytes whose writing to disk has been cancelled by the task. This may occur when the task truncates some dirty pagecache. In this case, some IO which another task has been accounted for will not be happening. -.RE - -.B iodelay -.RS +.IP iodelay Block I/O delay of the task being monitored, measured in clock ticks. This metric includes the delays spent waiting for sync block I/O completion and for swapin block I/O completion. -.RE - -.B Command -.RS +.IP Command The command name of the task. .RE -.RE -.IP "--dec={ 0 | 1 | 2 }" +.TP +.B --dec={ 0 | 1 | 2 } Specify the number of decimal places to use (0 to 2, default value is 2). -.IP "-e program args" +.TP +.BI "-e " "program args" Execute -.IR program +.I program with given arguments -.IR args +.I args and monitor it with -.B pidstat. -.B pidstat -stops when -.IR program -terminates. -.IP "-G process_name" +.BR "pidstat" "." +.BR "pidstat " "stops when" +.IR "program " "terminates." +.TP +.BI "-G " "process_name" Display only processes whose command name includes the string -.IR process_name . -This string can be a regular expression. If option -t is used -together with option -G then the threads belonging to that -process are also displayed (even if their command name doesn't -include the string -.IR process_name ). -.IP -H +.IR "process_name" "." +This string can be a regular expression. If option +.BR "-t " "is used together with option " "-G" +then the threads belonging to that process are also displayed +(even if their command name doesn't include the string +.IR "process_name" ")." +.TP +.B -H Display timestamp in seconds since the epoch. -.IP -h +.TP +.B -h Display all activities horizontally on a single line, with no average statistics at the end of the report. This is intended to make it easier to be parsed by other programs. -.IP --human +.TP +.B --human Print sizes in human readable format (e.g. 1.0k, 1.2M, etc.) The units displayed with this option supersede any other default units (e.g. kilobytes, sectors...) associated with the metrics. -.IP -I +.TP +.B -I In an SMP environment, indicate that tasks CPU usage -(as displayed by option -.B -u -) should be divided by the total number of processors. -.IP -l +.RB "(as displayed by option " "-u" ")" +should be divided by the total number of processors. +.TP +.B -l Display the process command name and all its arguments. -.IP "-p { pid [,...] | SELF | ALL }" +.TP +.BI "-p { " "pid" "[,...] | SELF | ALL }" Select tasks (processes) for which statistics are to be reported. .I pid is the process identification number. The .B SELF keyword indicates that statistics are to be reported for the -.B pidstat -process itself, whereas the -.B ALL +.BR "pidstat " "process itself, whereas the " "ALL" keyword indicates that statistics are to be reported for all the tasks managed by the system. -.IP -R +.TP +.B -R Report realtime priority and scheduling policy information. The following values may be displayed: - -.B UID -.RS .RS +.IP UID The real user identification number of the task being monitored. -.RE - -.B USER -.RS +.IP USER The name of the real user owning the task being monitored. -.RE - -.B PID -.RS +.IP PID The identification number of the task being monitored. -.RE - -.B prio -.RS +.IP prio The realtime priority of the task being monitored. -.RE - -.B policy -.RS +.IP policy The scheduling policy of the task being monitored. -.RE - -.B Command -.RS +.IP Command The command name of the task. .RE -.RE -.IP -r +.TP +.B -r Report page faults and memory utilization. When reporting statistics for individual tasks, the following values may be displayed: - -.B UID -.RS .RS +.IP UID The real user identification number of the task being monitored. -.RE - -.B USER -.RS +.IP USER The name of the real user owning the task being monitored. -.RE - -.B PID -.RS +.IP PID The identification number of the task being monitored. -.RE - -.B minflt/s -.RS +.IP minflt/s Total number of minor faults the task has made per second, those which have not required loading a memory page from disk. -.RE - -.B majflt/s -.RS +.IP majflt/s Total number of major faults the task has made per second, those which have required loading a memory page from disk. -.RE - -.B VSZ -.RS +.IP VSZ Virtual Size: The virtual memory usage of entire task in kilobytes. -.RE - -.B RSS -.RS +.IP RSS Resident Set Size: The non-swapped physical memory used by the task in kilobytes. -.RE - -.B %MEM -.RS +.IP %MEM The tasks's currently used share of available physical memory. -.RE - -.B Command -.RS +.IP Command The command name of the task. .RE - +.IP When reporting global statistics for tasks and all their children, the following values may be displayed: - -.B UID .RS +.IP UID The real user identification number of the task which is being monitored together with its children. -.RE - -.B USER -.RS +.IP USER The name of the real user owning the task which is being monitored together with its children. -.RE - -.B PID -.RS +.IP PID The identification number of the task which is being monitored together with its children. -.RE - -.B minflt-nr -.RS +.IP minflt-nr Total number of minor faults made by the task and all its children, and collected during the interval of time. -.RE - -.B majflt-nr -.RS +.IP majflt-nr Total number of major faults made by the task and all its children, and collected during the interval of time. -.RE - -.B Command -.RS +.IP Command The command name of the task which is being monitored together with its children. .RE -.RE -.IP -s +.TP +.B -s Report stack utilization. The following values may be displayed: - -.B UID -.RS .RS +.IP UID The real user identification number of the task being monitored. -.RE - -.B USER -.RS +.IP USER The name of the real user owning the task being monitored. -.RE - -.B PID -.RS +.IP PID The identification number of the task being monitored. -.RE - -.B StkSize -.RS +.IP StkSize The amount of memory in kilobytes reserved for the task as stack, but not necessarily used. -.RE - -.B StkRef -.RS +.IP StkRef The amount of memory in kilobytes used as stack, referenced by the task. -.RE - -.B Command -.RS +.IP Command The command name of the task. .RE -.RE -.IP "-T { TASK | CHILD | ALL }" +.TP +.B -T { TASK | CHILD | ALL } This option specifies what has to be monitored by the -.B pidstat -command. The -.B TASK +.BR "pidstat " "command. The " "TASK" keyword indicates that statistics are to be reported for individual tasks (this is the default option) whereas the .B CHILD @@ -357,321 +240,211 @@ for all options of Also these statistics are not necessarily relevant to current time interval: The statistics of a child process are collected only when it finishes or it is killed. -.IP -t +.TP +.B -t Also display statistics for threads associated with selected tasks. This option adds the following values to the reports: - -.B TGID -.RS .RS +.IP TGID The identification number of the thread group leader. -.RE - -.B TID -.RS +.IP TID The identification number of the thread being monitored. .RE -.RE -.IP "-U [ username ]" +.TP +.BI "-U [ " "username " "]" Display the real user name of the tasks being monitored instead of the UID. -If -.I username +.RI "If " "username" is specified, then only tasks belonging to the specified user are displayed. -.IP -u +.TP +.B -u Report CPU utilization. When reporting statistics for individual tasks, the following values may be displayed: - -.B UID -.RS .RS +.IP UID The real user identification number of the task being monitored. -.RE - -.B USER -.RS +.IP USER The name of the real user owning the task being monitored. -.RE - -.B PID -.RS +.IP PID The identification number of the task being monitored. -.RE - -.B %usr -.RS +.IP %usr Percentage of CPU used by the task while executing at the user level (application), with or without nice priority. Note that this field does NOT include time spent running a virtual processor. -.RE - -.B %system -.RS -Percentage of CPU used by the task while executing at the system level -(kernel). -.RE - -.B %guest -.RS -Percentage of CPU spent by the task in virtual machine (running a virtual -processor). -.RE - -.B %wait -.RS +.IP %system +Percentage of CPU used by the task while executing at the system level (kernel). +.IP %guest +Percentage of CPU spent by the task in virtual machine (running a virtual processor). +.IP %wait Percentage of CPU spent by the task while waiting to run. -.RE - -.B %CPU -.RS +.IP %CPU Total percentage of CPU time used by the task. In an SMP environment, -the task's CPU usage will be divided by the total number of CPU's if -option +the task's CPU usage will be divided by the total number of CPU's if option .B -I has been entered on the command line. -.RE - -.B CPU -.RS +.IP CPU Processor number to which the task is attached. -.RE - -.B Command -.RS +.IP Command The command name of the task. .RE - +.IP When reporting global statistics for tasks and all their children, the following values may be displayed: - -.B UID .RS +.IP UID The real user identification number of the task which is being monitored together with its children. -.RE - -.B USER -.RS +.IP USER The name of the real user owning the task which is being monitored together with its children. -.RE - -.B PID -.RS +.IP PID The identification number of the task which is being monitored together with its children. -.RE - -.B usr-ms -.RS +.IP usr-ms Total number of milliseconds spent by the task and all its children while executing at the user level (application), with or without nice priority, and collected during the interval of time. Note that this field does NOT include time spent running a virtual processor. -.RE - -.B system-ms -.RS +.IP system-ms Total number of milliseconds spent by the task and all its children while executing at the system level (kernel), and collected during the interval of time. -.RE - -.B guest-ms -.RS +.IP guest-ms Total number of milliseconds spent -by the task and all its children in virtual machine (running a virtual -processor). -.RE - -.B Command -.RS +by the task and all its children in virtual machine (running a virtual processor). +.IP Command The command name of the task which is being monitored together with its children. .RE -.RE -.IP -V +.TP +.B -V Print version number then exit. -.IP -v +.TP +.B -v Report values of some kernel tables. The following values may be displayed: - -.B UID -.RS .RS +.IP UID The real user identification number of the task being monitored. -.RE - -.B USER -.RS +.IP USER The name of the real user owning the task being monitored. -.RE - -.B PID -.RS +.IP PID The identification number of the task being monitored. -.RE - -.B threads -.RS +.IP threads Number of threads associated with current task. -.RE - -.B fd-nr -.RS +.IP fd-nr Number of file descriptors associated with current task. -.RE - -.B Command -.RS +.IP Command The command name of the task. .RE -.RE -.IP -w +.TP +.B -w Report task switching activity (kernels 2.6.23 and later only). The following values may be displayed: - -.B UID -.RS .RS +.IP UID The real user identification number of the task being monitored. -.RE - -.B USER -.RS +.IP USER The name of the real user owning the task being monitored. -.RE - -.B PID -.RS +.IP PID The identification number of the task being monitored. -.RE - -.B cswch/s -.RS +.IP cswch/s Total number of voluntary context switches the task made per second. A voluntary context switch occurs when a task blocks because it requires a resource that is unavailable. -.RE - -.B nvcswch/s -.RS +.IP nvcswch/s Total number of non voluntary context switches the task made per second. A involuntary context switch takes place when a task executes for the duration of its time slice and then is forced to relinquish the processor. -.RE - -.B Command -.RS +.IP Command The command name of the task. .RE -.RE + .SH ENVIRONMENT The .B pidstat command takes into account the following environment variables: - -.IP S_COLORS +.TP +.B S_COLORS By default statistics are displayed in color when the output is connected to a terminal. Use this variable to change the settings. Possible values for this variable are -.IR never , -.IR always -or -.IR auto +.IR "never" ", " "always " "or " "auto" (the latter is equivalent to the default settings). - +.br Please note that the color (being red, yellow, or some other color) used to display a value is not indicative of any kind of issue simply because of the color. It only indicates different ranges of values. - -.IP S_COLORS_SGR +.TP +.B S_COLORS_SGR Specify the colors and other attributes used to display statistics on the terminal. Its value is a colon-separated list of capabilities that defaults to -.BR H=31;1:I=32;22:M=35;1:N=34;1:Z=34;22 . +.BR "H=31;1:I=32;22:M=35;1:N=34;1:Z=34;22" "." Supported capabilities are: - .RS .TP .B H= SGR (Select Graphic Rendition) substring for percentage values greater than or equal to 75%. - .TP .B I= SGR substring for item values like PID, UID or CPU number. - .TP .B M= SGR substring for percentage values in the range from 50% to 75%. - .TP .B N= SGR substring for non-zero statistics values and for tasks names. - .TP .B Z= SGR substring for zero values and for threads names. .RE - -.IP S_TIME_FORMAT +.TP +.B S_TIME_FORMAT If this variable exists and its value is .BR ISO -then the current locale will be ignored when printing the date in the report header. -The +then the current locale will be ignored when printing the date in the report header. The .B pidstat command will use the ISO 8601 format (YYYY-MM-DD) instead. The timestamp will also be compliant with ISO 8601 format. .SH EXAMPLES +.TP .B pidstat 2 5 -.RS Display five reports of CPU statistics for every active task in the system at two second intervals. -.RE - +.TP .B pidstat -r -p 1643 2 5 -.RS Display five reports of page faults and memory statistics for PID 1643 at two second intervals. -.RE - +.TP .B pidstat -C """fox|bird"" -r -p ALL -.RS Display global page faults and memory statistics for all the processes whose command name includes the string "fox" or "bird". -.RE - +.TP .B pidstat -T CHILD -r 2 5 -.RS Display five reports of page faults statistics at two second intervals for the child processes of all tasks in the system. Only child processes with non-zero statistics values are displayed. -.SH BUGS -.I /proc -filesystem must be mounted for the -.B pidstat -command to work. -Although -.B pidstat +.SH BUGS +.IR "/proc " "filesystem must be mounted for the" +.BR "pidstat " "command to work." +.PP +.RB "Although " "pidstat" speaks of kilobytes (kB), megabytes (MB)..., it actually uses kibibytes (kiB), mebibytes (MiB)... A kibibyte is equal to 1024 bytes, and a mebibyte is equal to 1024 kibibytes. + .SH FILES -.IR /proc -contains various files with system statistics. +.IR "/proc " "contains various files with system statistics." .SH AUTHOR Sebastien Godard (sysstat orange.fr) -.SH SEE ALSO -.BR sar (1), -.BR top (1), -.BR ps (1), -.BR mpstat (1), -.BR iostat (1), -.BR vmstat (8) +.SH SEE ALSO +.BR "sar" "(1), " "top" "(1), " "ps" "(1), " "mpstat" "(1), " "iostat" "(1), " "vmstat" "(8)" +.PP .I https://github.com/sysstat/sysstat - +.br .I http://pagesperso-orange.fr/sebastien.godard/ diff --git a/man/sa1.in b/man/sa1.in index 831e2f5..5bf0a9a 100644 --- a/man/sa1.in +++ b/man/sa1.in @@ -1,67 +1,54 @@ -.TH SA1 8 "MAY 2020" Linux "Linux User's Manual" -*- nroff -*- +.\" sa1 manual page - (C) 1999-2020 Sebastien Godard (sysstat orange.fr) +.TH SA1 8 "JULY 2020" Linux "Linux User's Manual" -*- nroff -*- .SH NAME sa1 \- Collect and store binary data in the system activity daily data file. + .SH SYNOPSIS .B @SA_LIB_DIR@/sa1 [ --boot | --sleep | -.I interval -.I count +.I interval count .B ] + .SH DESCRIPTION -The -.B sa1 -command is a shell procedure variant of the -.B sadc +.RB "The " "sa1" +.RB "command is a shell procedure variant of the " "sadc" command and handles all of the flags and parameters of that command. The .B sa1 command collects and stores binary data in the current standard system activity daily data file. - +.PP The standard system activity daily data file is named -.I saDD -unless -.BR sadc 's -option -.B -D -is used, in which case its name is -.IR saYYYYMMDD , -where YYYY stands for the current year, MM for the current month -and DD for the current day. By default it is located in the +.IR "saDD " "unless" +.BR "sadc" "'s option " "-D " "is used, in which case its name is" +.IR "saYYYYMMDD" "," +.RI "where " "YYYY " "stands for the current year, " "MM " "for the current month and " "DD" +for the current day. By default it is located in the .I @SA_DIR@ directory. - -The -.I interval -and -.I count +.PP +.RI "The " "interval " "and " "count" parameters specify that the record should be written -.I count -times at -.I interval +.IR "count " "times at " "interval" seconds. If no arguments are given to .B sa1 then a single record is written. The .B sa1 -command is designed to be started automatically by the cron command. +command is designed to be started automatically by the +.BR "cron " "command." .SH OPTIONS -.IP --boot +.TP +.B --boot This option tells -.B sa1 -that the -.B sadc +.BR "sa1 " "that the " "sadc" command should be called without specifying the -.I interval -and -.I count +.IR "interval " "and " "count" parameters in order to insert a dummy record, marking the time when the counters restart from 0. -.IP --sleep -This option tells -.B sa1 -that the -.B sadc +.TP +.B --sleep +.RB "This option tells " "sa1 " "that the " "sadc" command should insert a comment indicating that the system is entering or leaving sleep mode (i.e. system suspend or hibernation). @@ -77,17 +64,15 @@ place the following entry in your root crontab file: .I @SA_DIR@/saYYYYMMDD .RS The standard system activity daily data files and their default location. -YYYY stands for the current year, MM for the current month and DD for the -current day. +.IR "YYYY " "stands for the current year, " "MM " "for the current month and " "DD" +for the current day. + .SH AUTHOR Sebastien Godard (sysstat orange.fr) -.SH SEE ALSO -.BR sar (1), -.BR sadc (8), -.BR sa2 (8), -.BR sadf (1), -.BR sysstat (5) +.SH SEE ALSO +.BR "sar" "(1), " "sadc" "(8), " "sa2" "(8), " "sadf" "(1), " "sysstat" "(5)" +.PP .I https://github.com/sysstat/sysstat - +.br .I http://pagesperso-orange.fr/sebastien.godard/ diff --git a/man/sa2.in b/man/sa2.in index 4f0212b..c4947ca 100644 --- a/man/sa2.in +++ b/man/sa2.in @@ -1,72 +1,56 @@ -.TH SA2 8 "JULY 2018" Linux "Linux User's Manual" -*- nroff -*- +.\" sa2 manual page - (C) 1999-2020 Sebastien Godard (sysstat orange.fr) +.TH SA2 8 "JULY 2020" Linux "Linux User's Manual" -*- nroff -*- .SH NAME sa2 \- Create a report from the current standard system activity daily data file. + .SH SYNOPSIS .B @SA_LIB_DIR@/sa2 + .SH DESCRIPTION -The -.B sa2 -command is a shell procedure variant of the -.B sar +.RB "The " "sa2 " "command is a shell procedure variant of the " "sar" command which writes a daily report in the -.I sarDD -or the -.I sarYYYYMMDD -file, where YYYY stands for the current year, MM for the current month -and DD for the current day. -By default the report is saved in the +.IR "sarDD " "or the " "sarYYYYMMDD " "file, where" +.IR "YYYY " "stands for the current year, " "MM " "for the current month and " "DD" +for the current day. By default the report is saved in the .I @SA_DIR@ -directory. -The +directory. The .B sa2 command will also remove reports more than one week old by default. -You can however keep reports for a longer (or a shorter) period by setting -the +You can however keep reports for a longer (or a shorter) period by setting the .B HISTORY environment variable. Read the -.BR sysstat (5) -manual page for details. - -The -.B sa2 -command accepts most of the flags and parameters of the -.B sar -command. - -The -.B sa2 -command is designed to be started automatically by the cron command. +.BR "sysstat" "(5) manual page for details." +.PP +.RB "The " "sa2 " "command accepts most of the flags and parameters of the " "sar " "command." +.PP +.RB "The " "sa2 " "command is designed to be started automatically by the " "cron " "command." .SH EXAMPLES -To run the -.B sa2 +.RB "To run the " "sa2" command daily, place the following entry in your root crontab file: .B 5 19 * * 1-5 @SA_LIB_DIR@/sa2 -A This will generate by default a daily report called -.I sarDD -in the +.IR "sarDD " "in the" .I @SA_DIR@ -directory, where the DD parameter is a number representing the day of the -month. +directory, where the +.IR "DD " "parameter is a number representing the day of the month." + .SH FILES .I @SA_DIR@/sarDD .br .I @SA_DIR@/sarYYYYMMDD .RS The standard system activity daily report files and their default location. -YYYY stands for the current year, MM for the current month and DD for the -current day. +.IR "YYYY " "stands for the current year, " "MM " "for the current month and " "DD " "for the current day." + .SH AUTHOR Sebastien Godard (sysstat orange.fr) -.SH SEE ALSO -.BR sar (1), -.BR sadc (8), -.BR sa1 (8), -.BR sadf (1), -.BR sysstat (5) +.SH SEE ALSO +.BR "sar" "(1), " "sadc" "(8), " "sa1" "(8), " "sadf" "(1), " "sysstat" "(5)" +.PP .I https://github.com/sysstat/sysstat - +.br .I http://pagesperso-orange.fr/sebastien.godard/ diff --git a/man/sadc.in b/man/sadc.in index 3abd50f..9a67153 100644 --- a/man/sadc.in +++ b/man/sadc.in @@ -1,48 +1,37 @@ -.TH SADC 8 "FEBRUARY 2019" Linux "Linux User's Manual" -*- nroff -*- +.\" sadc manual page - (C) 1999-2020 Sebastien Godard (sysstat orange.fr) +.TH SADC 8 "JULY 2020" Linux "Linux User's Manual" -*- nroff -*- .SH NAME sadc \- System activity data collector. + .SH SYNOPSIS .B @SA_LIB_DIR@/sadc [ -C .I comment -.B ] [ -D ] [ -F ] [ -f ] [ -L ] [ -V ] [ -S { keyword [,...] | ALL | XALL } ] [ -.I interval -.B [ -.I count -.B ] ] [ -.I outfile -.B ] +.BI "] [ -D ] [ -F ] [ -f ] [ -L ] [ -V ] [ -S { " "keyword" "[,...] | ALL | XALL } ] [" +.IB "interval " "[ " "count " "] ] [ " "outfile " "]" + .SH DESCRIPTION -The -.B sadc +.RB "The " "sadc" command samples system data a specified number of times -(\fIcount\fR) at a specified interval measured in seconds -(\fIinterval\fR). It writes in binary format to the specified -.I outfile -or to standard output. If -.I outfile -is set to -, then -.B sadc +.RI "(" "count" ") at a specified interval measured in seconds (" "interval" ")." +It writes in binary format to the specified +.IR "outfile " "or to standard output. If " "outfile" +.RB "is set to " "-" ", then " "sadc" uses the standard system activity daily data file (see below). In this case, if the file already exists, .B sadc -will overwrite it if it is from a previous month. -By default +will overwrite it if it is from a previous month. By default .B sadc collects most of the data available from the kernel. But there are also optional metrics, for which the relevant options must be explicitly passed to -.B sadc -to be collected (see option -S below). - +.BR "sadc " "to be collected (see option " "-S " "below)." +.PP The standard system activity daily data file is named -.I saDD -unless option +.IR "saDD " "unless option" .B -D is used, in which case its name is -.IR saYYYYMMDD , -where YYYY stands for the current year, MM for the current month -and DD for the current day. -By default it is located in the +.IR "saYYYYMMDD" ", where " "YYYY " "stands for the current year, " "MM " "for the current month and " "DD" +for the current day. By default it is located in the .I @SA_DIR@ directory. Yet it is possible to specify an alternate location for it: If @@ -50,69 +39,63 @@ it: If is a directory (instead of a plain file) then it will be considered as the directory where the standard system activity daily data file will be saved. - -When the -.I count +.PP +.RI "When the " "count" parameter is not specified, .B sadc -writes its data endlessly. -When both -.I interval -and -.I count -are not specified, and option -C is not used, -a dummy record, which is used at system startup to mark +writes its data endlessly. When both +.IR "interval " "and " "count" +are not specified, and option +.B -C +is not used, a dummy record, which is used at system startup to mark the time when the counter restarts from 0, will be written. For example, one of the system startup script may write the restart mark to the daily data file by the command entry: -.B "@SA_LIB_DIR@/sadc -" +.B @SA_LIB_DIR@/sadc - -The -.B sadc -command is intended to be used as a backend to the -.B sar -command. - -Note: The -.B sadc +.RB "The " "sadc " "command is intended to be used as a backend to the " "sar " "command." +.PP +.RB "Note: The " "sadc" command only reports on local activities. .SH OPTIONS -.IP "-C comment" +.TP +.BI "-C " "comment" When neither the -.I interval -nor the -.I count +.IR "interval " "nor the " "count" parameters are specified, this option tells .B sadc to write a dummy record containing the specified .I comment -string. -This comment can then be displayed with option -C of -.BR sar . -.IP -D -Use -.I saYYYYMMDD -instead of -.I saDD +string. This comment can then be displayed with option +.BR "-C " "of " "sar" "." +.TP +.B -D +.RI "Use " "saYYYYMMDD " "instead of " "saDD" as the standard system activity daily data file name. -.IP -F -The creation of -.I outfile +.TP +.B -F +.RI "The creation of " "outfile" will be forced. If the file already exists and has a format unknown to .B sadc then it will be truncated. This may be useful for daily data files created by an older version of .B sadc and whose format is no longer compatible with current one. -.IP -f +.TP +.B -f fdatasync() will be used to ensure data is written to disk. This differs from the normal operation in that a sudden system reset is less likely to -result in the saDD datafiles being corrupted. However, this is at the -expense of performance within the sadc process as forward progress will be +result in the +.I saDD +datafiles being corrupted. However, this is at the +expense of performance within the +.B sadc +process as forward progress will be blocked while data is written to underlying disk instead of just to cache. -.IP -L +.TP +.B -L .B sadc will try to get an exclusive lock on the .I outfile @@ -122,129 +105,101 @@ a header) record to an existing file, in which case .B sadc will try again at the next interval. Usually, the only reason a lock would fail would be if another -.B sadc -process were also writing to the file. This can happen when cron is used -to launch -.BR sadc . -If the system is under heavy load, an old -.B sadc -might still be running when cron starts a new one. Without locking, -this situation can result in a corrupted system activity file. -.IP "-S { keyword [,...] | ALL | XALL }" -Possible keywords are DISK, INT, IPV6, POWER, SNMP, XDISK, ALL, and XALL. - +.BR "sadc " "process were also writing to the file. This can happen when " "cron" +is used to launch +.BR "sadc" ". If the system is under heavy load, an old " "sadc" +might still be running when +.B cron +starts a new one. Without locking, this situation can result in a corrupted system +activity file. +.TP +.BI "-S { " "keyword" "[,...] | ALL | XALL }" +Possible keywords are +.BR "DISK" ", " "INT" ", " "IPV6" ", " "POWER" ", " "SNMP" ", " "XDISK" ", " "ALL " "and " "XALL" "." +.br Specify which optional activities should be collected by -.BR sadc . -Some activities are optional to prevent data files from growing too large. -The -.B DISK -keyword indicates that -.B sadc -should collect data for block devices. -The -.B INT -keyword indicates that -.B sadc -should collect data for system interrupts. -The -.B IPV6 -keyword indicates that IPv6 statistics should be -collected by -.BR sadc . -The -.B POWER -keyword indicates that -.B sadc -should collect power management statistics. -The -.B SNMP -keyword indicates that SNMP statistics should be -collected by -.BR sadc . -The -.B ALL -keyword is equivalent to specifying all the keywords above and therefore +.BR "sadc" "." +Some activities are optional to prevent data files from growing too large. The +.BR "DISK " "keyword indicates that " "sadc" +should collect data for block devices. The +.BR "INT " "keyword indicates that " "sadc" +should collect data for system interrupts. The +.BR "IPV6 " "keyword indicates that IPv6 statistics should be collected by " "sadc" ". The" +.BR "POWER " "keyword indicates that " "sadc" +should collect power management statistics. The +.BR "SNMP " "keyword indicates that SNMP statistics should be collected by " "sadc" ". The" +.BR "ALL " "keyword is equivalent to specifying all the keywords above and therefore" all previous activities are collected. - -The -.B XDISK -keyword is an extension to the -.B DISK +.IP +.RB "The " "XDISK " "keyword is an extension to the " "DISK" one and indicates that partitions and filesystems statistics should be collected by .B sadc in addition to disk statistics. This option works only with kernels 2.6.25 -and later. -The +and later. The .B XALL keyword is equivalent to specifying all the keywords above (including keyword extensions) and therefore all possible activities are collected. - +.IP Important note: The activities (including optional ones) saved in an existing -data file prevail over those selected with option -S. -As a consequence, appending data to an existing data file will result in -option -S being ignored. -.IP -V +data file prevail over those selected with option +.BR "-S" "." +As a consequence, appending data to an existing data file will result in option +.B -S +being ignored. +.TP +.B -V Print version number then exit. .SH ENVIRONMENT -The -.B sadc +.RB "The " "sadc" command takes into account the following environment variable: - -.IP S_TIME_DEF_TIME +.TP +.B S_TIME_DEF_TIME If this variable exists and its value is -.BR UTC -then -.B sadc +.BR "UTC " "then " "sadc" will save its data in UTC time. .B sadc will also use UTC time instead of local time to determine the current daily data file located in the .IR @SA_DIR@ directory. + .SH EXAMPLES +.TP .B @SA_LIB_DIR@/sadc 1 10 /tmp/datafile -.RS -Write 10 records of one second intervals to the /tmp/datafile binary file. -.RE +Write 10 records of one second intervals to the +.IR "/tmp/datafile " "binary file." +.TP +.B @SA_LIB_DIR@/sadc -C """Backup Start"" /tmp/datafile +Insert the comment "Backup Start" into the file +.IR "/tmp/datafile" "." -.B @SA_LIB_DIR@/sadc -C Backup_Start /tmp/datafile -.RS -Insert the comment Backup_Start into the file /tmp/datafile. -.RE .SH BUGS -The -.I /proc +.RI "The " "/proc" filesystem must be mounted for the -.B sadc -command to work. - +.BR "sadc " "command to work." +.PP All the statistics are not necessarily available, depending on the kernel version used. .B sadc assumes that you are using at least a 2.6 kernel. + .SH FILES .I @SA_DIR@/saDD .br .I @SA_DIR@/saYYYYMMDD .RS The standard system activity daily data files and their default location. -YYYY stands for the current year, MM for the current month and DD for the -current day. - +.IR "YYYY " "stands for the current year, " "MM " "for the current month and " "DD" +for the current day. .RE -.I /proc -and -.I /sys -contain various files with system statistics. +.IR "/proc " "and " "/sys " "contain various files with system statistics." + .SH AUTHOR Sebastien Godard (sysstat orange.fr) -.SH SEE ALSO -.BR sar (1), -.BR sa1 (8), -.BR sa2 (8), -.BR sadf (1), -.BR sysstat (5) +.SH SEE ALSO +.BR "sar" "(1), " "sa1" "(8), " "sa2" "(8), " "sadf" "(1), " "sysstat" "(5)" +.PP .I https://github.com/sysstat/sysstat - +.br .I http://pagesperso-orange.fr/sebastien.godard/ diff --git a/man/sadf.in b/man/sadf.in index 3777f0f..1bd5b7e 100644 --- a/man/sadf.in +++ b/man/sadf.in @@ -1,416 +1,355 @@ -.TH SADF 1 "APRIL 2020" Linux "Linux User's Manual" -*- nroff -*- +.\" sadf manual page - (C) 1999-2020 Sebastien Godard (sysstat orange.fr) +.TH SADF 1 "JULY 2020" Linux "Linux User's Manual" -*- nroff -*- .SH NAME sadf \- Display data collected by sar in multiple formats. + .SH SYNOPSIS .B sadf [ -C ] [ -c | -d | -g | -j | -l | -p | -r | -x ] [ -H ] [ -h ] [ -T | -t | -U ] [ -V ] [ -O -.I opts -.B [,...] ] [ -P { -.I cpu_list -.B | ALL } ] [ -s [ -.I hh:mm[:ss] -.B ] ] [ -e [ -.I hh:mm[:ss] -.B ] ] [ --dev= -.I dev_list -.B ] [ --fs= -.I fs_list -.B ] [ --iface= -.I iface_list -.B ] [ -- -.I sar_options -.B ] [ -.I interval -.B [ -.I count -.B ] ] [ -.I datafile -| -.I -[0-9]+ -.B ] +.IB "opts " "[,...] ] [ -P { " "cpu_list " "| ALL } ] [ -s [" +.IB "hh" ":" "mm" "[:" "ss" "] ] ] [ -e [" "hh" ":" "mm" "[:" "ss" "] ] ]" +.BI "[ --dev=" "dev_list " "] [ --fs=" "fs_list " "] [ --iface=" "iface_list" "] [ --" +.IB "sar_options " "] [ " "interval " "[ " "count " "] ] [ " "datafile " "| " "-[0-9]+ " "]" + .SH DESCRIPTION -The -.B sadf +.RB "The " "sadf" command is used for displaying the contents of data files created by the -.BR sar (1) -command. But unlike -.BR sar , -.B sadf +.BR "sar" "(1) command. But unlike " "sar" ", " "sadf" can write its data in many different formats (CSV, XML, etc.) The default format is one that can -easily be handled by pattern processing commands like awk (see option -p). -The -.B sadf -command can also be used to draw graphs for the various activities collected -by +easily be handled by pattern processing commands like +.BR "awk " "(see option " "-p" "). The " "sadf" +command can also be used to draw graphs for the various activities collected by .B sar and display them as SVG (Scalable Vector Graphics) graphics in your web browser -(see option -g). - -The -.B sadf +(see option +.BR "-g" ")." +.PP +.RB "The " "sadf" command extracts and writes to standard output records saved in the .I datafile file. This file must have been created by a version of -.B sar -which is compatible with that of -.B sadf. -If +.BR "sar " "which is compatible with that of " "sadf" ". If" .I datafile -is omitted, -.B sadf +.RB "is omitted, " "sadf" uses the standard system activity daily data file. -It is also possible to enter -1, -2 etc. as an argument to -.B sadf -to display data of that days ago. -For example, -1 will point at the standard system -activity file of yesterday. - +It is also possible to enter +.BR "-1" ", " "-2 " "etc. as an argument to " "sadf" +to display data of that days ago. For example, +.B -1 +will point at the standard system activity file of yesterday. +.PP The standard system activity daily data file is named -.I saDD -or -.IR saYYYYMMDD , -where YYYY stands for the current year, MM for the current month and -DD for the current day. +.IR "saDD " "or " "saYYYYMMDD" ", where" +.IR "YYYY " "stands for the current year, " "MM " "for the current month and " "DD" +for the current day. .B sadf will look for the most recent of -.I saDD -and -.IR saYYYYMMDD , +.IR "saDD " "and " "saYYYYMMDD" "," and use it. By default it is located in the .I @SA_DIR@ -directory. Yet it is possible to specify an alternate location for it: -If +directory. Yet it is possible to specify an alternate location for it: If .I datafile is a directory (instead of a plain file) then it will be considered as -the directory where the standard system activity daily data file is -located. - -The -.I interval -and -.I count -parameters are used to tell -.B sadf -to select -.I count -records at -.I interval -seconds apart. If the -.I count -parameter is not set, then all the records saved in the data file will be -displayed. - +the directory where the standard system activity daily data file is located. +.PP +.RI "The " "interval " "and " "count " "parameters are used to tell" +.BR "sadf " "to select" +.IR "count " "records at " "interval " "seconds apart. If the " "count" +parameter is not set, then all the records saved in the data file will be displayed. +.PP All the activity flags of .B sar may be entered on the command line to indicate which -activities are to be reported. Before specifying them, put a pair of -dashes (--) on the command line in order not to confuse the flags -with those of +activities are to be reported. Before specifying them, put a pair of dashes +.RB "(" "--" ")" +on the command line in order not to confuse the flags with those of .B sadf. Not specifying any flags selects only CPU activity. .SH OPTIONS -.IP -C -Tell -.B sadf -to display comments present in file. -.IP -c +.TP +.B -C +.RB "Tell " "sadf " "to display comments present in file." +.TP +.B -c Convert an old system activity binary datafile (version 9.1.6 and later) to current up-to-date format. Use the following syntax: -.B sadf -c old_datafile > new_datafile +.BI "sadf -c " "old_datafile " "> " "new_datafile" -Conversion can be controlled using option -O (see below). -.IP -d +Conversion can be controlled using option +.BR "-O " "(see below)." +.TP +.B -d Print the contents of the data file in a format that can easily be ingested by a relational database system. The output consists of fields separated by a semicolon. Each record contains the hostname of the host where the file was created, the interval value (or -1 if not applicable), the timestamp in a form easily acceptable by -most databases, and additional semicolon separated data fields as specified -by -.I sar_options -command line options. -Note that timestamp output can be controlled by options -T, -t and -U. -.IP --dev=dev_list +most databases, and additional semicolon separated data fields as specified by +.IR "sar_options " "command line options." +Note that timestamp output can be controlled by options +.BR "-T" ", " "-t " "and " "-U" "." +.TP +.BI "--dev=" "dev_list" Specify the block devices for which statistics are to be displayed by -.BR sadf . -.IR dev_list -is a list of comma-separated device names. Useful with option -d from -.BR sar . -.IP "-e [ hh:mm[:ss] ]" +.BR "sadf" "." +.I dev_list +is a list of comma-separated device names. Useful with option +.BR "-d " "from " "sar" "." +.TP +.BI "-e [ " "hh" ":" "mm" "[:" "ss" "] ]" Set the ending time of the report. The default ending time is 18:00:00. Hours must be given in 24-hour format. -.IP --fs=fs_list +.TP +.BI "--fs=" "fs_list" Specify the filesystems for which statistics are to be displayed by -.BR sadf . -.IR fs_list -is a list of comma-separated filesystem names or mountpoints. Useful with -option -F from -.BR sar . -.IP -g +.BR "sadf" "." +.I fs_list +is a list of comma-separated filesystem names or mountpoints. Useful with option +.BR "-F " "from " "sar" "." +.TP +.B -g Print the contents of the data file in SVG (Scalable Vector Graphics) format. This option enables you to display some fancy graphs in your web browser. Use the following syntax: -.B sadf -g your_datafile [ -- -.I sar_options -.B ] > output.svg +.BI "sadf -g " "your_datafile " "[ -- " "sar_options " "] > " "output.svg" and open the resulting SVG file in your favorite web browser. -Output can be controlled using option -O (see below). -.IP -H +Output can be controlled using option +.BR "-O " "(see below)." +.TP +.B -H Display only the header of the report (when applicable). If no format has been specified, then the header data (metadata) of the data file are displayed. -.IP -h -When used in conjunction with option -d, all activities -will be displayed horizontally on a single line. -.IP --iface=iface_list +.TP +.B -h +When used in conjunction with option +.BR "-d" ", all activities will be displayed horizontally on a single line." +.TP +.BI "--iface=" "iface_list" Specify the network interfaces for which statistics are to be displayed by -.BR sadf . -.IR iface_list -is a list of comma-separated interface names. Useful with options -n DEV and --n EDEV from -.BR sar . -.IP -j +.BR "sadf" "." +.I iface_list +is a list of comma-separated interface names. Useful with options +.BR "-n DEV " "and " "-n EDEV " "from " "sar" "." +.TP +.B -j Print the contents of the data file in JSON (JavaScript Object Notation) -format. Timestamps can be controlled by options -T and -t. -.IP -l +format. Timestamps can be controlled by options +.BR "-T " "and " "-t" "." +.TP +.B -l Export the contents of the data file to a PCP (Performance Co-Pilot) archive. The name of the archive can be specified using the keyword -.IR pcparchive= -with option -O. -.IP "-O opts [,...]" +.BR "pcparchive= " "with option " "-O" "." +.TP +.BI "-O " "opts" "[,...]" Use the specified options to control the output of -.BR sadf . +.BR "sadf" "." The following options are used to control SVG output displayed by -.BR "sadf -g": - -.B autoscale -.RS +.BR "sadf -g" ":" .RS +.IP autoscale Draw all the graphs of a given view as large as possible based on current view's scale. To do this, a factor (10, 100, 1000...) is used to enlarge the graph drawing. This option may be interesting when several graphs are drawn on the same view, some with only very small values, and others with high ones, the latter making the former hardly visible. -.RE - -.B bwcol -.RS +.IP bwcol Use a black and white palette to draw the graphs. -.RE - -.B customcol -.RS +.IP customcol Use a customizable color palette instead of the default one to draw the graphs. See environment variable .B S_COLORS_PALETTE below to know how to customize that palette. -.RE - -.BR height= value -.RS +.TP +.RI "height=" "value" Set SVG canvas height to -.IR value . -.RE - -.B oneday -.RS +.IR "value" "." +.IP oneday Display graphs data over a period of 24 hours. Note that hours are still -printed in UTC by default: You should use option -T to print them in local -time and get a time window starting from midnight. -.RE - -.B packed -.RS +printed in UTC by default: You should use option +.BR "-T " "to print them in local time" +and get a time window starting from midnight. +.IP packed Group all views from the same activity (and for the same device) on the same row. -.RE - -.B showidle -.RS +.IP showidle Also display %idle state in graphs for CPU statistics. -.RE - -.B showinfo -.RS +.IP showinfo Display additional information (such as the date and the host name) on each view. -.RE - -.B showtoc -.RS +.IP showtoc Add a table of contents at the beginning of the SVG output, consisting of links pointing at the first graph of each activity. -.RE - -.B skipempty -.RS +.IP skipempty Do not display views where all graphs have only zero values. .RE - +.IP The following option may be used when converting an old system activity binary datafile to current up-to-date format: - -.BR hz= value .RS +.TP +.RI "hz=" "value" Specify the number of ticks per second for the machine where the old datafile has been created. .RE - +.IP The following option may be used when data are exported to a PCP archive: - -.BR pcparchive= name .RS +.TP +.RI "pcparchive=" "name" Specify the name of the PCP archive to create. .RE - +.IP The following option is used to control raw output displayed by -.BR "sadf -r": - -.B debug +.BR "sadf -r" ":" .RS +.IP debug Display additional information, mainly useful for debugging purpose. .RE -.RE -.IP "-P { cpu_list | ALL }" -Tell -.B sadf +.TP +.BI "-P { " "cpu_list " "| ALL }" +.RB "Tell " "sadf" that processor dependent statistics are to be reported only for the specified processor or processors. .I cpu_list is a list of comma-separated values or range of values (e.g., -.BR 0,2,4-7,12- ). +.BR "0,2,4-7,12-" ")." Note that processor 0 is the first processor, and processor -.B all -is the global average among all processors. -Specifying the -.B ALL +.BR "all " "is the global average among all processors. Specifying the " "ALL" keyword reports statistics for each individual processor, and globally for all processors. -.IP -p +.TP +.B -p Print the contents of the data file in a format that can -easily be handled by pattern processing commands like awk. +easily be handled by pattern processing commands like +.BR "awk" "." The output consists of fields separated by a tab. Each record contains the hostname of the host where the file was created, the interval value -(or -1 if not applicable), the timestamp, -the device name (or - if not applicable), +(or -1 if not applicable), the timestamp, the device name (or - if not applicable), the field name and its value. -Note that timestamp output can be controlled by options -T, -t and -U. -.IP -r +Note that timestamp output can be controlled by options +.BR "-T" ", " "-t " "and " "-U" "." +.TP +.B -r Print the raw contents of the data file. With this format, the values for all the counters are displayed as read from the kernel, which means e.g., that no average values are calculated over the elapsed time interval. -Output can be controlled using option -O (see above). -.IP "-s [ hh:mm[:ss] ]" +Output can be controlled using option +.BR "-O " "(see above)." +.TP +.BI "-s [ " "hh" ":" "mm" "[:" "ss" "] ]" Set the starting time of the data, causing the .B sadf command to extract records time-tagged at, or following, the time specified. The default starting time is 08:00:00. Hours must be given in 24-hour format. -.IP -T +.TP +.B -T Display timestamp in local time instead of UTC (Coordinated Universal Time). -.IP -t +.TP +.B -t Display timestamp in the original local time of the data file creator instead of UTC (Coordinated Universal Time). -.IP -U -Display timestamp (UTC - Coordinated Universal Time) in seconds from -the epoch. -.IP -V +.TP +.B -U +Display timestamp (UTC - Coordinated Universal Time) in seconds from the epoch. +.TP +.B -V Print version number then exit. -.IP -x +.TP +.B -x Print the contents of the data file in XML format. -Timestamps can be controlled by options -T and -t. -The corresponding -DTD (Document Type Definition) and XML Schema are included in the sysstat -source package. They are also available at -.I http://pagesperso-orange.fr/sebastien.godard/download.html +Timestamps can be controlled by options +.BR "-T " "and " "-t" "." +The corresponding DTD (Document Type Definition) and XML Schema are included +in the sysstat source package. They are also available at +.IR "http://pagesperso-orange.fr/sebastien.godard/download.html" "." .SH ENVIRONMENT -The -.B sadf +.RB "The " "sadf" command takes into account the following environment variables: - -.IP S_COLORS_PALETTE +.TP +.B S_COLORS_PALETTE Specify the colors used by .B sadf -g to render the SVG output. This environment variable is taken into account only when the custom color palette has been selected with the option -.IR customcol -(see option -O). Its value is a colon-separated list of capabilities associated +.BR "customcol " "(see option " "-O" ")." +Its value is a colon-separated list of capabilities associated with six-digit, three-byte hexadecimal numbers (hex triplets) representing colors that defaults to -.BR 0=000000:1=1a1aff:2=1affb2:3=b21aff:4=1ab2ff:5=ff1a1a:6=ffb31a:7=b2ff1a: +.B 0=000000:1=1a1aff:2=1affb2:3=b21aff: .br -.BR 8=efefef:9=000000:A=1a1aff:B=1affb2:C=b21aff:D=1ab2ff:E=ff1a1a:F=ffb31a: +.B 4=1ab2ff:5=ff1a1a:6=ffb31a:7=b2ff1a: .br -.BR G=bebebe:H=000000:I=000000:K=ffffff:L=000000:T=000000:W=000000:X=000000 +.B 8=efefef:9=000000:A=1a1aff:B=1affb2: +.br +.B C=b21aff:D=1ab2ff:E=ff1a1a:F=ffb31a: +.br +.B G=bebebe:H=000000:I=000000:K=ffffff: +.br +.B L=000000:T=000000:W=000000:X=000000 -Capabilities consisting of an hexadecimal digit (0 through F) are used to specify +Capabilities consisting of an hexadecimal digit +.RB "(" "0 " "through " "F" ") are used to specify" the first sixteen colors in the palette (these colors are used to draw the graphs), e.g., 3=ffffff would indicate that the third color in the palette is white (0xffffff). +.br Other capabilities are: - .RS .TP .B G= Specify the color used to draw the grid lines. - .TP .B H= Specify the color used to display the report header. - .TP .B I= Specify the color used to display additional information (e.g., date, hostname...) - .TP .B K= Specify the color used for the graphs background. - .TP .B L= Specify the default color (which is for example used to display the table of contents). - .TP .B T= Specify the color used to display the graphs title. - .TP .B W= Specify the color used to display warning and error messages. - .TP .B X= Specify the color used to draw the axes and display the graduations. .RE - -.IP S_TIME_DEF_TIME +.TP +.B S_TIME_DEF_TIME If this variable exists and its value is -.BR UTC -then -.B sadf +.BR "UTC " "then " "sadf" will use UTC time instead of local time to determine the current daily data file located in the .IR @SA_DIR@ directory. + .SH EXAMPLES +.TP .B sadf -d @SA_DIR@/sa21 -- -r -n DEV -.RS -Extract memory and network statistics from system activity -file 'sa21', and display them in a format that can be ingested by a -database. -.RE - +Extract memory and network statistics from system activity file +.IR "sa21" "," +and display them in a format that can be ingested by a database. +.TP .B sadf -p -P 1 -.RS Extract CPU statistics for processor 1 (the second processor) from current daily data file, and display them in a format that can easily be handled by a pattern processing command. -.RE .SH BUGS -SVG output (as created by option -g) is fully compliant with SVG 1.1 standard. +SVG output (as created by option +.BR "-g" ")" +is fully compliant with SVG 1.1 standard. Graphics have been successfully displayed in various web browsers, including Firefox, Chrome and Opera. Yet SVG rendering is broken on Microsoft browsers (tested on Internet Explorer 11 and Edge 13.1): So please don't use them. @@ -421,19 +360,16 @@ Firefox, Chrome and Opera. Yet SVG rendering is broken on Microsoft browsers .I @SA_DIR@/saYYYYMMDD .RS The standard system activity daily data files and their default location. -YYYY stands for the current year, MM for the current month and DD for the -current day. - +.IR "YYYY " "stands for the current year, " "MM " "for the current month and " "DD" +for the current day. .RE + .SH AUTHOR Sebastien Godard (sysstat orange.fr) -.SH SEE ALSO -.BR sar (1), -.BR sadc (8), -.BR sa1 (8), -.BR sa2 (8), -.BR sysstat (5) +.SH SEE ALSO +.BR "sar" "(1), " "sadc" "(8), " "sa1" "(8), " "sa2" "(8), " "sysstat" "(5)" +.PP .I https://github.com/sysstat/sysstat - +.br .I http://pagesperso-orange.fr/sebastien.godard/ diff --git a/man/sar.in b/man/sar.in index 642ba89..b923b2e 100644 --- a/man/sar.in +++ b/man/sar.in @@ -1,138 +1,99 @@ +.\" sar manual page - (C) 1999-2020 Sebastien Godard (sysstat orange.fr) .TH SAR 1 "JULY 2020" Linux "Linux User's Manual" -*- nroff -*- .SH NAME sar \- Collect, report, or save system activity information. + .SH SYNOPSIS .B sar [ -A ] [ -B ] [ -b ] [ -C ] [ -D ] [ -d ] [ -F [ MOUNT ] ] [ -H ] [ -h ] [ -p ] .B [ -r [ ALL ] ] [ -S ] [ -t ] [ -u [ ALL ] ] [ -V ] [ -v ] [ -W ] [ -w ] [ -y ] [ -z ] -.B [ --dec={ 0 | 1 | 2 } ] [ --dev= -.I dev_list -.B ] [ --fs= -.I fs_list -.B ] [ --help ] [ --human ] [ --iface= -.I iface_list -.B ] [ --pretty ] [ --sadc ] -.B [ -I { -.I int_list -.B | SUM | ALL } ] [ -P { -.I cpu_list -.B | ALL } ] -.B [ -m { -.I keyword -.B [,...] | ALL } ] -.B [ -n { -.I keyword -.B [,...] | ALL } ] -.B [ -q [ -.I keyword -.B [,...] | ALL ] ] +.B [ --dec={ 0 | 1 | 2 } ] +.BI "[ --dev=" "dev_list " "] [ --fs=" "fs_list " "] [ --help ] [ --human ] [ --iface=" "iface_list" +.BI "] [ --pretty ] [ --sadc ] [ -I { " "int_list " "| SUM | ALL } ] [ -P { " "cpu_list" +.B | ALL } ] [ -m { +.IB "keyword" "[,...] | ALL } ] [ -n { " "keyword" "[,...] | ALL } ] [ -q [ " "keyword" "[,...] | ALL ] ]" .B [ -j { SID | ID | LABEL | PATH | UUID | ... } ] -.B [ -f [ -.I filename -.B ] | -o [ -.I filename -.B ] | -[0-9]+ ] -.B [ -i -.I interval -.B ] [ -s [ -.I hh:mm[:ss] -.B ] ] [ -e [ -.I hh:mm[:ss] -.B ] ] [ -.I interval -.B [ -.I count -.B ] ] +.BI "[ -f [ " "filename " "] | -o [ " "filename " "] | -[0-9]+ ]" +.BI "[ -i " "interval " "] [ -s [ " "hh" ":" "mm" "[:" "ss" "]" +.BI "] ] [ -e [ " "hh" ":" "mm" "[:" "ss" "] ] ] [ " "interval " "[ " "count " "] ]" + .SH DESCRIPTION -The -.B sar +.RB "The " "sar" command writes to standard output the contents of selected cumulative activity counters in the operating system. The accounting system, based on the values in the -.I count -and -.I interval +.IR "count " "and " "interval" parameters, writes information the specified number of times spaced at the specified intervals in seconds. If the -.I interval -parameter is set to zero, the +.IR "interval " "parameter is set to zero, the" .B sar command displays the average statistics for the time since the system was started. If the -.I interval -parameter is specified without the -.I count +.IR "interval " "parameter is specified without the " "count" parameter, then reports are generated continuously. The collected data can also -be saved in the file specified by the -o -.I filename +be saved in the file specified by the +.BI "-o " "filename" flag, in addition to being displayed onto the screen. If -.I filename -is omitted, +.IR "filename " "is omitted," .B sar uses the standard system activity daily data file (see below). By default all the data available from the kernel are saved in the data file. - -The -.B sar +.PP +.RB "The " "sar" command extracts and writes to standard output records previously saved in a file. This file can be either the one specified by the --f flag or, by default, the standard system activity daily data file. -It is also possible to enter -1, -2 etc. as an argument to -.B sar -to display data -of that days ago. For example, -1 will point at the standard system -activity file of yesterday. - +.B -f +flag or, by default, the standard system activity daily data file. +It is also possible to enter +.BR "-1" ", " "-2 " "etc. as an argument to " "sar" +to display data of that days ago. For example, +.BR "-1 " "will point at the standard system activity file of yesterday." +.PP Standard system activity daily data files are named -.I saDD -or -.IR saYYYYMMDD , -where YYYY stands for the current year, MM for the current month and -DD for the current day. They are the default files used by +.IR "saDD " "or " "saYYYYMMDD" ", where" +.IR "YYYY " "stands for the current year, " "MM " "for the current month and " "DD" +for the current day. They are the default files used by .B sar only when no filename has been explicitly specified. -When used to write data to files (with its option -o), -.B sar +When used to write data to files (with its option +.BR "-o" "), " "sar" will use .I saYYYYMMDD -if option -D has also been specified, else it will use -.IR saDD . +.RB "if option " "-D" +has also been specified, else it will use +.IR "saDD" "." When used to display the records previously saved in a file, .B sar will look for the most recent of -.I saDD -and -.IR saYYYYMMDD , -and use it. - +.IR "saDD " "and " "saYYYYMMDD" ", and use it." +.PP Standard system activity daily data files are located in the .I @SA_DIR@ directory by default. Yet it is possible to specify an alternate location for them: If a directory (instead of a plain file) is used -with options -f or -o +with options +.BR "-f " "or " "-o" then it will be considered as the directory containing the data files. - -Without the -P flag, the -.B sar +.PP +.RB "Without the " "-P " "flag, the " "sar" command reports system-wide (global among all processors) statistics, which are calculated as averages for values expressed as percentages, -and as sums otherwise. If the -P -flag is given, the -.B sar +and as sums otherwise. If the +.BR "-P " "flag is given, the " "sar" command reports activity which relates to the specified processor or -processors. If -P ALL -is given, the -.B sar +processors. If +.BR "-P ALL " "is given, the " "sar" command reports statistics for each individual processor and global statistics among all processors. Offline processors are not displayed. - +.PP You can select information about specific system activities using flags. Not specifying any flags selects only CPU activity. -Specifying the -A +Specifying the +.B -A flag selects all possible activities. - +.PP The default version of the .B sar command (CPU utilization report) might be one of the first facilities @@ -142,95 +103,58 @@ monitors major system resources. If CPU utilization is near 100 percent If multiple samples and multiple reports are desired, it is convenient to specify an output file for the -.B sar -command. -Run the -.B sar +.BR "sar " "command. Run the " "sar" command as a background process. The syntax for this is: -.B sar -o datafile interval count >/dev/null 2>&1 & +.BI "sar -o " "datafile interval count " ">/dev/null 2>&1 &" -All data are captured in binary form and saved to a file (datafile). +All data are captured in binary form and saved to a file +.RI "(" "datafile" ")." The data can then be selectively displayed with the -.B sar -command using the -f -option. Set the -.I interval -and -.I count -parameters to select -.I count -records at -.I interval -second intervals. If the -.I count -parameter is not set, all the records saved in the -file will be selected. +.BR "sar " "command using the " "-f " "option. Set the" +.IR "interval " "and " "count " "parameters to select " "count " "records at " "interval" +.RI "second intervals. If the " "count" +parameter is not set, all the records saved in the file will be selected. Collection of data in this manner is useful to characterize system usage over a period of time and determine peak usage hours. - -Note: The -.B sar +.PP +.RB "Note: The " "sar" command only reports on local activities. .SH OPTIONS -.IP -A +.TP +.B -A This is equivalent to specifying -.BR "-bBdFHSvwWy -I SUM -m ALL -n ALL -q ALL -r ALL -u ALL". +.BR "-bBdFHSvwWy -I SUM -m ALL -n ALL -q ALL -r ALL -u ALL" "." This option also implies specifying -.BR "-I ALL -P ALL" +.B -I ALL -P ALL unless these options are explicitly set on the command line. -.IP -B +.TP +.B -B Report paging statistics. The following values are displayed: - -.B pgpgin/s -.RS .RS +.IP pgpgin/s Total number of kilobytes the system paged in from disk per second. -.RE - -.B pgpgout/s -.RS +.IP pgpgout/s Total number of kilobytes the system paged out to disk per second. -.RE - -.B fault/s -.RS +.IP fault/s Number of page faults (major + minor) made by the system per second. This is not a count of page faults that generate I/O, because some page faults can be resolved without I/O. -.RE - -.B majflt/s -.RS +.IP majflt/s Number of major faults the system has made per second, those which have required loading a memory page from disk. -.RE - -.B pgfree/s -.RS +.IP pgfree/s Number of pages placed on the free list by the system per second. -.RE - -.B pgscank/s -.RS +.IP pgscank/s Number of pages scanned by the kswapd daemon per second. -.RE - -.B pgscand/s -.RS +.IP pgscand/s Number of pages scanned directly per second. -.RE - -.B pgsteal/s -.RS +.IP pgsteal/s Number of pages the system has reclaimed from cache (pagecache and swapcache) per second to satisfy its memory demands. -.RE - -.B %vmeff -.RS +.IP %vmeff Calculated as pgsteal / pgscan, this is a metric of the efficiency of page reclaim. If it is near 100% then almost every page coming off the tail of the inactive list is being reaped. If it gets too low (e.g. less @@ -238,1073 +162,667 @@ than 30%) then the virtual memory is having some difficulty. This field is displayed as zero if no pages have been scanned during the interval of time. .RE -.RE -.IP -b -Report I/O and transfer rate statistics. -The following values are displayed: - -.B tps -.RS +.TP +.B -b +Report I/O and transfer rate statistics. The following values are displayed: .RS +.IP tps Total number of transfers per second that were issued to physical devices. A transfer is an I/O request to a physical device. Multiple logical requests can be combined into a single I/O request to the device. A transfer is of indeterminate size. -.RE - -.B rtps -.RS +.IP rtps Total number of read requests per second issued to physical devices. -.RE - -.B wtps -.RS +.IP wtps Total number of write requests per second issued to physical devices. -.RE - -.B dtps -.RS +.IP dtps Total number of discard requests per second issued to physical devices. -.RE - -.B bread/s -.RS +.IP bread/s Total amount of data read from the devices in blocks per second. -Blocks are equivalent to sectors -and therefore have a size of 512 bytes. -.RE - -.B bwrtn/s -.RS +Blocks are equivalent to sectors and therefore have a size of 512 bytes. +.IP bwrtn/s Total amount of data written to devices in blocks per second. -.RE - -.B bdscd/s -.RS +.IP bdscd/s Total amount of data discarded for devices in blocks per second. .RE -.RE -.IP -C +.TP +.B -C When reading data from a file, tell -.B sar -to display comments that have been inserted by -.BR sadc . -.IP -D -Use -.I saYYYYMMDD -instead of -.I saDD +.BR "sar " "to display comments that have been inserted by " "sadc" "." +.TP +.B -D +.RI "Use " "saYYYYMMDD " "instead of " "saDD" as the standard system activity daily data file name. This option -works only when used in conjunction with option -o -to save data to file. -.IP -d +works only when used in conjunction with option +.BR "-o " "to save data to file." +.TP +.B -d Report activity for each block device. When data are displayed, the device name is displayed as it (should) appear in -.IR /dev . -Persistent device names can also be printed if option -j is used -(see below). Statistics for all devices are displayed unless +.IR "/dev" "." +Persistent device names can also be printed if option +.B -j +is used (see below). Statistics for all devices are displayed unless a restricted list is specified using option -.BR --dev= +.B --dev= (see corresponding option entry). Note that disk activity depends on -.B sadc -options -.B "-S DISK" -and -.B "-S XDISK" +.BR "sadc" "'s options " "-S DISK " "and " "-S XDISK" to be collected. The following values are displayed: - -.B tps -.RS .RS +.IP tps Total number of transfers per second that were issued to physical devices. A transfer is an I/O request to a physical device. Multiple logical requests can be combined into a single I/O request to the device. A transfer is of indeterminate size. -.RE - -.B rkB/s -.RS +.IP rkB/s Number of kilobytes read from the device per second. -.RE - -.B wkB/s -.RS +.IP wkB/s Number of kilobytes written to the device per second. -.RE - -.B dkB/s -.RS +.IP dkB/s Number of kilobytes discarded for the device per second. -.RE - -.B areq-sz -.RS +.IP areq-sz The average size (in kilobytes) of the I/O requests that were issued to the device. .br Note: In previous versions, this field was known as avgrq-sz and was expressed in sectors. -.RE - -.B aqu-sz -.RS +.IP aqu-sz The average queue length of the requests that were issued to the device. .br Note: In previous versions, this field was known as avgqu-sz. -.RE - -.B await -.RS +.IP await The average time (in milliseconds) for I/O requests issued to the device to be served. This includes the time spent by the requests in queue and the time spent servicing them. -.RE - -.B %util -.RS +.IP %util Percentage of elapsed time during which I/O requests were issued to the device (bandwidth utilization for the device). Device saturation occurs when this value is close to 100% for devices serving requests serially. But for devices serving requests in parallel, such as RAID arrays and modern SSDs, this number does not reflect their performance limits. .RE -.RE -.IP "--dec={ 0 | 1 | 2 }" +.TP +.B --dec={ 0 | 1 | 2 } Specify the number of decimal places to use (0 to 2, default value is 2). -.IP --dev=dev_list +.TP +.BI "--dev=" "dev_list" Specify the block devices for which statistics are to be displayed by -.BR sar . -.IR dev_list -is a list of comma-separated device names. -.IP "-e [ hh:mm[:ss] ]" +.BR "sar" "." +.IR "dev_list " "is a list of comma-separated device names." +.TP +.BI "-e [ " "hh" ":" "mm" "[:" "ss" "] ]" Set the ending time of the report. The default ending time is 18:00:00. Hours must be given in 24-hour format. This option can be used when data are read from -or written to a file (options -f or -o). -.IP "-F [ MOUNT ]" +or written to a file (options +.BR "-f " "or " "-o" ")." +.TP +.B -F [ MOUNT ] Display statistics for currently mounted filesystems. Pseudo-filesystems are ignored. At the end of the report, .B sar -will display a summary of all those filesystems. -Use of the +will display a summary of all those filesystems. Use of the .B MOUNT parameter keyword indicates that mountpoint will be reported instead of filesystem device. Statistics for all filesystems are displayed unless a restricted list is specified using option -.BR --fs= +.B --fs= (see corresponding option entry). Note that filesystems statistics depend on -.B sadc -option -.B "-S XDISK" +.BR "sadc" "'s option " "-S XDISK " to be collected. The following values are displayed: - -.B MBfsfree -.RS .RS +.IP MBfsfree Total amount of free space in megabytes (including space available only to privileged user). -.RE - -.B MBfsused -.RS +.IP MBfsused Total amount of space used in megabytes. -.RE - -.B %fsused -.RS +.IP %fsused Percentage of filesystem space used, as seen by a privileged user. -.RE - -.B %ufsused -.RS +.IP %ufsused Percentage of filesystem space used, as seen by an unprivileged user. -.RE - -.B Ifree -.RS +.IP Ifree Total number of free file nodes in filesystem. -.RE - -.B Iused -.RS +.IP Iused Total number of file nodes used in filesystem. -.RE - -.B %Iused -.RS +.IP %Iused Percentage of file nodes used in filesystem. .RE -.RE -.IP "-f [ filename ]" -Extract records from -.I filename -(created by the -o -.I filename +.TP +.BI "-f [ " "filename " "]" +.RI "Extract records from " "filename " "(created by the" +.BI "-o " "filename" flag). The default value of the .I filename -parameter is the current standard system activity daily data file. -If +parameter is the current standard system activity daily data file. If .I filename is a directory instead of a plain file then it is considered as the directory where the standard system activity daily data files are -located. The -f option is exclusive of the -o option. -.IP --fs=fs_list +located. Option +.BR "-f " "is exclusive of option " "-o" "." +.TP +.BI "--fs=" "fs_list" Specify the filesystems for which statistics are to be displayed by -.BR sar . -.IR fs_list +.BR "sar" "." +.I fs_list is a list of comma-separated filesystem names or mountpoints. -.IP -H +.TP +.B -H Report hugepages utilization statistics. The following values are displayed: - -.B kbhugfree -.RS .RS +.IP kbhugfree Amount of hugepages memory in kilobytes that is not yet allocated. -.RE - -.B kbhugused -.RS +.IP kbhugused Amount of hugepages memory in kilobytes that has been allocated. -.RE - -.B %hugused -.RS +.IP %hugused Percentage of total hugepages memory that has been allocated. -.RE - -.B kbhugrsvd -.RS +.IP kbhugrsvd Amount of reserved hugepages memory in kilobytes. -.RE - -.B kbhugsurp -.RS +.IP kbhugsurp Amount of surplus hugepages memory in kilobytes. .RE -.RE -.IP -h +.TP +.B -h This option is equivalent to specifying -.BR "--pretty --human" . -.IP --help +.BR "--pretty --human" "." +.TP +.B --help Display a short help message then exit. -.IP --human +.TP +.B --human Print sizes in human readable format (e.g. 1.0k, 1.2M, etc.) The units displayed with this option supersede any other default units (e.g. kilobytes, sectors...) associated with the metrics. -.IP "-I { int_list | SUM | ALL }" +.TP +.BI "-I { " "int_list " "| SUM | ALL }" Report statistics for interrupts. .I int_list is a list of comma-separated values or range of values (e.g., -.BR 0-16,35,400- ). -The -.B SUM +.BR "0-16,35,400-" "). The " "SUM" keyword indicates that the total number of interrupts received per second is to be displayed. The .B ALL keyword indicates that statistics from all interrupts, including potential APIC interrupt sources, are to be reported. Note that interrupt statistics depend on -.B sadc -option "-S INT" +.BR "sadc" "'s option " "-S INT" to be collected. -.IP "-i interval" +.TP +.BI "-i " "interval" Select data records at seconds as close as possible to the number specified -by the -.I interval -parameter. -.IP --iface=iface_list +.RI "by the " "interval " "parameter." +.TP +.BI "--iface=" "iface_list" Specify the network interfaces for which statistics are to be displayed by -.BR sar . -.IR iface_list +.BR "sar" "." +.I iface_list is a list of comma-separated interface names. -.IP "-j { SID | ID | LABEL | PATH | UUID | ... }" -Display persistent device names. Use this option in conjunction with option -d. -Options -.BR ID , -.BR LABEL , -etc. specify the type of the persistent name. These options are not limited, +.TP +.B -j { SID | ID | LABEL | PATH | UUID | ... } +Display persistent device names. Use this option in conjunction with option +.BR "-d" ". Keywords " "ID" ", " "LABEL" "," +etc. specify the type of the persistent name. These keywords are not limited, only prerequisite is that directory with required persistent names is present in -.IR /dev/disk . -Option -.BR SID +.IR "/dev/disk" "." +.RB "Keyword " "SID" tries to get a stable identifier to use as the device name. A stable identifier won't change across reboots for the same physical device. If it exists, this identifier is normally the WWN (World Wide Name) of the device, as read from the -.IR /dev/disk/by-id -directory. -.IP "-m { keyword [,...] | ALL }" +.IR "/dev/disk/by-id " "directory." +.TP +.BI "-m { " "keyword" "[,...] | ALL }" Report power management statistics. Note that these statistics depend on -.BR sadc 's -option "-S POWER" to be collected. +.BR "sadc" "'s option " "-S POWER " "to be collected." Possible keywords are -.BR CPU , -.BR FAN , -.BR FREQ , -.BR IN , -.BR TEMP -and -.BR USB . +.BR "CPU" ", " "FAN" ", " "FREQ" ", " "IN" ", " "TEMP " "and " "USB" "." -With the -.B CPU +.RB "With the " "CPU" keyword, statistics about CPU are reported. The following value is displayed: - -.B MHz -.RS .RS +.IP MHz Instantaneous CPU clock frequency in MHz. .RE -With the -.B FAN +.IP +.RB "With the " "FAN" keyword, statistics about fans speed are reported. The following values are displayed: - -.B rpm .RS +.IP rpm Fan speed expressed in revolutions per minute. -.RE - -.B drpm -.RS +.IP drpm This field is calculated as the difference between current fan speed (rpm) and its low limit (fan_min). -.RE - -.B DEVICE -.RS +.IP DEVICE Sensor device name. .RE -With the -.B FREQ +.IP +.RB "With the " "FREQ" keyword, statistics about CPU clock frequency are reported. The following value is displayed: - -.B wghMHz .RS +.IP wghMHz Weighted average CPU clock frequency in MHz. Note that the cpufreq-stats driver must be compiled in the kernel for this option to work. .RE -With the -.B IN +.IP +.RB "With the " "IN" keyword, statistics about voltage inputs are reported. The following values are displayed: - -.B inV .RS +.IP inV Voltage input expressed in Volts. -.RE - -.B %in -.RS +.IP %in Relative input value. A value of 100% means that voltage input has reached its high limit (in_max) whereas a value of 0% means that it has reached its low limit (in_min). -.RE - -.B DEVICE -.RS +.IP DEVICE Sensor device name. .RE -With the -.B TEMP +.IP +.RB "With the " "TEMP" keyword, statistics about devices temperature are reported. The following values are displayed: - -.B degC .RS +.IP degC Device temperature expressed in degrees Celsius. -.RE - -.B %temp -.RS +.IP %temp Relative device temperature. A value of 100% means that temperature has reached its high limit (temp_max). -.RE - -.B DEVICE -.RS +.IP DEVICE Sensor device name. .RE -With the -.B USB -keyword, the -.B sar +.IP +.RB "With the " "USB " "keyword, the " "sar" command takes a snapshot of all the USB devices currently plugged into the system. At the end of the report, .B sar will display a summary of all those USB devices. The following values are displayed: - -.B BUS .RS +.IP BUS Root hub number of the USB device. -.RE - -.B idvendor -.RS +.IP idvendor Vendor ID number (assigned by USB organization). -.RE - -.B idprod -.RS +.IP idprod Product ID number (assigned by Manufacturer). -.RE - -.B maxpower -.RS +.IP maxpower Maximum power consumption of the device (expressed in mA). -.RE - -.B manufact -.RS +.IP manufact Manufacturer name. -.RE - -.B product -.RS +.IP product Product name. .RE -The -.B ALL +.IP +.RB "The " "ALL" keyword is equivalent to specifying all the keywords above and therefore all the power management statistics are reported. -.RE -.RE -.IP "-n { keyword [,...] | ALL }" +.TP +.BI "-n { " "keyword" "[,...] | ALL }" Report network statistics. Possible keywords are -.BR DEV , -.BR EDEV , -.BR FC , -.BR ICMP , -.BR EICMP , -.BR ICMP6 , -.BR EICMP6 , -.BR IP , -.BR EIP , -.BR IP6 , -.BR EIP6 , -.BR NFS , -.BR NFSD , -.BR SOCK , -.BR SOCK6 , -.BR SOFT , -.BR TCP , -.BR ETCP , -.BR UDP -and -.BR UDP6 . +.BR "DEV" ", " "EDEV" ", " "FC" ", " "ICMP" ", " "EICMP" ", " "ICMP6" ", " "EICMP6" "," +.BR "IP" ", " "EIP" ", " "IP6" ", " "EIP6" ", " "NFS" ", " "NFSD" ", " "SOCK" ", " "SOCK6" "," +.BR "SOFT" ", " "TCP" ", " "ETCP" ", " "UDP " "and " "UDP6" "." -With the -.B DEV +.RB "With the " "DEV" keyword, statistics from the network devices are reported. Statistics for all network interfaces are displayed unless a restricted list is specified using option -.BR --iface= +.B --iface= (see corresponding option entry). The following values are displayed: - -.B IFACE -.RS .RS +.IP IFACE Name of the network interface for which statistics are reported. -.RE - -.B rxpck/s -.RS +.IP rxpck/s Total number of packets received per second. -.RE - -.B txpck/s -.RS +.IP txpck/s Total number of packets transmitted per second. -.RE - -.B rxkB/s -.RS +.IP rxkB/s Total number of kilobytes received per second. -.RE - -.B txkB/s -.RS +.IP txkB/s Total number of kilobytes transmitted per second. -.RE - -.B rxcmp/s -.RS +.IP rxcmp/s Number of compressed packets received per second (for cslip etc.). -.RE - -.B txcmp/s -.RS +.IP txcmp/s Number of compressed packets transmitted per second. -.RE - -.B rxmcst/s -.RS +.IP rxmcst/s Number of multicast packets received per second. -.RE - -.B %ifutil -.RS +.IP %ifutil Utilization percentage of the network interface. For half-duplex interfaces, utilization is calculated using the sum of rxkB/s and txkB/s as a percentage of the interface speed. For full-duplex, this is the greater of rxkB/S or txkB/s. .RE -With the -.B EDEV +.IP +.RB "With the " "EDEV" keyword, statistics on failures (errors) from the network devices are reported. Statistics for all network interfaces are displayed unless a restricted list is specified using option -.BR --iface= +.B --iface= (see corresponding option entry). The following values are displayed: - -.B IFACE .RS +.IP IFACE Name of the network interface for which statistics are reported. -.RE - -.B rxerr/s -.RS +.IP rxerr/s Total number of bad packets received per second. -.RE - -.B txerr/s -.RS +.IP txerr/s Total number of errors that happened per second while transmitting packets. -.RE - -.B coll/s -.RS +.IP coll/s Number of collisions that happened per second while transmitting packets. -.RE - -.B rxdrop/s -.RS +.IP rxdrop/s Number of received packets dropped per second because of a lack of space in linux buffers. -.RE - -.B txdrop/s -.RS +.IP txdrop/s Number of transmitted packets dropped per second because of a lack of space in linux buffers. -.RE - -.B txcarr/s -.RS +.IP txcarr/s Number of carrier-errors that happened per second while transmitting packets. -.RE - -.B rxfram/s -.RS +.IP rxfram/s Number of frame alignment errors that happened per second on received packets. -.RE - -.B rxfifo/s -.RS +.IP rxfifo/s Number of FIFO overrun errors that happened per second on received packets. -.RE - -.B txfifo/s -.RS +.IP txfifo/s Number of FIFO overrun errors that happened per second on transmitted packets. .RE -With the -.B FC +.IP +.RB "With the " "FC" keyword, statistics about fibre channel traffic are reported. Note that fibre channel statistics depend on -.BR sadc 's -option "-S DISK" to be collected. +.BR "sadc" "'s option " "-S DISK" +to be collected. The following values are displayed: - -.B FCHOST .RS +.IP FCHOST Name of the fibre channel host bus adapter (HBA) interface for which statistics are reported. -.RE - -.B fch_rxf/s -.RS +.IP fch_rxf/s The total number of frames received per second. -.RE - -.B fch_txf/s -.RS +.IP fch_txf/s The total number of frames transmitted per second. -.RE - -.B fch_rxw/s -.RS +.IP fch_rxw/s The total number of transmission words received per second. -.RE - -.B fch_txw/s -.RS +.IP fch_txw/s The total number of transmission words transmitted per second. .RE -With the -.B ICMP +.IP +.RB "With the " "ICMP" keyword, statistics about ICMPv4 network traffic are reported. Note that ICMPv4 statistics depend on -.BR sadc 's -option "-S SNMP" +.BR "sadc" "'s option " "-S SNMP" to be collected. The following values are displayed (formal SNMP names between square brackets): - -.B imsg/s .RS +.IP imsg/s The total number of ICMP messages which the entity received per second [icmpInMsgs]. Note that this counter includes all those counted by ierr/s. -.RE - -.B omsg/s -.RS +.IP omsg/s The total number of ICMP messages which this entity attempted to send per second [icmpOutMsgs]. Note that this counter includes all those counted by oerr/s. -.RE - -.B iech/s -.RS +.IP iech/s The number of ICMP Echo (request) messages received per second [icmpInEchos]. -.RE - -.B iechr/s -.RS +.IP iechr/s The number of ICMP Echo Reply messages received per second [icmpInEchoReps]. -.RE - -.B oech/s -.RS +.IP oech/s The number of ICMP Echo (request) messages sent per second [icmpOutEchos]. -.RE - -.B oechr/s -.RS +.IP oechr/s The number of ICMP Echo Reply messages sent per second [icmpOutEchoReps]. -.RE - -.B itm/s -.RS +.IP itm/s The number of ICMP Timestamp (request) messages received per second [icmpInTimestamps]. -.RE - -.B itmr/s -.RS +.IP itmr/s The number of ICMP Timestamp Reply messages received per second [icmpInTimestampReps]. -.RE - -.B otm/s -.RS +.IP otm/s The number of ICMP Timestamp (request) messages sent per second [icmpOutTimestamps]. -.RE - -.B otmr/s -.RS +.IP otmr/s The number of ICMP Timestamp Reply messages sent per second [icmpOutTimestampReps]. -.RE - -.B iadrmk/s -.RS +.IP iadrmk/s The number of ICMP Address Mask Request messages received per second [icmpInAddrMasks]. -.RE - -.B iadrmkr/s -.RS +.IP iadrmkr/s The number of ICMP Address Mask Reply messages received per second [icmpInAddrMaskReps]. -.RE - -.B oadrmk/s -.RS +.IP oadrmk/s The number of ICMP Address Mask Request messages sent per second [icmpOutAddrMasks]. -.RE - -.B oadrmkr/s -.RS +.IP oadrmkr/s The number of ICMP Address Mask Reply messages sent per second [icmpOutAddrMaskReps]. .RE -With the -.B EICMP +.IP +.RB "With the " "EICMP" keyword, statistics about ICMPv4 error messages are reported. Note that ICMPv4 statistics depend on -.BR sadc 's -option "-S SNMP" to be collected. +.BR "sadc" "'s option " "-S SNMP" +to be collected. The following values are displayed (formal SNMP names between square brackets): - -.B ierr/s .RS +.IP ierr/s The number of ICMP messages per second which the entity received but determined as having ICMP-specific errors (bad ICMP checksums, bad length, etc.) [icmpInErrors]. -.RE - -.B oerr/s -.RS +.IP oerr/s The number of ICMP messages per second which this entity did not send due to problems discovered within ICMP such as a lack of buffers [icmpOutErrors]. -.RE - -.B idstunr/s -.RS +.IP idstunr/s The number of ICMP Destination Unreachable messages received per second [icmpInDestUnreachs]. -.RE - -.B odstunr/s -.RS +.IP odstunr/s The number of ICMP Destination Unreachable messages sent per second [icmpOutDestUnreachs]. -.RE - -.B itmex/s -.RS +.IP itmex/s The number of ICMP Time Exceeded messages received per second [icmpInTimeExcds]. -.RE - -.B otmex/s -.RS +.IP otmex/s The number of ICMP Time Exceeded messages sent per second [icmpOutTimeExcds]. -.RE - -.B iparmpb/s -.RS +.IP iparmpb/s The number of ICMP Parameter Problem messages received per second [icmpInParmProbs]. -.RE - -.B oparmpb/s -.RS +.IP oparmpb/s The number of ICMP Parameter Problem messages sent per second [icmpOutParmProbs]. -.RE - -.B isrcq/s -.RS +.IP isrcq/s The number of ICMP Source Quench messages received per second [icmpInSrcQuenchs]. -.RE - -.B osrcq/s -.RS +.IP osrcq/s The number of ICMP Source Quench messages sent per second [icmpOutSrcQuenchs]. -.RE - -.B iredir/s -.RS +.IP iredir/s The number of ICMP Redirect messages received per second [icmpInRedirects]. -.RE - -.B oredir/s -.RS +.IP oredir/s The number of ICMP Redirect messages sent per second [icmpOutRedirects]. .RE -With the -.B ICMP6 +.IP +.RB "With the " "ICMP6" keyword, statistics about ICMPv6 network traffic are reported. Note that ICMPv6 statistics depend on -.BR sadc 's -option "-S IPV6" to be collected. +.BR "sadc" "'s option " "-S IPV6" +to be collected. The following values are displayed (formal SNMP names between square brackets): - -.B imsg6/s .RS +.IP imsg6/s The total number of ICMP messages received by the interface per second which includes all those counted by ierr6/s [ipv6IfIcmpInMsgs]. -.RE - -.B omsg6/s -.RS +.IP omsg6/s The total number of ICMP messages which this interface attempted to send per second [ipv6IfIcmpOutMsgs]. -.RE - -.B iech6/s -.RS +.IP iech6/s The number of ICMP Echo (request) messages received by the interface per second [ipv6IfIcmpInEchos]. -.RE - -.B iechr6/s -.RS +.IP iechr6/s The number of ICMP Echo Reply messages received by the interface per second [ipv6IfIcmpInEchoReplies]. -.RE - -.B oechr6/s -.RS +.IP oechr6/s The number of ICMP Echo Reply messages sent by the interface per second [ipv6IfIcmpOutEchoReplies]. -.RE - -.B igmbq6/s -.RS +.IP igmbq6/s The number of ICMPv6 Group Membership Query messages received by the interface per second [ipv6IfIcmpInGroupMembQueries]. -.RE - -.B igmbr6/s -.RS +.IP igmbr6/s The number of ICMPv6 Group Membership Response messages received by the interface per second [ipv6IfIcmpInGroupMembResponses]. -.RE - -.B ogmbr6/s -.RS +.IP ogmbr6/s The number of ICMPv6 Group Membership Response messages sent per second [ipv6IfIcmpOutGroupMembResponses]. -.RE - -.B igmbrd6/s -.RS +.IP igmbrd6/s The number of ICMPv6 Group Membership Reduction messages received by the interface per second [ipv6IfIcmpInGroupMembReductions]. -.RE - -.B ogmbrd6/s -.RS +.IP ogmbrd6/s The number of ICMPv6 Group Membership Reduction messages sent per second [ipv6IfIcmpOutGroupMembReductions]. -.RE - -.B irtsol6/s -.RS +.IP irtsol6/s The number of ICMP Router Solicit messages received by the interface per second [ipv6IfIcmpInRouterSolicits]. -.RE - -.B ortsol6/s -.RS +.IP ortsol6/s The number of ICMP Router Solicitation messages sent by the interface per second [ipv6IfIcmpOutRouterSolicits]. -.RE - -.B irtad6/s -.RS +.IP irtad6/s The number of ICMP Router Advertisement messages received by the interface per second [ipv6IfIcmpInRouterAdvertisements]. -.RE - -.B inbsol6/s -.RS +.IP inbsol6/s The number of ICMP Neighbor Solicit messages received by the interface per second [ipv6IfIcmpInNeighborSolicits]. -.RE - -.B onbsol6/s -.RS +.IP onbsol6/s The number of ICMP Neighbor Solicitation messages sent by the interface per second [ipv6IfIcmpOutNeighborSolicits]. -.RE - -.B inbad6/s -.RS +.IP inbad6/s The number of ICMP Neighbor Advertisement messages received by the interface per second [ipv6IfIcmpInNeighborAdvertisements]. -.RE - -.B onbad6/s -.RS +.IP onbad6/s The number of ICMP Neighbor Advertisement messages sent by the interface per second [ipv6IfIcmpOutNeighborAdvertisements]. .RE -With the -.B EICMP6 +.IP +.RB "With the " "EICMP6" keyword, statistics about ICMPv6 error messages are reported. Note that ICMPv6 statistics depend on -.BR sadc 's -option "-S IPV6" to be collected. +.BR "sadc" "'s option " "-S IPV6" +to be collected. The following values are displayed (formal SNMP names between square brackets): - -.B ierr6/s .RS +.IP ierr6/s The number of ICMP messages per second which the interface received but determined as having ICMP-specific errors (bad ICMP checksums, bad length, etc.) [ipv6IfIcmpInErrors] -.RE - -.B idtunr6/s -.RS +.IP idtunr6/s The number of ICMP Destination Unreachable messages received by the interface per second [ipv6IfIcmpInDestUnreachs]. -.RE - -.B odtunr6/s -.RS +.IP odtunr6/s The number of ICMP Destination Unreachable messages sent by the interface per second [ipv6IfIcmpOutDestUnreachs]. -.RE - -.B itmex6/s -.RS +.IP itmex6/s The number of ICMP Time Exceeded messages received by the interface per second [ipv6IfIcmpInTimeExcds]. -.RE - -.B otmex6/s -.RS +.IP otmex6/s The number of ICMP Time Exceeded messages sent by the interface per second [ipv6IfIcmpOutTimeExcds]. -.RE - -.B iprmpb6/s -.RS +.IP iprmpb6/s The number of ICMP Parameter Problem messages received by the interface per second [ipv6IfIcmpInParmProblems]. -.RE - -.B oprmpb6/s -.RS +.IP oprmpb6/s The number of ICMP Parameter Problem messages sent by the interface per second [ipv6IfIcmpOutParmProblems]. -.RE - -.B iredir6/s -.RS +.IP iredir6/s The number of Redirect messages received by the interface per second [ipv6IfIcmpInRedirects]. -.RE - -.B oredir6/s -.RS +.IP oredir6/s The number of Redirect messages sent by the interface by second [ipv6IfIcmpOutRedirects]. -.RE - -.B ipck2b6/s -.RS +.IP ipck2b6/s The number of ICMP Packet Too Big messages received by the interface per second [ipv6IfIcmpInPktTooBigs]. -.RE - -.B opck2b6/s -.RS +.IP opck2b6/s The number of ICMP Packet Too Big messages sent by the interface per second [ipv6IfIcmpOutPktTooBigs]. .RE -With the -.B IP +.IP +.RB "With the " "IP" keyword, statistics about IPv4 network traffic are reported. Note that IPv4 statistics depend on -.BR sadc 's -option "-S SNMP" +.BR "sadc" "'s option " "-S SNMP" to be collected. The following values are displayed (formal SNMP names between square brackets): - -.B irec/s .RS +.IP irec/s The total number of input datagrams received from interfaces per second, including those received in error [ipInReceives]. -.RE - -.B fwddgm/s -.RS +.IP fwddgm/s The number of input datagrams per second, for which this entity was not their final IP destination, as a result of which an attempt was made to find a route to forward them to that final destination [ipForwDatagrams]. -.RE - -.B idel/s -.RS +.IP idel/s The total number of input datagrams successfully delivered per second to IP user-protocols (including ICMP) [ipInDelivers]. -.RE - -.B orq/s -.RS +.IP orq/s The total number of IP datagrams which local IP user-protocols (including ICMP) supplied per second to IP in requests for transmission [ipOutRequests]. Note that this counter does not include any datagrams counted in fwddgm/s. -.RE - -.B asmrq/s -.RS +.IP asmrq/s The number of IP fragments received per second which needed to be reassembled at this entity [ipReasmReqds]. -.RE - -.B asmok/s -.RS +.IP asmok/s The number of IP datagrams successfully re-assembled per second [ipReasmOKs]. -.RE - -.B fragok/s -.RS +.IP fragok/s The number of IP datagrams that have been successfully fragmented at this entity per second [ipFragOKs]. -.RE - -.B fragcrt/s -.RS +.IP fragcrt/s The number of IP datagram fragments that have been generated per second as a result of fragmentation at this entity [ipFragCreates]. .RE -With the -.B EIP +.IP +.RB "With the " "EIP" keyword, statistics about IPv4 network errors are reported. Note that IPv4 statistics depend on -.BR sadc 's -option "-S SNMP" to be collected. +.BR "sadc" "'s option " "-S SNMP" +to be collected. The following values are displayed (formal SNMP names between square brackets): - -.B ihdrerr/s .RS +.IP ihdrerr/s The number of input datagrams discarded per second due to errors in their IP headers, including bad checksums, version number mismatch, other format errors, time-to-live exceeded, errors discovered in processing their IP options, etc. [ipInHdrErrors] -.RE - -.B iadrerr/s -.RS +.IP iadrerr/s The number of input datagrams discarded per second because the IP address in their IP header's destination field was not a valid address to be received at this entity. This count @@ -1313,26 +831,17 @@ unsupported Classes (e.g., Class E). For entities which are not IP routers and therefore do not forward datagrams, this counter includes datagrams discarded because the destination address was not a local address [ipInAddrErrors]. -.RE - -.B iukwnpr/s -.RS +.IP iukwnpr/s The number of locally-addressed datagrams received successfully but discarded per second because of an unknown or unsupported protocol [ipInUnknownProtos]. -.RE - -.B idisc/s -.RS +.IP idisc/s The number of input IP datagrams per second for which no problems were encountered to prevent their continued processing, but which were discarded (e.g., for lack of buffer space) [ipInDiscards]. Note that this counter does not include any datagrams discarded while awaiting re-assembly. -.RE - -.B odisc/s -.RS +.IP odisc/s The number of output IP datagrams per second for which no problem was encountered to prevent their transmission to their destination, but which were discarded (e.g., for lack of @@ -1340,131 +849,90 @@ buffer space) [ipOutDiscards]. Note that this counter would include datagrams counted in fwddgm/s if any such packets met this (discretionary) discard criterion. -.RE - -.B onort/s -.RS +.IP onort/s The number of IP datagrams discarded per second because no route could be found to transmit them to their destination [ipOutNoRoutes]. Note that this counter includes any packets counted in fwddgm/s which meet this 'no-route' criterion. Note that this includes any datagrams which a host cannot route because all of its default routers are down. -.RE - -.B asmf/s -.RS +.IP asmf/s The number of failures detected per second by the IP re-assembly algorithm (for whatever reason: timed out, errors, etc) [ipReasmFails]. Note that this is not necessarily a count of discarded IP fragments since some algorithms can lose track of the number of fragments by combining them as they are received. -.RE - -.B fragf/s -.RS +.IP fragf/s The number of IP datagrams that have been discarded per second because they needed to be fragmented at this entity but could not be, e.g., because their Don't Fragment flag was set [ipFragFails]. .RE -With the -.B IP6 +.IP +.RB "With the " "IP6" keyword, statistics about IPv6 network traffic are reported. Note that IPv6 statistics depend on -.BR sadc 's -option "-S IPV6" to be collected. +.BR "sadc" "'s option " "-S IPV6" +to be collected. The following values are displayed (formal SNMP names between square brackets): - -.B irec6/s .RS +.IP irec6/s The total number of input datagrams received from interfaces per second, including those received in error [ipv6IfStatsInReceives]. -.RE - -.B fwddgm6/s -.RS +.IP fwddgm6/s The number of output datagrams per second which this entity received and forwarded to their final destinations [ipv6IfStatsOutForwDatagrams]. -.RE - -.B idel6/s -.RS +.IP idel6/s The total number of datagrams successfully delivered per second to IPv6 user-protocols (including ICMP) [ipv6IfStatsInDelivers]. -.RE - -.B orq6/s -.RS +.IP orq6/s The total number of IPv6 datagrams which local IPv6 user-protocols (including ICMP) supplied per second to IPv6 in requests for transmission [ipv6IfStatsOutRequests]. Note that this counter does not include any datagrams counted in fwddgm6/s. -.RE - -.B asmrq6/s -.RS +.IP asmrq6/s The number of IPv6 fragments received per second which needed to be reassembled at this interface [ipv6IfStatsReasmReqds]. -.RE - -.B asmok6/s -.RS +.IP asmok6/s The number of IPv6 datagrams successfully reassembled per second [ipv6IfStatsReasmOKs]. -.RE - -.B imcpck6/s -.RS +.IP imcpck6/s The number of multicast packets received per second by the interface [ipv6IfStatsInMcastPkts]. -.RE - -.B omcpck6/s -.RS +.IP omcpck6/s The number of multicast packets transmitted per second by the interface [ipv6IfStatsOutMcastPkts]. -.RE - -.B fragok6/s -.RS +.IP fragok6/s The number of IPv6 datagrams that have been successfully fragmented at this output interface per second [ipv6IfStatsOutFragOKs]. -.RE - -.B fragcr6/s -.RS +.IP fragcr6/s The number of output datagram fragments that have been generated per second as a result of fragmentation at this output interface [ipv6IfStatsOutFragCreates]. .RE -With the -.B EIP6 +.IP +.RB "With the " "EIP6" keyword, statistics about IPv6 network errors are reported. Note that IPv6 statistics depend on -.BR sadc 's -option "-S IPV6" to be collected. +.BR "sadc" "'s option " "-S IPV6" +to be collected. The following values are displayed (formal SNMP names between square brackets): - -.B ihdrer6/s .RS +.IP ihdrer6/s The number of input datagrams discarded per second due to errors in their IPv6 headers, including version number mismatch, other format errors, hop count exceeded, errors discovered in processing their IPv6 options, etc. [ipv6IfStatsInHdrErrors] -.RE - -.B iadrer6/s -.RS +.IP iadrer6/s The number of input datagrams discarded per second because the IPv6 address in their IPv6 header's destination field was not a valid address to be received at @@ -1475,24 +943,15 @@ entities which are not IPv6 routers and therefore do not forward datagrams, this counter includes datagrams discarded because the destination address was not a local address [ipv6IfStatsInAddrErrors]. -.RE - -.B iukwnp6/s -.RS +.IP iukwnp6/s The number of locally-addressed datagrams received successfully but discarded per second because of an unknown or unsupported protocol [ipv6IfStatsInUnknownProtos]. -.RE - -.B i2big6/s -.RS +.IP i2big6/s The number of input datagrams that could not be forwarded per second because their size exceeded the link MTU of outgoing interface [ipv6IfStatsInTooBigErrors]. -.RE - -.B idisc6/s -.RS +.IP idisc6/s The number of input IPv6 datagrams per second for which no problems were encountered to prevent their continued processing, but which were discarded @@ -1500,10 +959,7 @@ continued processing, but which were discarded [ipv6IfStatsInDiscards]. Note that this counter does not include any datagrams discarded while awaiting re-assembly. -.RE - -.B odisc6/s -.RS +.IP odisc6/s The number of output IPv6 datagrams per second for which no problem was encountered to prevent their transmission to their destination, but which were @@ -1512,241 +968,138 @@ discarded (e.g., for lack of buffer space) that this counter would include datagrams counted in fwddgm6/s if any such packets met this (discretionary) discard criterion. -.RE - -.B inort6/s -.RS +.IP inort6/s The number of input datagrams discarded per second because no route could be found to transmit them to their destination [ipv6IfStatsInNoRoutes]. -.RE - -.B onort6/s -.RS +.IP onort6/s The number of locally generated IP datagrams discarded per second because no route could be found to transmit them to their destination [unknown formal SNMP name]. -.RE - -.B asmf6/s -.RS +.IP asmf6/s The number of failures detected per second by the IPv6 re-assembly algorithm (for whatever reason: timed out, errors, etc.) [ipv6IfStatsReasmFails]. -Note that this is not -necessarily a count of discarded IPv6 fragments -since some algorithms +Note that this is not necessarily a count of discarded +IPv6 fragments since some algorithms can lose track of the number of fragments by combining them as they are received. -.RE - -.B fragf6/s -.RS +.IP fragf6/s The number of IPv6 datagrams that have been discarded per second because they needed to be fragmented at this output interface but could not be [ipv6IfStatsOutFragFails]. -.RE - -.B itrpck6/s -.RS +.IP itrpck6/s The number of input datagrams discarded per second because datagram frame didn't carry enough data [ipv6IfStatsInTruncatedPkts]. .RE -With the -.B NFS +.IP +.RB "With the " "NFS" keyword, statistics about NFS client activity are reported. The following values are displayed: - -.B call/s .RS +.IP call/s Number of RPC requests made per second. -.RE - -.B retrans/s -.RS -Number of RPC requests per second, those which needed to be retransmitted (for -example because of a server timeout). -.RE - -.B read/s -.RS +.IP retrans/s +Number of RPC requests per second, those which needed to be retransmitted +(for example because of a server timeout). +.IP read/s Number of 'read' RPC calls made per second. -.RE - -.B write/s -.RS +.IP write/s Number of 'write' RPC calls made per second. -.RE - -.B access/s -.RS +.IP access/s Number of 'access' RPC calls made per second. -.RE - -.B getatt/s -.RS +.IP getatt/s Number of 'getattr' RPC calls made per second. .RE -With the -.B NFSD +.IP +.RB "With the " "NFSD" keyword, statistics about NFS server activity are reported. The following values are displayed: - -.B scall/s .RS +.IP scall/s Number of RPC requests received per second. -.RE - -.B badcall/s -.RS +.IP badcall/s Number of bad RPC requests received per second, those whose processing generated an error. -.RE - -.B packet/s -.RS +.IP packet/s Number of network packets received per second. -.RE - -.B udp/s -.RS +.IP udp/s Number of UDP packets received per second. -.RE - -.B tcp/s -.RS +.IP tcp/s Number of TCP packets received per second. -.RE - -.B hit/s -.RS +.IP hit/s Number of reply cache hits per second. -.RE - -.B miss/s -.RS +.IP miss/s Number of reply cache misses per second. -.RE - -.B sread/s -.RS +.IP sread/s Number of 'read' RPC calls received per second. -.RE - -.B swrite/s -.RS +.IP swrite/s Number of 'write' RPC calls received per second. -.RE - -.B saccess/s -.RS +.IP saccess/s Number of 'access' RPC calls received per second. -.RE - -.B sgetatt/s -.RS +.IP sgetatt/s Number of 'getattr' RPC calls received per second. .RE -With the -.B SOCK -keyword, statistics on sockets in use are reported -(IPv4). +.IP +.RB "With the " "SOCK" +keyword, statistics on sockets in use are reported (IPv4). The following values are displayed: - -.B totsck .RS +.IP totsck Total number of sockets used by the system. -.RE - -.B tcpsck -.RS +.IP tcpsck Number of TCP sockets currently in use. -.RE - -.B udpsck -.RS +.IP udpsck Number of UDP sockets currently in use. -.RE - -.B rawsck -.RS +.IP rawsck Number of RAW sockets currently in use. -.RE - -.B ip-frag -.RS +.IP ip-frag Number of IP fragments currently in queue. -.RE - -.B tcp-tw -.RS +.IP tcp-tw Number of TCP sockets in TIME_WAIT state. .RE -With the -.B SOCK6 +.IP +.RB "With the " "SOCK6" keyword, statistics on sockets in use are reported (IPv6). Note that IPv6 statistics depend on -.BR sadc 's -option "-S IPV6" to be collected. +.BR "sadc" "'s option " "-S IPV6" +to be collected. The following values are displayed: - -.B tcp6sck .RS +.IP tcp6sck Number of TCPv6 sockets currently in use. -.RE - -.B udp6sck -.RS +.IP udp6sck Number of UDPv6 sockets currently in use. -.RE - -.B raw6sck -.RS +.IP raw6sck Number of RAWv6 sockets currently in use. -.RE - -.B ip6-frag -.RS +.IP ip6-frag Number of IPv6 fragments currently in use. .RE -With the -.B SOFT +.IP +.RB "With the " "SOFT" keyword, statistics about software-based network processing are reported. The following values are displayed: - -.B total/s .RS +.IP total/s The total number of network frames processed per second. -.RE - -.B dropd/s -.RS +.IP dropd/s The total number of network frames dropped per second because there was no room on the processing queue. -.RE - -.B squeezd/s -.RS +.IP squeezd/s The number of times the softirq handler function terminated per second because its budget was consumed or the time limit was reached, but more work could have been done. -.RE - -.B rx_rps/s -.RS +.IP rx_rps/s The number of times the CPU has been woken up per second to process packets via an inter-processor interrupt. -.RE - -.B flw_lim/s -.RS +.IP flw_lim/s The number of times the flow limit has been reached per second. Flow limiting is an optional RPS feature that can be used to limit the number of packets queued to the backlog for each flow to a certain amount. @@ -1754,179 +1107,130 @@ This can help ensure that smaller flows are processed even though much larger flows are pushing packets in. .RE -With the -.B TCP +.IP +.RB "With the " "TCP" keyword, statistics about TCPv4 network traffic are reported. Note that TCPv4 statistics depend on -.BR sadc 's -option "-S SNMP" to be collected. +.BR "sadc" "'s option " "-S SNMP" +to be collected. The following values are displayed (formal SNMP names between square brackets): - -.B active/s .RS +.IP active/s The number of times TCP connections have made a direct transition to the SYN-SENT state from the CLOSED state per second [tcpActiveOpens]. -.RE - -.B passive/s -.RS +.IP passive/s The number of times TCP connections have made a direct transition to the SYN-RCVD state from the LISTEN state per second [tcpPassiveOpens]. -.RE - -.B iseg/s -.RS +.IP iseg/s The total number of segments received per second, including those received in error [tcpInSegs]. This count includes segments received on currently established connections. -.RE - -.B oseg/s -.RS +.IP oseg/s The total number of segments sent per second, including those on current connections but excluding those containing only retransmitted octets [tcpOutSegs]. .RE -With the -.B ETCP +.IP +.RB "With the " "ETCP" keyword, statistics about TCPv4 network errors are reported. Note that TCPv4 statistics depend on -.BR sadc 's -option "-S SNMP" to be collected. +.BR "sadc" "'s option " "-S SNMP" +to be collected. The following values are displayed (formal SNMP names between square brackets): - -.B atmptf/s .RS +.IP atmptf/s The number of times per second TCP connections have made a direct transition to the CLOSED state from either the SYN-SENT state or the SYN-RCVD state, plus the number of times per second TCP connections have made a direct transition to the LISTEN state from the SYN-RCVD state [tcpAttemptFails]. -.RE - -.B estres/s -.RS +.IP estres/s The number of times per second TCP connections have made a direct transition to the CLOSED state from either the ESTABLISHED state or the CLOSE-WAIT state [tcpEstabResets]. -.RE - -.B retrans/s -.RS +.IP retrans/s The total number of segments retransmitted per second - that is, the number of TCP segments transmitted containing one or more previously transmitted octets [tcpRetransSegs]. -.RE - -.B isegerr/s -.RS +.IP isegerr/s The total number of segments received in error (e.g., bad TCP checksums) per second [tcpInErrs]. -.RE - -.B orsts/s -.RS +.IP orsts/s The number of TCP segments sent per second containing the RST flag [tcpOutRsts]. .RE -With the -.B UDP +.IP +.RB "With the " "UDP" keyword, statistics about UDPv4 network traffic are reported. Note that UDPv4 statistics depend on -.BR sadc's -option "-S SNMP" to be collected. +.BR "sadc" "'s option " "-S SNMP" +to be collected. The following values are displayed (formal SNMP names between square brackets): - -.B idgm/s .RS +.IP idgm/s The total number of UDP datagrams delivered per second to UDP users [udpInDatagrams]. -.RE - -.B odgm/s -.RS +.IP odgm/s The total number of UDP datagrams sent per second from this entity [udpOutDatagrams]. -.RE - -.B noport/s -.RS +.IP noport/s The total number of received UDP datagrams per second for which there was no application at the destination port [udpNoPorts]. -.RE - -.B idgmerr/s -.RS +.IP idgmerr/s The number of received UDP datagrams per second that could not be delivered for reasons other than the lack of an application at the destination port [udpInErrors]. .RE -With the -.B UDP6 +.IP +.RB "With the " "UDP6" keyword, statistics about UDPv6 network traffic are reported. Note that UDPv6 statistics depend on -.BR sadc 's -option "-S IPV6" to be collected. +.BR "sadc" "'s option " "-S IPV6" +to be collected. The following values are displayed (formal SNMP names between square brackets): - -.B idgm6/s .RS +.IP idgm6/s The total number of UDP datagrams delivered per second to UDP users [udpInDatagrams]. -.RE - -.B odgm6/s -.RS +.IP odgm6/s The total number of UDP datagrams sent per second from this entity [udpOutDatagrams]. -.RE - -.B noport6/s -.RS +.IP noport6/s The total number of received UDP datagrams per second for which there was no application at the destination port [udpNoPorts]. -.RE - -.B idgmer6/s -.RS +.IP idgmer6/s The number of received UDP datagrams per second that could not be delivered for reasons other than the lack of an application at the destination port [udpInErrors]. .RE -The -.B ALL +.IP +.RB "The " "ALL" keyword is equivalent to specifying all the keywords above and therefore all the network activities are reported. -.RE -.RE -.IP "-o [ filename ]" +.TP +.BI "-o [ " "filename " "]" Save the readings in the file in binary form. Each reading is in a separate record. The default value of the .I filename -parameter is the current standard system activity daily data file. -If +parameter is the current standard system activity daily data file. If .I filename is a directory instead of a plain file then it is considered as the directory -where the standard system activity daily data files are located. -The -o option is exclusive of the -f option. +where the standard system activity daily data files are located. Option +.BR "-o " "is exclusive of option " "-f" "." All the data available from the kernel are saved in the file (in fact, -.B sar -calls its data collector -.B sadc -with the option "-S ALL". -See -.BR sadc (8) -manual page). -.IP "-P { cpu_list | ALL }" +.BR "sar " "calls its data collector " "sadc " "with the option " "-S ALL" "." +.RB "See " "sadc" "(8) manual page)." +.TP +.BI "-P { " "cpu_list " "| ALL }" Report per-processor statistics for the specified processor or processors. .I cpu_list is a list of comma-separated values or range of values (e.g., -.BR 0,2,4-7,12- ). +.BR "0,2,4-7,12-" ")." Note that processor 0 is the first processor, and processor .B all is the global average among all processors. @@ -1934,512 +1238,325 @@ Specifying the .B ALL keyword reports statistics for each individual processor, and globally for all processors. Offline processors are not displayed. -.IP "-p, --pretty" +.TP +.BR "-p" ", " "--pretty" Make reports easier to read by a human. This option may be especially useful when displaying e.g., network interfaces or block devices statistics. -.IP "-q [ keyword [,...] | ALL ]" +.TP +.BI "-q [ " "keyword" "[,...] | ALL ]" Report system load and pressure-stall statistics. Possible keywords are -.BR CPU , -.BR IO , -.BR LOAD , -.BR MEM , -and -.BR PSI . +.BR "CPU" ", " "IO" ", " "LOAD" ", " "MEM " "and "PSI" "." -With the -.B CPU +.RB "With the " "CPU" keyword, CPU pressure statistics are reported. The following values are displayed: - -.B %scpu-10 -.RS .RS -Percentage of the time that at least some runnable tasks were delayed because the CPU was unavailable to them, over the last 10 second window. -.RE - -.B %scpu-60 -.RS -Percentage of the time that at least some runnable tasks were delayed because the CPU was unavailable to them, over the last 60 second window. -.RE - -.B %scpu-300 -.RS -Percentage of the time that at least some runnable tasks were delayed because the CPU was unavailable to them, over the last 300 second window. -.RE - -.B %scpu -.RS -Percentage of the time that at least some runnable tasks were delayed because the CPU was unavailable to them, over the last time interval. -.RE - -With the -.B IO +.IP %scpu-10 +Percentage of the time that at least some runnable tasks were delayed because the CPU +was unavailable to them, over the last 10 second window. +.IP %scpu-60 +Percentage of the time that at least some runnable tasks were delayed because the CPU +was unavailable to them, over the last 60 second window. +.IP %scpu-300 +Percentage of the time that at least some runnable tasks were delayed because the CPU +was unavailable to them, over the last 300 second window. +.IP %scpu +Percentage of the time that at least some runnable tasks were delayed because the CPU +was unavailable to them, over the last time interval. +.RE + +.IP +.RB "With the " "IO" keyword, I/O pressure statistics are reported. The following values are displayed: - -.B %sio-10 -.RS -Percentage of the time that at least some tasks lost waiting for I/O, over the last 10 second window. -.RE - -.B %sio-60 -.RS -Percentage of the time that at least some tasks lost waiting for I/O, over the last 60 second window. -.RE - -.B %sio-300 -.RS -Percentage of the time that at least some tasks lost waiting for I/O, over the last 300 second window. -.RE - -.B %sio -.RS -Percentage of the time that at least some tasks lost waiting for I/O, over the last time interval. -.RE - -.B %fio-10 -.RS -Percentage of the time during which all non-idle tasks were stalled waiting for I/O, over the last 10 second window. -.RE - -.B %fio-60 -.RS -Percentage of the time during which all non-idle tasks were stalled waiting for I/O, over the last 60 second window. -.RE - -.B %fio-300 -.RS -Percentage of the time during which all non-idle tasks were stalled waiting for I/O, over the last 300 second window. -.RE - -.B %fio .RS -Percentage of the time during which all non-idle tasks were stalled waiting for I/O, over the last time interval. -.RE - -With the -.B LOAD +.IP %sio-10 +Percentage of the time that at least some tasks lost waiting for I/O, +over the last 10 second window. +.IP %sio-60 +Percentage of the time that at least some tasks lost waiting for I/O, +over the last 60 second window. +.IP %sio-300 +Percentage of the time that at least some tasks lost waiting for I/O, +over the last 300 second window. +.IP %sio +Percentage of the time that at least some tasks lost waiting for I/O, +over the last time interval. +.IP %fio-10 +Percentage of the time during which all non-idle tasks were stalled +waiting for I/O, over the last 10 second window. +.IP %fio-60 +Percentage of the time during which all non-idle tasks were stalled +waiting for I/O, over the last 60 second window. +.IP %fio-300 +Percentage of the time during which all non-idle tasks were stalled +waiting for I/O, over the last 300 second window. +.IP %fio +Percentage of the time during which all non-idle tasks were stalled +waiting for I/O, over the last time interval. +.RE + +.IP +.RB "With the " "LOAD" keyword, queue length and load averages statistics are reported. The following values are displayed: - -.B runq-sz .RS +.IP runq-sz Run queue length (number of tasks waiting for run time). -.RE - -.B plist-sz -.RS +.IP plist-sz Number of tasks in the task list. -.RE - -.B ldavg-1 -.RS +.IP ldavg-1 System load average for the last minute. The load average is calculated as the average number of runnable or running tasks (R state), and the number of tasks in uninterruptible sleep (D state) over the specified interval. -.RE - -.B ldavg-5 -.RS +.IP ldavg-5 System load average for the past 5 minutes. -.RE - -.B ldavg-15 -.RS +.IP ldavg-15 System load average for the past 15 minutes. -.RE - -.B blocked -.RS +.IP blocked Number of tasks currently blocked, waiting for I/O to complete. .RE -With the -.B MEM +.IP +.RB "With the " "MEM" keyword, memory pressure statistics are reported. The following values are displayed: - -.B %smem-10 .RS -Percentage of the time during which at least some tasks were waiting for memory resources, over the last 10 second window. -.RE - -.B %smem-60 -.RS -Percentage of the time during which at least some tasks were waiting for memory resources, over the last 60 second window. -.RE - -.B %smem-300 -.RS -Percentage of the time during which at least some tasks were waiting for memory resources, over the last 300 second window. -.RE - -.B %smem -.RS -Percentage of the time during which at least some tasks were waiting for memory resources, over the last time interval. -.RE - -.B %fmem-10 -.RS -Percentage of the time during which all non-idle tasks were stalled waiting for memory resources, over the last 10 second window. -.RE - -.B %fmem-60 -.RS -Percentage of the time during which all non-idle tasks were stalled waiting for memory resources, over the last 60 second window. -.RE - -.B %fmem-300 -.RS -Percentage of the time during which all non-idle tasks were stalled waiting for memory resources, over the last 300 second window. -.RE - -.B %fmem -.RS -Percentage of the time during which all non-idle tasks were stalled waiting for memory resources, over the last time interval. -.RE - -The -.B PSI -keyword is equivalent to specifying CPU, IO and MEM keywords together and therefore all the pressure-stall statistics are reported. - -The -.B ALL -keyword is equivalent to specifying all the keywords above and therefore all the statistics are reported. -.RE -.RE -.IP "-r [ ALL ]" +.IP %smem-10 +Percentage of the time during which at least some tasks were waiting +for memory resources, over the last 10 second window. +.IP %smem-60 +Percentage of the time during which at least some tasks were waiting +for memory resources, over the last 60 second window. +.IP %smem-300 +Percentage of the time during which at least some tasks were waiting +for memory resources, over the last 300 second window. +.IP %smem +Percentage of the time during which at least some tasks were waiting +for memory resources, over the last time interval. +.IP %fmem-10 +Percentage of the time during which all non-idle tasks were stalled +waiting for memory resources, over the last 10 second window. +.IP %fmem-60 +Percentage of the time during which all non-idle tasks were stalled +waiting for memory resources, over the last 60 second window. +.IP %fmem-300 +Percentage of the time during which all non-idle tasks were stalled +waiting for memory resources, over the last 300 second window. +.IP %fmem +Percentage of the time during which all non-idle tasks were stalled +waiting for memory resources, over the last time interval. +.RE + +.IP +.RB "The " "PSI" +keyword is equivalent to specifying CPU, IO and MEM keywords together +and therefore all the pressure-stall statistics are reported. + +.RB "The " "ALL" +keyword is equivalent to specifying all the keywords above +and therefore all the statistics are reported. +.TP +.B -r [ ALL ] Report memory utilization statistics. The .B ALL keyword indicates that all the memory fields should be displayed. The following values may be displayed: - -.B kbmemfree -.RS .RS +.IP kbmemfree Amount of free memory available in kilobytes. -.RE - -.B kbavail -.RS +.IP kbavail Estimate of how much memory in kilobytes is available for starting new applications, without swapping. The estimate takes into account that the system needs some page cache to function well, and that not all reclaimable slab will be reclaimable, due to items being in use. The impact of those factors will vary from system to system. -.RE - -.B kbmemused -.RS +.IP kbmemused Amount of used memory in kilobytes (calculated as total installed memory - -.B kbmemfree -- -.B kbbuffers -- -.B kbcached -- -.BR kbslab ). -.RE - -.B %memused -.RS +kbmemfree - kbbuffers - kbcached - kbslab). +.IP %memused Percentage of used memory. -.RE - -.B kbbuffers -.RS +.IP kbbuffers Amount of memory used as buffers by the kernel in kilobytes. -.RE - -.B kbcached -.RS +.IP kbcached Amount of memory used to cache data by the kernel in kilobytes. -.RE - -.B kbcommit -.RS -Amount of memory in kilobytes needed for current workload. This is an estimate of how much +.IP kbcommit +Amount of memory in kilobytes needed for current workload. +This is an estimate of how much RAM/swap is needed to guarantee that there never is out of memory. -.RE - -.B %commit -.RS -Percentage of memory needed for current workload in relation to the total amount of memory (RAM+swap). -This number may be greater than 100% because the kernel usually overcommits memory. -.RE - -.B kbactive -.RS +.IP %commit +Percentage of memory needed for current workload in relation to the +total amount of memory (RAM+swap). This number may be greater +than 100% because the kernel usually overcommits memory. +.IP kbactive Amount of active memory in kilobytes (memory that has been used more recently and usually not reclaimed unless absolutely necessary). -.RE - -.B kbinact -.RS +.IP kbinact Amount of inactive memory in kilobytes (memory which has been less recently used. It is more eligible to be reclaimed for other purposes). -.RE - -.B kbdirty -.RS +.IP kbdirty Amount of memory in kilobytes waiting to get written back to the disk. -.RE - -.B kbanonpg -.RS +.IP kbanonpg Amount of non-file backed pages in kilobytes mapped into userspace page tables. -.RE - -.B kbslab -.RS -Amount of memory in kilobytes used by the kernel to cache data structures for its own use. -.RE - -.B kbkstack -.RS +.IP kbslab +Amount of memory in kilobytes used by the kernel to cache data structures +for its own use. +.IP kbkstack Amount of memory in kilobytes used for kernel stack space. -.RE - -.B kbpgtbl -.RS +.IP kbpgtbl Amount of memory in kilobytes dedicated to the lowest level of page tables. -.RE - -.B kbvmused -.RS +.IP kbvmused Amount of memory in kilobytes of used virtual address space. .RE -.RE -.IP -S +.TP +.B -S Report swap space utilization statistics. The following values are displayed: - -.B kbswpfree -.RS .RS +.IP kbswpfree Amount of free swap space in kilobytes. -.RE - -.B kbswpused -.RS +.IP kbswpused Amount of used swap space in kilobytes. -.RE - -.B %swpused -.RS +.IP %swpused Percentage of used swap space. -.RE - -.B kbswpcad -.RS +.IP kbswpcad Amount of cached swap memory in kilobytes. -This is memory that once was swapped out, is swapped back in -but still also is in the swap area (if memory is needed it doesn't need -to be swapped out again because it is already in the swap area. This -saves I/O). -.RE - -.B %swpcad -.RS +This is memory that once was swapped out, is swapped back in but still also +is in the swap area (if memory is needed it doesn't need to be swapped out +again because it is already in the swap area. This saves I/O). +.IP %swpcad Percentage of cached swap memory in relation to the amount of used swap space. .RE -.RE -.IP "-s [ hh:mm[:ss] ]" +.TP +.BI "-s [ " "hh" ":" "mm" "[:" "ss" "] ]" Set the starting time of the data, causing the .B sar command to extract records time-tagged at, or following, the time specified. The default starting time is 08:00:00. Hours must be given in 24-hour format. This option can be -used only when data are read from a file (option -f). -.IP "--sadc" +used only when data are read from a file (option +.BR "-f" ")." +.TP +.B --sadc Indicate which data collector is called by -.BR sar . -If the data collector is sought in PATH then enter "which sadc" to -know where it is located. -.IP -t +.BR "sar" "." +If the data collector is sought in +.B PATH +then enter "which sadc" to know where it is located. +.TP +.B -t When reading data from a daily data file, indicate that .B sar should display the timestamps in the original local time of the data file creator. Without this option, the .B sar command displays the timestamps in the user's locale time. -.IP "-u [ ALL ]" +.TP +.B -u [ ALL ] Report CPU utilization. The .B ALL keyword indicates that all the CPU fields should be displayed. The report may show the following fields: - -.B %user -.RS .RS +.IP %user Percentage of CPU utilization that occurred while executing at the user level (application). Note that this field includes time spent running virtual processors. -.RE - -.B %usr -.RS +.IP %usr Percentage of CPU utilization that occurred while executing at the user level (application). Note that this field does NOT include time spent running virtual processors. -.RE - -.B %nice -.RS +.IP %nice Percentage of CPU utilization that occurred while executing at the user level with nice priority. -.RE - -.B %system -.RS +.IP %system Percentage of CPU utilization that occurred while executing at the system level (kernel). Note that this field includes time spent servicing hardware and software interrupts. -.RE - -.B %sys -.RS +.IP %sys Percentage of CPU utilization that occurred while executing at the system level (kernel). Note that this field does NOT include time spent servicing hardware or software interrupts. -.RE - -.B %iowait -.RS +.IP %iowait Percentage of time that the CPU or CPUs were idle during which the system had an outstanding disk I/O request. -.RE - -.B %steal -.RS +.IP %steal Percentage of time spent in involuntary wait by the virtual CPU or CPUs while the hypervisor was servicing another virtual processor. -.RE - -.B %irq -.RS +.IP %irq Percentage of time spent by the CPU or CPUs to service hardware interrupts. -.RE - -.B %soft -.RS +.IP %soft Percentage of time spent by the CPU or CPUs to service software interrupts. -.RE - -.B %guest -.RS +.IP %guest Percentage of time spent by the CPU or CPUs to run a virtual processor. -.RE - -.B %gnice -.RS +.IP %gnice Percentage of time spent by the CPU or CPUs to run a niced guest. -.RE - -.B %idle -.RS +.IP %idle Percentage of time that the CPU or CPUs were idle and the system did not have an outstanding disk I/O request. .RE -.RE -.IP -V +.TP +.B -V Print version number then exit. -.IP -v +.TP +.B -v Report status of inode, file and other kernel tables. The following values are displayed: - -.B dentunusd -.RS .RS +.IP dentunusd Number of unused cache entries in the directory cache. -.RE - -.B file-nr -.RS +.IP file-nr Number of file handles used by the system. -.RE - -.B inode-nr -.RS +.IP inode-nr Number of inode handlers used by the system. -.RE - -.B pty-nr -.RS +.IP pty-nr Number of pseudo-terminals used by the system. .RE -.RE -.IP -W +.TP +.B -W Report swapping statistics. The following values are displayed: - -.B pswpin/s -.RS .RS +.IP pswpin/s Total number of swap pages the system brought in per second. -.RE - -.B pswpout/s -.RS +.IP pswpout/s Total number of swap pages the system brought out per second. .RE -.RE -.IP -w +.TP +.B -w Report task creation and system switching activity. - -.B proc/s -.RS +The following values are displayed: .RS +.IP proc/s Total number of tasks created per second. -.RE - -.B cswch/s -.RS +.IP cswch/s Total number of context switches per second. .RE -.RE -.IP -y +.TP +.B -y Report TTY devices activity. The following values are displayed: - -.B rcvin/s -.RS -.RS -Number of receive interrupts per second for current serial line. Serial line number -is given in the TTY column. -.RE - -.B xmtin/s .RS +.IP rcvin/s +Number of receive interrupts per second for current serial line. +Serial line number is given in the TTY column. +.IP xmtin/s Number of transmit interrupts per second for current serial line. -.RE - -.B framerr/s -.RS +.IP framerr/s Number of frame errors per second for current serial line. -.RE - -.B prtyerr/s -.RS +.IP prtyerr/s Number of parity errors per second for current serial line. -.RE - -.B brk/s -.RS +.IP brk/s Number of breaks per second for current serial line. -.RE - -.B ovrun/s -.RS +.IP ovrun/s Number of overrun errors per second for current serial line. .RE -.RE -.IP -z -Tell -.B sar +.TP +.B -z +.RB "Tell " "sar" to omit output for any devices for which there was no activity during the sample period. @@ -2447,140 +1564,113 @@ sample period. The .B sar command takes into account the following environment variables: - -.IP S_COLORS +.TP +.B S_COLORS By default statistics are displayed in color when the output is connected to a terminal. Use this variable to change the settings. Possible values for this variable are -.IR never , -.IR always -or -.IR auto +.IR "never" ", " "always " "or " "auto" (the latter is equivalent to the default settings). - +.br Please note that the color (being red, yellow, or some other color) used to display a value is not indicative of any kind of issue simply because of the color. It only indicates different ranges of values. - -.IP S_COLORS_SGR +.TP +.B S_COLORS_SGR Specify the colors and other attributes used to display statistics on the terminal. Its value is a colon-separated list of capabilities that defaults to -.BR C=33;22:H=31;1:I=32;22:M=35;1:N=34;1:R=31;22:Z=34;22 . +.BR "C=33;22:H=31;1:I=32;22:M=35;1:N=34;1:R=31;22:Z=34;22" "." Supported capabilities are: - .RS .TP .B C= SGR (Select Graphic Rendition) substring for comments inserted in the binary daily data files. - .TP .B H= SGR substring for percentage values greater than or equal to 75%. - .TP .B I= SGR substring for item names or values (eg. network interfaces, CPU number...) - .TP .B M= SGR substring for percentage values in the range from 50% to 75%. - .TP .B N= SGR substring for non-zero statistics values. - .TP .B R= SGR substring for restart messages. - .TP .B Z= SGR substring for zero values. .RE - -.IP S_TIME_DEF_TIME +.TP +.B S_TIME_DEF_TIME If this variable exists and its value is -.B UTC -then -.B sar +.BR "UTC " "then " "sar" will save its data in UTC time (data will still be displayed in local time). .B sar will also use UTC time instead of local time to determine the current daily data file located in the -.IR @SA_DIR@ +.I @SA_DIR@ directory. This variable may be useful for servers with users located across several timezones. - -.IP S_TIME_FORMAT +.TP +.B S_TIME_FORMAT If this variable exists and its value is .B ISO then the current locale will be ignored when printing the date in the report header. -The -.B sar +.RB "The " "sar" command will use the ISO 8601 format (YYYY-MM-DD) instead. The timestamp will also be compliant with ISO 8601 format. + .SH EXAMPLES +.TP .B sar -u 2 5 -.RS Report CPU utilization for each 2 seconds. 5 lines are displayed. -.RE - +.TP .B sar -I 14 -o int14.file 2 10 -.RS Report statistics on IRQ 14 for each 2 seconds. 10 lines are displayed. Data are stored in a file called -.IR int14.file . -.RE - +.IR "int14.file" "." +.TP .B sar -r -n DEV -f @SA_DIR@/sa16 -.RS -Display memory and network statistics saved in daily data file 'sa16'. -.RE - +.RI "Display memory and network statistics saved in daily data file " "sa16" "." +.TP .B sar -A -.RS Display all the statistics saved in current daily data file. -.SH BUGS -.I /proc -filesystem must be mounted for the -.B sar -command to work. +.SH BUGS +.IR "/proc " "filesystem must be mounted for the +.BR "sar " "command to work." +.PP All the statistics are not necessarily available, depending on the kernel version used. .B sar assumes that you are using at least a 2.6 kernel. - -Although -.B sar +.PP +.RB "Although " "sar" speaks of kilobytes (kB), megabytes (MB)..., it actually uses kibibytes (kiB), mebibytes (MiB)... A kibibyte is equal to 1024 bytes, and a mebibyte is equal to 1024 kibibytes. + .SH FILES .I @SA_DIR@/saDD .br .I @SA_DIR@/saYYYYMMDD .RS The standard system activity daily data files and their default location. -YYYY stands for the current year, MM for the current month and DD for the -current day. - +.IR "YYYY " "stands for the current year, " "MM " "for the current month and " "DD" +for the current day. .RE -.I /proc -and -.I /sys -contain various files with system statistics. + +.IR "/proc " "and " "/sys " "contain various files with system statistics." + .SH AUTHOR Sebastien Godard (sysstat orange.fr) -.SH SEE ALSO -.BR sadc (8), -.BR sa1 (8), -.BR sa2 (8), -.BR sadf (1), -.BR sysstat (5), -.BR pidstat (1), -.BR mpstat (1), -.BR iostat (1), -.BR vmstat (8) +.SH SEE ALSO +.BR "sadc" "(8), " "sa1" "(8), " "sa2" "(8), " "sadf" "(1), " "sysstat" "(5), " "pidstat" "(1)," +.BR "mpstat" "(1), " "iostat" "(1), " "vmstat" "(8)" +.PP .I https://github.com/sysstat/sysstat - +.br .I http://pagesperso-orange.fr/sebastien.godard/ diff --git a/man/sysstat.in b/man/sysstat.in index 77288f6..0515d75 100644 --- a/man/sysstat.in +++ b/man/sysstat.in @@ -1,12 +1,11 @@ -.TH SYSSTAT 5 "MAY 2020" Linux "Linux User's Manual" -*- nroff -*- +.\" sysstat manual page - (C) 2020 Sebastien Godard (sysstat orange.fr) +.TH SYSSTAT 5 "JULY 2020" Linux "Linux User's Manual" -*- nroff -*- .SH NAME sysstat \- sysstat configuration file. + .SH DESCRIPTION This file is read by -.BR sa1 (8) -and -.BR sa2 (8) -shell scripts from the sysstat's set of tools. +.BR "sa1" "(8) and " "sa2" "(8) shell scripts from the sysstat's set of tools." It consists of a sequence of shell variable assignments used to configure sysstat logging. The variables and their meanings are: @@ -14,78 +13,61 @@ The variables and their meanings are: .B COMPRESSAFTER Number of days after which daily data files are to be compressed. The compression program is given in the -.B ZIP -variable. - +.BR "ZIP " "variable." .TP .B DELAY_RANGE -Tell sa2 script to wait for a random delay in the indicated range before running. +.RB "Tell " "sa2" +script to wait for a random delay in the indicated range before running. This delay is expressed in seconds, and is aimed at preventing a massive I/O burst at the same time on VM sharing the same storage area. -A value of 0 means that sa2 script will generate its reports files immediately. - +.RB "A value of 0 means that " "sa2" +script will generate its reports files immediately. .TP .B HISTORY The number of days during which a daily data file or a report should be kept. Data files or reports older than this number of days will be removed by the -.BR sa2 (8) -shell script. +.BR "sa2" "(8) shell script." Data files and reports are normally saved in the @SA_DIR@ directory, under the name -.IR saDD -(for data files) or -.IR sarDD -(for reports), where the DD parameter indicates the current day. +.IR "saDD " "(for data files) or " "sarDD " "(for reports), where the " "DD" +parameter indicates the current day. The number of files actually kept in the @SA_DIR@ directory may be slightly higher than the -.B HISTORY -value due to the way the -.B sa2 -script figures -out which files are to be removed (see below "How the -.BR sa2 (8) -script applies -.B HISTORY -value"). Using a value of 28 keeps a whole month's worth of data. If -you set +.BR "HISTORY " "value due to the way the " "sa2" +script figures out which files are to be removed (see below "How the +.BR "sa2" "(8) script applies " "HISTORY" +value"). Using a value of 28 keeps a whole month's worth of data. If you set .B HISTORY to a value greater than 28 then you should consider using -.BR sadc 's -option -D to prevent older data files from being overwritten (see -.BR sadc (8) +.BR "sadc" "'s option " "-D" +to prevent older data files from being overwritten (see +.BR "sadc" "(8)" manual page). In this latter case data files are named -.IR saYYYYMMDD -and reports -.IR sarYYYYMMDD , -where YYYY stands for the current year, MM for the -current month and DD for the current day. +.IR "saYYYYMMDD " "and reports " "sarYYYYMMDD" ", where" +.IR "YYYY " "stands for the current year, " "MM " "for the current month and " "DD" +for the current day. How the -.BR sa2 (8) -script applies -.B HISTORY -value +.BR "sa2" "(8) script applies " "HISTORY " "value" -The -.B sa2 -script uses the "find" command with the "-mtime" option to figure -out which files are to be removed. The "find" command interprets this value +.RB "The " "sa2" +script uses the +.BR "find " "command with the " "-mtime " "option to figure" +out which files are to be removed. The +.BR "find " "command interprets this value" as "N 24 hour periods", ignoring any fractional part. This means that the -last modified time of a given sa[r]DD data or report file, using a +last modified time of a given +.IR "sa[r]DD " "data or report file, using a" .B HISTORY of 1, has to have been modified at least two days ago before it will be removed. And for a -.B HISTORY -of 28 that would mean 29 days ago. +.BR "HISTORY " "of 28 that would mean 29 days ago." -To figure out how a -.B HISTORY -of 28 is applied in practice, we need to -consider that the -.B sa2 -script that issues the "find" command to remove the +.RB "To figure out how a " "HISTORY" +of 28 is applied in practice, we need to consider that the +.BR "sa2 " "script that issues the " "find " "command to remove the" old files typically runs just before mid-night on a given system, and since the first record from .B sadc @@ -102,8 +84,7 @@ April 30th: 31 files (Apr 30th-1st, Mar 31th) .br May 1st: 30 files (May 1st, Apr 30th-2nd) -Yet we can note the following exceptions (as inspected at Noon of the given -day): +Yet we can note the following exceptions (as inspected at Noon of the given day): February 28th: 31 files (Feb 28th-1st, Jan 31st, 30th & 29th) .br @@ -124,63 +105,57 @@ March 31st: 31 files (Determining the number of files in March on a leap year is left as an exercise for the reader). -Things are simpler if you use the sa[r]YYYYMMDD name format. +Things are simpler if you use the +.IR "sa[r]YYYYMMDD " "name format." Apply the same logic as above in this case and you will find that there are always -.B HISTORY -+ 3 files in the +.BR "HISTORY " "+ 3 files in the" .IR /var/log/sa directory during the majority of a given day. - .TP .B REPORTS -Set this variable to false to prevent the -.B sa2 +Set this variable to +.BR "false " "to prevent the " "sa2" script from generating reports (the -.IR sarDD -files). - +.IR "sarDD " "files)." .TP .B SA_DIR Directory where the standard system activity daily data and report files are saved. Its default value is -.IR @SA_DIR@ . - +.IR "@SA_DIR@" "." .TP .B SADC_OPTIONS Options that should be passed to -.BR sadc (8). +.BR "sadc" "(8)." With these options (see -.BR sadc (8) +.BR "sadc" "(8)" manual page), you can select some additional data which are going to be saved in daily data files. These options are used only when a new data file is created. They will be ignored with an already existing one. - .TP .B YESTERDAY -By default -.BR sa2 -script generates yesterday's summary, since the cron job +.RB "By default " "sa2" +script generates yesterday's summary, since the +.BR "cron " "job" usually runs right after midnight. If you want -.BR sa2 +.B sa2 to generate the summary of the same day (for example when cron -job runs at 23:53) set this variable to no. - +job runs at 23:53) set this variable to +.BR "no" "." .TP .B ZIP Program used to compress data and report files. -.SH FILES -.IR @SYSCONFIG_DIR@/sysstat +.SH FILE +.I @SYSCONFIG_DIR@/sysstat .SH AUTHOR Sebastien Godard (sysstat orange.fr) -.SH SEE ALSO -.BR sadc (8), -.BR sa1 (8), -.BR sa2 (8) +.SH SEE ALSO +.BR "sadc" "(8), " "sa1" "(8), " "sa2" "(8)" +.PP .I https://github.com/sysstat/sysstat - +.br .I http://pagesperso-orange.fr/sebastien.godard/ diff --git a/man/tapestat.1 b/man/tapestat.1 index 5b8a2a0..7ee64b1 100644 --- a/man/tapestat.1 +++ b/man/tapestat.1 @@ -1,46 +1,32 @@ +.\" tapestat manual page - (C) 2015 Hewlett-Packard Development Company, L.P. +.\" Maintained by Sebastien Godard (sysstat orange.fr) .TH TAPESTAT 1 "JUNE 2020" Linux "Linux User's Manual" -*- nroff -*- .SH NAME tapestat \- Report tape statistics. + .SH SYNOPSIS .B tapestat [ -k | -m ] [ -t ] [ -V ] [ -y ] [ -z ] [ --human ] [ -.I interval -.B [ -.I count -.B ] ] +.IB "interval " "[ " "count " "] ]" + .SH DESCRIPTION -The -.B tapestat +.RB "The " "tapestat" command is used for monitoring the activity of tape drives connected to a system. - +.PP The first report generated by the -.B tapestat -command provides statistics +.BR "tapestat " "command provides statistics" concerning the time since the system was booted, unless the .B -y option is used, when this first report is omitted. -Each subsequent report -covers the time since the previous report. - -The -.I interval -parameter specifies the amount of time in seconds between -each report. -The +Each subsequent report covers the time since the previous report. +.PP +.RI "The " "interval" +parameter specifies the amount of time in seconds between each report. The .I count parameter can be specified in conjunction with the -.I interval -parameter. If the -.I count -parameter is specified, the value of -.I count +.IR "interval " "parameter. If the " "count " "parameter is specified, the value of " "count" determines the number of reports generated at -.I interval -seconds apart. If the -.I interval -parameter is specified without the -.I count -parameter, the -.B tapestat +.IR "interval " "seconds apart. If the " "interval " "parameter is specified without the " "count" +.RB "parameter, the " "tapestat" command generates reports continuously. .SH REPORT @@ -48,92 +34,75 @@ The .B tapestat report provides statistics for each tape drive connected to the system. The following data are displayed: - -.B r/s -.RS +.IP r/s The number of reads issued expressed as the number per second averaged over the interval. - -.RE -.B w/s -.RS +.IP w/s The number of writes issued expressed as the number per second averaged over the interval. - -.RE -.B kB_read/s | MB_read/s -.RS -The amount of data read expressed in kilobytes (by default or if option -k used) or -megabytes (if option -m used) per second averaged over the interval. - -.RE -.B kB_wrtn/s | MB_wrtn/s -.RS -The amount of data written expressed in kilobytes (by default or if option -k used) or -megabytes (if option -m used) per second averaged over the interval. - -.RE -.B %Rd -.RS +.IP "kB_read/s | MB_read/s" +The amount of data read expressed in kilobytes (by default or if option +.BR "-k " "used) or megabytes (if option " "-m" +used) per second averaged over the interval. +.IP "kB_wrtn/s | MB_wrtn/s" +The amount of data written expressed in kilobytes (by default or if option +.BR "-k " "used) or megabytes (if option " "-m" +used) per second averaged over the interval. +.IP %Rd Read percentage wait - The percentage of time over the interval spent waiting for read requests to complete. The time is measured from when the request is dispatched to the SCSI mid-layer until it signals that it completed. - -.RE -.B %Wr -.RS +.IP %Wr Write percentage wait - The percentage of time over the interval spent waiting for write requests to complete. The time is measured from when the request is dispatched to the SCSI mid-layer until it signals that it completed. - -.RE -.B %Oa -.RS +.IP %Oa Overall percentage wait - The percentage of time over the interval spent waiting for any I/O request to complete (read, write, and other). - -.RE -.B Rs/s -.RS +.IP Rs/s The number of I/Os, expressed as the number per second averaged over the interval, where a non-zero residual value was encountered. - -.RE -.B Ot/s -.RS +.IP Ot/s The number of I/Os, expressed as the number per second averaged over the interval, that were included as "other". Other I/O includes ioctl calls made to the tape driver and implicit operations performed by the tape driver such as rewind on close (for tape devices that implement rewind on close). It does not include any I/O performed using methods outside of the tape driver (e.g. via sg ioctls). -.RE -.RE + .SH OPTIONS -.IP --human +.TP +.B --human Print sizes in human readable format (e.g. 1.0k, 1.2M, etc.) The units displayed with this option supersede any other default units (e.g. kilobytes, sectors...) associated with the metrics. -.IP -k +.TP +.B -k Show the amount of data written or read in kilobytes per second instead of megabytes. -This option is mutually exclusive with -m. -.IP -m +This option is mutually exclusive with +.BR "-m" "." +.TP +.B -m Show the amount of data written or read in megabytes per second instead of kilobytes. -This option is mutually exclusive with -k. -.IP -t +This option is mutually exclusive with +.BR "-k" "." +.TP +.B -t Display time stamps. The time stamp format may depend -on the value of the S_TIME_FORMAT environment variable (see below). -.IP -V +on the value of the +.BR "S_TIME_FORMAT " "environment variable (see below)." +.TP +.B -V Print version and exit. -.IP -y +.TP +.B -y Omit the initial statistic showing values since boot. -.IP -z -Tell -.B tapestat +.TP +.B -z +.RB "Tell " "tapestat" to omit output for any tapes for which there was no activity during the sample period. .SH CONSIDERATIONS -It is possible for a percentage value (read, write, or other) to be greater than 100 percent -(the +It is possible for a percentage value (read, write, or other) to be greater than 100 percent (the .B tapestat command will never show a percentage value more than 999). If rewinding a tape takes 40 seconds where the interval time is 5 seconds the %Oa value @@ -155,13 +124,14 @@ to be doing a lot more filesystem I/O because of the higher throughput. Although tape statistics are implemented in the kernel using atomic variables they cannot be read atomically as a group. All of the statistics values are read from different files under -/sys, because of this there may be I/O completions while reading the different files for the +.IR "/sys" "," +because of this there may be I/O completions while reading the different files for the one tape drive. This may result in a set of statistics for a device that contain some values before an I/O completed and some after. This command uses rounding down as the rounding method when calculating per second statistics. -If, for example, you are using dd to copy one tape to another and running -.B tapestat +If, for example, you are using +.BR "dd " "to copy one tape to another and running " "tapestat" with an interval of 5 seconds and over the interval there were 3210 writes and 3209 reads then w/s would show 642 and r/s 641 (641.8 rounded down to 641). In such a case if it was a tar archive being copied (with a 10k block size) you would also see a difference between @@ -174,94 +144,90 @@ tracked per device and can potentially have an effect on the per second statisti The time each set of statistics is captured is kept with those statistics. The difference between the current and previous time is converted to milliseconds for use in calculations. We can look at how this can impact the statistics reported if we use an example of a tar -archive being copied between two tape drives using dd. If both devices reported 28900 kilobytes +archive being copied between two tape drives using +.BR "dd" "." +If both devices reported 28900 kilobytes transferred and the reading tape drive had an interval of 5001 milliseconds and the writing tape drive 5000 milliseconds that would calculate out as 5778 kB_read/s and 5780 kB_wrtn/s. The impact of some retrieving statistics during an I/O completion, rounding down, and small differences in the interval period on the statistics calculated should be minimal but may be non-zero. + .SH ENVIRONMENT -The -.B tapestat +.RB "The " "tapestat" command takes into account the following environment variables: - -.IP S_COLORS +.TP +.B S_COLORS By default statistics are displayed in color when the output is connected to a terminal. Use this variable to change the settings. Possible values for this variable are -.IR never , -.IR always -or -.IR auto +.IR "never" ", " "always " "or " "auto" (the latter is equivalent to the default settings). - +.br Please note that the color (being red, yellow, or some other color) used to display a value is not indicative of any kind of issue simply because of the color. It only indicates different ranges of values. - -.IP S_COLORS_SGR +.TP +.B S_COLORS_SGR Specify the colors and other attributes used to display statistics on the terminal. Its value is a colon-separated list of capabilities that defaults to -.BR H=31;1:I=32;22:M=35;1:N=34;1:Z=34;22 . +.BR "H=31;1:I=32;22:M=35;1:N=34;1:Z=34;22" "." Supported capabilities are: - .RS .TP .B H= SGR (Select Graphic Rendition) substring for percentage values greater than or equal to 75%. - .TP .B I= SGR substring for tape names. - .TP .B M= SGR substring for percentage values in the range from 50% to 75%. - .TP .B N= SGR substring for non-zero statistics values. - .TP .B Z= SGR substring for zero values. .RE - -.IP S_TIME_FORMAT +.TP +.B S_TIME_FORMAT If this variable exists and its value is .BR ISO then the current locale will be ignored when printing the date in the report header. The .B tapestat command will use the ISO 8601 format (YYYY-MM-DD) instead. -The timestamp displayed with option -t will also be compliant with ISO 8601 -format. +The timestamp displayed with option +.B -t +will also be compliant with ISO 8601 format. .SH BUGS -.I /sys -filesystem must be mounted for +.IR "/sys " "filesystem must be mounted for" .B tapestat to work. It will not work on kernels that do not have sysfs support - +.PP This command requires kernel version 4.2 or later (or tape statistics support backported for an earlier kernel version). - -Although -.B tapestat +.PP +.RB "Although " "tapestat" speaks of kilobytes (kB), megabytes (MB)..., it actually uses kibibytes (kiB), mebibytes (MiB)... A kibibyte is equal to 1024 bytes, and a mebibyte is equal to 1024 kibibytes. + .SH FILES .I /sys/class/scsi_tape/st/stats/* +.RS Statistics files for tape devices. +.RE +.PP +.IR "/proc/uptime " "contains system uptime." -.I /proc/uptime -contains system uptime. .SH AUTHOR Initial revision by Shane M. SEYMOUR (shane.seymour hpe.com) .br Modified for sysstat by Sebastien Godard (sysstat orange.fr) -.SH SEE ALSO -.BR iostat (1), -.BR mpstat (1) +.SH SEE ALSO +.BR "iostat" "(1), " "mpstat" "(1)" +.PP .I https://github.com/sysstat/sysstat - +.br .I http://pagesperso-orange.fr/sebastien.godard/ -- 2.40.0