-
Notifications
You must be signed in to change notification settings - Fork 12
/
ioztat.8
167 lines (167 loc) · 4.41 KB
/
ioztat.8
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
.Dd January 29, 2022
.Dt IOZTAT 8
.Os
.
.Sh NAME
.Nm ioztat
.Nd display logical I/O statistics for ZFS datasets
.Sh SYNOPSIS
.Nm
.Fl V | Fl -version
.
.Nm
.Fl h | Fl -help
.
.Nm
.Op Fl DeHINnoSxyz
.Op Fl c Ar count
.Op Fl i Ar interval
.Op Fl T Ar u Ns | Ns d
.Op Fl s Ar name Ns | Ns Ar operations Ns | Ns Ar reads Ns | Ns Ar writes Ns | Ns Ar throughput Ns | Ns Ar nread Ns | Ns Ar nwritten
.Op Ar dataset ...
.Op Ar interval Op Ar count
.
.Sh DESCRIPTION
The
.Nm
utility displays logical I/O statistics for individual ZFS datasets.
The first report is averaged over the system uptime unless suppressed with
.Fl y .
If an
.Ar interval
is specified, this is followed by reports averaged over the reporting
.Ar interval .
If
.Fl y
or a
.Ar count
is specified,
.Ar interval
defaults to one second.
.Pp
Underlying device I/O depends on pool and dataset configuration.
See
.Xr zpool-iostat 8
and
.Xr iostat 8
for reporting on these values.
.Pp
To filter output you may pass in a list of datasets.
If no datasets are specified, statistics for every mounted dataset in the system are shown.
If the
.Fl n
option is given, child datasets are not included for any specified dataset unless they are
also directly specified.
.Pp
The options are as follows:
.Bl -tag -width flag
.It Fl D
Display formatted byte sizes using decimal powers of 1000 instead of powers of 1024.
.It Fl c
Display
.Ar count
reports and exit.
This can also be specified after an
.Ar interval
at the end of the argument list.
If
.Ar interval
is specified but not
.Ar count
then it defaults to infinity, otherwise it defaults to one.
.It Fl e
Display exact values, without truncating dataset names (unless
.Fl p
is given) or formatting numeric output.
.It Fl H
Scripted mode, skip headers and tab-separate fields instead of using arbitrary whitespace.
.It Fl h , Fl -help
Display help text and exit.
.It Fl I
Display total statistics since the last report instead of averages per-second.
.It Fl i
Pause
.Ar interval
seconds between reports.
This can also be specified at the end of the argument list, prior to an optional
.Ar count .
If no
.Ar interval
is specified the default is 1 second.
.Pp
The
.Nm
command will accept non-integer intervals, but it should be noted the reporting interval
is not exact.
.It Fl N
Display headers only once, instead of periodically repeating them.
.It Fl n
Omit children of any specified datasets that haven't themselves been explicitly specified.
.It Fl o
Overwrite mode.
Before each report, clear the screen and print only as many lines as will fit.
.It Fl P
Display dataset names on a single line.
.It Fl p
Display dataset names as an indented tree spread across multiple lines.
These options override
defaults that may be applied by different sorting and display modes.
.It Fl S
Sum child dataset statistics into their parents.
This can be useful when combined with
.Fl n
to omit display of child datasets while still seeing associated I/O.
.It Fl s
Sort each report by the specified order.
Defaults to
.Ar name .
.It Fl T Ar u Ns | Ns d
Before each report, display a timestamp.
Specify
.Ar u
for a numeric Unix timestamp in seconds since the epoch, or
.Ar d
for a formatted date-time.
.It Fl V , Fl -version
Display the current version of
.Nm
and exit.
.It Fl x
Specified once, display an opsize group containing throughput divided by operations,
giving the average byte size of each I/O.
Specified twice, also display an unlinks section giving a count of the number of
files and directories queued for deletion, and the number which have been deleted.
.It Fl y
Omit statistics since boot.
This suppresses output for the first
.Ar interval
seconds.
.It Fl z
Omit datasets which have no activity.
.El
.Sh EXAMPLES
.Dl ioztat rpool/USERDATA 1
.Pp
Display per-second statistics for any mounted datasets within rpool/USERDATA.
.Pp
.Dl ioztat -zoTd -s operations 5
.Pp
Display statistics for all mounted datasets with activity across five second intervals,
ordered by total read and write operations, limited by available display and overwriting
prior reports in a manner similar to
.Xr top 1 .
.Pp
.Dl ioztat -SIn rpool
.Pp
Display sum total of I/O for all datasets within rpool since boot.
.Pp
.Dl ioztat -Hey
.Pp
Display a single one-second report for all mounted datasets, using a machine-readable
format omitting headers, using tab-delimited fields, and providing exact values.
.Sh SEE ALSO
.Xr iostat 8 ,
.Xr zfs 8 ,
.Xr zpool-iostat 8
.Sh BUGS
Please report any issues at https://github.com/jimsalterjrs/ioztat/issues