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