| 1 |
.\" cifsiostat manual page - (C) 2020 Sebastien Godard (sysstat <at> orange.fr) |
| 2 |
.TH CIFSIOSTAT 1 "AUGUST 2023" Linux "Linux User's Manual" -*- nroff -*- |
| 3 |
.SH NAME |
| 4 |
cifsiostat \- Report CIFS statistics. |
| 5 |
|
| 6 |
.SH SYNOPSIS |
| 7 |
.ie 'yes'no' \{ |
| 8 |
.B cifsiostat [ \-h ] [ \-k | \-m ] [ \-t ] [ \-V ] [ \-\-debuginfo ] [ \-\-dec={ 0 | 1 | 2 } ] [ \-\-human ] [ \-\-pretty ] [ |
| 9 |
.IB "interval " "[ " "count " "] ]" |
| 10 |
.\} |
| 11 |
.el \{ |
| 12 |
.B cifsiostat [ \-h ] [ \-k | \-m ] [ \-t ] [ \-V ] [ \-\-dec={ 0 | 1 | 2 } ] [ \-\-human ] [ \-\-pretty ] [ |
| 13 |
.IB "interval " "[ " "count " "] ]" |
| 14 |
.\} |
| 15 |
|
| 16 |
.SH DESCRIPTION |
| 17 |
The |
| 18 |
.B cifsiostat |
| 19 |
command displays statistics about read and write operations |
| 20 |
on CIFS filesystems. |
| 21 |
.PP |
| 22 |
.RI "The " "interval" |
| 23 |
parameter specifies the amount of time in seconds between |
| 24 |
each report. The first report contains statistics for the time since |
| 25 |
system startup (boot). Each subsequent report contains statistics |
| 26 |
collected during the interval since the previous report. |
| 27 |
A report consists of a CIFS header row followed by |
| 28 |
a line of statistics for each CIFS filesystem that is mounted. |
| 29 |
.RI "The " "count " "parameter can be specified in conjunction with the " "interval " |
| 30 |
.RI "parameter. If the " "count " "parameter is specified, the value of " "count " |
| 31 |
.RI "determines the number of reports generated at " "interval " "seconds apart. If the " "interval " |
| 32 |
.RI "parameter is specified without the " "count " "parameter, the " |
| 33 |
.BR "cifsiostat " "command generates reports continuously." |
| 34 |
|
| 35 |
.SH REPORT |
| 36 |
The CIFS report provides statistics for each mounted CIFS filesystem. |
| 37 |
The report shows the following fields: |
| 38 |
|
| 39 |
.IP Filesystem: |
| 40 |
This columns shows the mount point of the CIFS filesystem. |
| 41 |
.IP "rB/s (rkB/s, rMB/s)" |
| 42 |
Indicate the average number of bytes (kilobytes, megabytes) read per second. |
| 43 |
.IP "wB/s (wkB/s, wMB/s)" |
| 44 |
Indicate the average number of bytes (kilobytes, megabytes) written per second. |
| 45 |
.IP rop/s |
| 46 |
Indicate the number of 'read' operations that were issued to the filesystem |
| 47 |
per second. |
| 48 |
.IP wop/s |
| 49 |
Indicate the number of 'write' operations that were issued to the filesystem |
| 50 |
per second. |
| 51 |
.IP fo/s |
| 52 |
Indicate the number of open files per second. |
| 53 |
.IP fc/s |
| 54 |
Indicate the number of closed files per second. |
| 55 |
.IP fd/s |
| 56 |
Indicate the number of deleted files per second. |
| 57 |
|
| 58 |
.SH OPTIONS |
| 59 |
.if 'yes'no' \{ |
| 60 |
.TP |
| 61 |
.B \-\-debuginfo |
| 62 |
Print debug output to stderr. |
| 63 |
.\} |
| 64 |
.TP |
| 65 |
.B \-\-dec={ 0 | 1 | 2 } |
| 66 |
Specify the number of decimal places to use (0 to 2, default value is 2). |
| 67 |
.TP |
| 68 |
.B \-h |
| 69 |
This option is equivalent to specifying |
| 70 |
.BR "\-\-human \-\-pretty" "." |
| 71 |
.TP |
| 72 |
.B \-\-human |
| 73 |
Print sizes in human readable format (e.g. 1.0k, 1.2M, etc.) |
| 74 |
The units displayed with this option supersede any other default units (e.g. |
| 75 |
kilobytes, sectors...) associated with the metrics. |
| 76 |
.TP |
| 77 |
.B \-k |
| 78 |
Display statistics in kilobytes per second. |
| 79 |
.TP |
| 80 |
.B \-m |
| 81 |
Display statistics in megabytes per second. |
| 82 |
.TP |
| 83 |
.B \-\-pretty |
| 84 |
Make the CIFS report easier to read by a human. |
| 85 |
.TP |
| 86 |
.B \-t |
| 87 |
Print the time for each report displayed. The timestamp format may depend |
| 88 |
on the value of the |
| 89 |
.BR "S_TIME_FORMAT " "environment variable (see below)." |
| 90 |
.TP |
| 91 |
.B \-V |
| 92 |
Print version number then exit. |
| 93 |
|
| 94 |
.SH ENVIRONMENT |
| 95 |
.RB "The " "cifsiostat " "command takes into account the following environment variables: " |
| 96 |
.TP |
| 97 |
.B S_COLORS |
| 98 |
By default statistics are displayed in color when the output is connected to a terminal. |
| 99 |
Use this variable to change the settings. Possible values for this variable are |
| 100 |
.BR "never" ", " "always " "or " "auto " "(the latter is equivalent to the default settings)." |
| 101 |
.br |
| 102 |
Please note that the color (being red, yellow, or some other color) used to display a value |
| 103 |
is not indicative of any kind of issue simply because of the color. It only indicates different |
| 104 |
ranges of values. |
| 105 |
.TP |
| 106 |
.B S_COLORS_SGR |
| 107 |
Specify the colors and other attributes used to display statistics on the terminal. |
| 108 |
Its value is a colon-separated list of capabilities that defaults to |
| 109 |
.BR "I=32;22:N=34;1:Z=34;22" "." |
| 110 |
Supported capabilities are: |
| 111 |
.RS |
| 112 |
.TP |
| 113 |
.B I= |
| 114 |
SGR substring for filesystem names. |
| 115 |
.TP |
| 116 |
.B N= |
| 117 |
SGR substring for non-zero statistics values. |
| 118 |
.TP |
| 119 |
.B Z= |
| 120 |
SGR substring for zero values. |
| 121 |
.RE |
| 122 |
.TP |
| 123 |
.B S_TIME_FORMAT |
| 124 |
If this variable exists and its value is |
| 125 |
.B ISO |
| 126 |
then the current locale will be ignored when printing the date in the report |
| 127 |
header. The |
| 128 |
.B cifsiostat |
| 129 |
command will use the ISO 8601 format (YYYY-MM-DD) instead. |
| 130 |
.RB "The timestamp displayed with option " "\-t " "will also be compliant with ISO 8601 format." |
| 131 |
|
| 132 |
.SH BUG |
| 133 |
.IR "/proc " "filesystem must be mounted for" |
| 134 |
.BR "cifsiostat " "to work." |
| 135 |
.PP |
| 136 |
.RB "Although " "cifsiostat" |
| 137 |
speaks of kilobytes (kB), megabytes (MB)..., it actually uses kibibytes (kiB), mebibytes (MiB)... |
| 138 |
A kibibyte is equal to 1024 bytes, and a mebibyte is equal to 1024 kibibytes. |
| 139 |
|
| 140 |
.SH FILE |
| 141 |
.IR "/proc/fs/cifs/Stats " "contains CIFS statistics." |
| 142 |
|
| 143 |
.SH AUTHORS |
| 144 |
Written by Ivana Varekova (varekova <at> redhat.com) |
| 145 |
.br |
| 146 |
Maintained by Sebastien Godard (sysstat <at> orange.fr) |
| 147 |
|
| 148 |
.SH SEE ALSO |
| 149 |
.BR "sar" "(1), " "pidstat" "(1), " "mpstat" "(1), " "vmstat" "(8), " "iostat" "(1)," |
| 150 |
.BR "tapestat" "(1), " "nfsiostat" "(1)" |
| 151 |
|
| 152 |
.I https://github.com/sysstat/sysstat |
| 153 |
.br |
| 154 |
.I https://sysstat.github.io/ |