xref: /freebsd/usr.sbin/gstat/gstat.8 (revision 9336e0699bda8a301cd2bfa37106b6ec5e32012e)
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 May 20, 2006
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 acd
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 c
50Enable display of
51.Xr geom 4
52consumers too.
53The default is to show statistics only for
54.Xr geom 4
55producers.
56.It Fl d
57Enable display of statistics for delete
58.Pq Dv BIO_DELETE
59operations.
60.It Fl f Ar filter
61A regular expression that can be used to only show statistics for some
62devices.
63Only devices with the names matching
64.Ar filter
65will be displayed.
66The format of the regular expression is described in
67.Xr re_format 7 .
68.It Fl I Ar interval
69Refresh the
70.Nm
71display every
72.Ar interval
73microseconds.
74Adding a suffix of
75.Cm s , ms ,
76or
77.Cm us
78(the default) indicates that the update interval is specified in
79seconds, milliseconds, or microseconds, respectively.
80.El
81.Sh EXIT STATUS
82.Ex -std
83.Sh SEE ALSO
84.Xr systat 1 ,
85.Xr geom 4 ,
86.Xr iostat 8 ,
87.Xr vmstat 8
88.Sh HISTORY
89A
90.Nm
91utility appeared in
92.Fx 5.0 .
93.Sh BUGS
94The
95.Nm
96utility only works interactively.
97It should probably detect when it is run non-interactively and produce
98simple
99.Tn ASCII
100text output.
101Otherwise, this utility should probably be folded into
102.Xr systat 1
103which only works interactively and is the obvious utility to run for
104various other forms of system statistics.
105