xref: /freebsd/usr.sbin/gstat/gstat.8 (revision 8b35839346d0bd8d4244018489bfdef8fd48de53)
1.\"
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 2003 Giorgos Keramidas
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd February 1, 2025
29.Dt GSTAT 8
30.Os
31.Sh NAME
32.Nm gstat
33.Nd print statistics about GEOM disks
34.Sh SYNOPSIS
35.Nm
36.Op Fl abBcCdops
37.Op Fl f Ar filter
38.Op Fl I Ar interval
39.Sh DESCRIPTION
40The
41.Nm
42utility can be used to monitor I/O transactions of
43.Xr geom 4
44devices.
45.Pp
46The options are as follows:
47.Bl -tag -width indent
48.It Fl a
49Only display providers that are at least 0.1% busy.
50.It Fl b
51Batch mode.
52Collect numbers, print and exit.
53Default if stdout is not a tty.
54.It Fl B
55Endless batch mode.
56Same as batch mode, but does not exit after collecting
57the first set of data.
58.It Fl c
59Enable display of
60.Xr geom 4
61consumers too.
62The default is to show statistics only for
63.Xr geom 4
64producers.
65.It Fl C
66CSV output mode.
67Implies endless batch mode, but output is in the form of comma-separated
68values, with ISO 8601-like timestamps.
69.It Fl d
70Enable display of statistics for delete
71.Pq Dv BIO_DELETE
72operations.
73.It Fl f Ar filter
74A regular expression that can be used to only show statistics for some
75devices.
76Only devices with the names matching
77.Ar filter
78will be displayed.
79The format of the regular expression is described in
80.Xr re_format 7 .
81.It Fl I Ar interval
82Refresh the
83.Nm
84display every
85.Ar interval
86microseconds.
87Adding a suffix of
88.Cm s , ms ,
89or
90.Cm us
91(the default) indicates that the update interval is specified in
92seconds, milliseconds, or microseconds, respectively.
93.It Fl o
94Enable display of statistics for other operations
95.Pq Dv BIO_FLUSH .
96.It Fl p
97Only display physical providers (those with rank of 1).
98.It Fl s
99Enable blocks' size statistics.
100.El
101.Sh INTERACTIVE COMMANDS
102These commands are currently recognized if
103.Nm
104is not running in batch mode:
105.Bl -tag -width indent
106.It Ic <
107Halve the update interval.
108.It Ic >
109Double the update interval.
110.It Ic c
111Toggle display of
112.Xr geom 4
113consumers.
114.It Ic f
115Display only devices with the names matching regular expression filter
116(prompt for filter).
117.It Ic F
118Remove device filter.
119.It Ic q
120Quit
121.Nm .
122.El
123.Sh EXIT STATUS
124.Ex -std
125.Sh SEE ALSO
126.Xr systat 1 ,
127.Xr geom 4 ,
128.Xr iostat 8 ,
129.Xr vmstat 8
130.Sh HISTORY
131A
132.Nm
133utility appeared in
134.Fx 5.0 .
135