usr.sbin/gstat/gstat.8

   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 .Dd January 1, 2021
  26 .Dt GSTAT 8
  27 .Os
  28 .Sh NAME
  29 .Nm gstat
  30 .Nd print statistics about GEOM disks
  31 .Sh SYNOPSIS
  32 .Nm
  33 .Op Fl abBcdops
  34 .Op Fl f Ar filter
  35 .Op Fl I Ar interval
  36 .Sh DESCRIPTION
  37 The
  38 .Nm
  39 utility can be used to monitor I/O transactions of
  40 .Xr geom 4
  41 devices.
  42 .Pp
  43 The options are as follows:
  44 .Bl -tag -width indent
  45 .It Fl a
  46 Only display providers that are at least 0.1% busy.
  47 .It Fl b
  48 Batch mode.
  49 Collect numbers, print and exit.
  50 Default if stdout is not a tty.
  51 .It Fl B
  52 Endless batch mode.
  53 Same as batch mode, but does not exit after collecting
  54 the first set of data.
  55 .It Fl c
  56 Enable display of
  57 .Xr geom 4
  58 consumers too.
  59 The default is to show statistics only for
  60 .Xr geom 4
  61 producers.
  62 .It Fl C
  63 CSV output mode.
  64 Implies endless batch mode, but output is in the form of comma-separated
  65 values, with ISO 8601-like timestamps.
  66 .It Fl d
  67 Enable display of statistics for delete
  68 .Pq Dv BIO_DELETE
  69 operations.
  70 .It Fl f Ar filter
  71 A regular expression that can be used to only show statistics for some
  72 devices.
  73 Only devices with the names matching
  74 .Ar filter
  75 will be displayed.
  76 The format of the regular expression is described in
  77 .Xr re_format 7 .
  78 .It Fl o
  79 Enable display of statistics for other operations
  80 .Pq Dv BIO_FLUSH .
  81 .It Fl s
  82 Enable blocks' size statistics.
  83 .It Fl I Ar interval
  84 Refresh the
  85 .Nm
  86 display every
  87 .Ar interval
  88 microseconds.
  89 Adding a suffix of
  90 .Cm s , ms ,
  91 or
  92 .Cm us
  93 (the default) indicates that the update interval is specified in
  94 seconds, milliseconds, or microseconds, respectively.
  95 .It Fl p
  96 Only display physical providers (those with rank of 1).
  97 .El
  98 .Sh INTERACTIVE COMMANDS
  99 These commands are currently recognized if
 100 .Nm
 101 is not running in batch mode:
 102 .Bl -tag -width indent
 103 .It Ic <
 104 Halve the update interval.
 105 .It Ic >
 106 Double the update interval.
 107 .It Ic c
 108 Toggle display of
 109 .Xr geom 4
 110 consumers.
 111 .It Ic f
 112 Display only devices with the names matching regular expression filter
 113 (prompt for filter).
 114 .It Ic F
 115 Remove device filter.
 116 .It Ic q
 117 Quit
 118 .Nm .
 119 .El
 120 .Sh EXIT STATUS
 121 .Ex -std
 122 .Sh SEE ALSO
 123 .Xr systat 1 ,
 124 .Xr geom 4 ,
 125 .Xr iostat 8 ,
 126 .Xr vmstat 8
 127 .Sh HISTORY
 128 A
 129 .Nm
 130 utility appeared in
 131 .Fx 5.0 .