xref: /freebsd/usr.sbin/gstat/gstat.8 (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
1.\" Copyright (c) 2003 Giorgos Keramidas
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd November 10, 2016
28.Dt GSTAT 8
29.Os
30.Sh NAME
31.Nm gstat
32.Nd print statistics about GEOM disks
33.Sh SYNOPSIS
34.Nm
35.Op Fl abBcdops
36.Op Fl f Ar filter
37.Op Fl I Ar interval
38.Sh DESCRIPTION
39The
40.Nm
41utility can be used to monitor I/O transactions of
42.Xr geom 4
43devices.
44.Pp
45The options are as follows:
46.Bl -tag -width indent
47.It Fl a
48Only display providers that are at least 0.1% busy.
49.It Fl b
50Batch mode.
51Collect numbers, print and exit.
52Default if stdout is not a tty.
53.It Fl B
54Endless batch mode.
55Same as batch mode, but does not exit after collecting
56the first set of data.
57.It Fl c
58Enable display of
59.Xr geom 4
60consumers too.
61The default is to show statistics only for
62.Xr geom 4
63producers.
64.It Fl d
65Enable display of statistics for delete
66.Pq Dv BIO_DELETE
67operations.
68.It Fl f Ar filter
69A regular expression that can be used to only show statistics for some
70devices.
71Only devices with the names matching
72.Ar filter
73will be displayed.
74The format of the regular expression is described in
75.Xr re_format 7 .
76.It Fl o
77Enable display of statistics for other operations
78.Pq Dv BIO_FLUSH .
79.It Fl s
80Enable blocks' size statistics.
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 p
94Only display physical providers (those with rank of 1).
95.El
96.Sh EXIT STATUS
97.Ex -std
98.Sh SEE ALSO
99.Xr systat 1 ,
100.Xr geom 4 ,
101.Xr iostat 8 ,
102.Xr vmstat 8
103.Sh HISTORY
104A
105.Nm
106utility appeared in
107.Fx 5.0 .
108