Debian Codegraph @

upstream/opensuse-tumbleweed/man1/cifsiostat.1

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