xref: /freebsd/usr.sbin/gstat/gstat.8 (revision 640235e2c2ba32947f7c59d168437ffa1280f1e6)
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 July 3, 2014
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 abcdop
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 c
54Enable display of
55.Xr geom 4
56consumers too.
57The default is to show statistics only for
58.Xr geom 4
59producers.
60.It Fl d
61Enable display of statistics for delete
62.Pq Dv BIO_DELETE
63operations.
64.It Fl f Ar filter
65A regular expression that can be used to only show statistics for some
66devices.
67Only devices with the names matching
68.Ar filter
69will be displayed.
70The format of the regular expression is described in
71.Xr re_format 7 .
72.It Fl o
73Enable display of statistics for other operations
74.Pq Dv BIO_FLUSH .
75.It Fl I Ar interval
76Refresh the
77.Nm
78display every
79.Ar interval
80microseconds.
81Adding a suffix of
82.Cm s , ms ,
83or
84.Cm us
85(the default) indicates that the update interval is specified in
86seconds, milliseconds, or microseconds, respectively.
87.It Fl p
88Only display physical providers (those with rank of 1).
89.El
90.Sh EXIT STATUS
91.Ex -std
92.Sh SEE ALSO
93.Xr systat 1 ,
94.Xr geom 4 ,
95.Xr iostat 8 ,
96.Xr vmstat 8
97.Sh HISTORY
98A
99.Nm
100utility appeared in
101.Fx 5.0 .
102