xref: /freebsd/usr.sbin/gstat/gstat.8 (revision 405c3050f102b8c74782f0366c8ead927bd07b68)
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 August 21, 2018
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 C
65CSV output mode.
66Implies endless batch mode, but output is in the form of comma-separated
67values, with ISO 8601-like timestamps.
68.It Fl d
69Enable display of statistics for delete
70.Pq Dv BIO_DELETE
71operations.
72.It Fl f Ar filter
73A regular expression that can be used to only show statistics for some
74devices.
75Only devices with the names matching
76.Ar filter
77will be displayed.
78The format of the regular expression is described in
79.Xr re_format 7 .
80.It Fl o
81Enable display of statistics for other operations
82.Pq Dv BIO_FLUSH .
83.It Fl s
84Enable blocks' size statistics.
85.It Fl I Ar interval
86Refresh the
87.Nm
88display every
89.Ar interval
90microseconds.
91Adding a suffix of
92.Cm s , ms ,
93or
94.Cm us
95(the default) indicates that the update interval is specified in
96seconds, milliseconds, or microseconds, respectively.
97.It Fl p
98Only display physical providers (those with rank of 1).
99.El
100.Sh EXIT STATUS
101.Ex -std
102.Sh SEE ALSO
103.Xr systat 1 ,
104.Xr geom 4 ,
105.Xr iostat 8 ,
106.Xr vmstat 8
107.Sh HISTORY
108A
109.Nm
110utility appeared in
111.Fx 5.0 .
112