usr.sbin/iostat/iostat.8

.\"	$NetBSD: iostat.8,v 1.25 2017/03/05 23:07:12 mlelstv Exp $
.\"
.\" Copyright (c) 1985, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	from: @(#)iostat.8	8.1 (Berkeley) 6/6/93
.\"
.Dd July 9, 2015
.Dt IOSTAT 8
.Os
.Sh NAME
.Nm iostat
.Nd report
.Tn I/O
statistics
.Sh SYNOPSIS
.Nm
.Op Fl CdDITxy
.Op Fl c Ar count
.Op Fl w Ar wait
.Op Ar drives
.Sh DESCRIPTION
.Nm
displays kernel
.Tn I/O
statistics on terminal, disk and CPU operations.
By default,
.Nm
displays one line of statistics averaged over the machine's run time.
The use of
.Fl c
presents successive lines averaged over the
.Ar wait
period.
The
.Fl I
option causes
.Nm
to print raw, unaveraged values.
.Pp
Only the last disk option specified
.Fl ( d ,
.Fl D ,
or
.Fl x )
is used.
.Pp
The options are as follows:
.Bl -tag -width XNXsystemX
.It Fl c Ar count
Repeat the display
.Ar count
times.
Unless the
.Fl I
flag is in effect, the first display is for the time since a reboot and
each subsequent report is for the time period since the last display.
If no
.Ar wait
interval is specified, the default is 1 second.
.It Fl C
Show CPU statistics.
This is enabled by default unless the
.Fl d ,
.Fl D ,
.Fl T ,
or
.Fl x
flags are used.
.It Fl d
Show disk statistics.
This is the default.
Displays kilobytes per
transfer, number of transfers, and megabytes transferred.
Use of this flag disables display of CPU and tty statistics.
.It Fl D
Show alternative disk statistics.
Displays kilobytes transferred, number of
transfers, and time spent in transfers.
Use of this flag disables the default display.
.It Fl I
Show the running total values, rather than an average.
.It Fl T
Show tty statistics.
This is enabled by default unless the
.Fl C ,
.Fl d ,
or
.Fl D
flags are used.
.It Fl w Ar wait
Pause
.Ar wait
seconds between each display.
If no repeat
.Ar count
is specified, the default is infinity.
.It Fl x
Show extended disk statistics.
Each disk is displayed on a line of its own with all available
statistics.
This option overrides all other display options, and all
disks are displayed unless specific disks
are provided as arguments.
Additionally, separate read and write statistics are displayed.
.It Fl y
Shows the extended statistics and additional queuing statistics.
.El
.Pp
.Nm
displays its information in the following format:
.Bl -tag -width flag
.It tty
.Bl -tag -width indent -compact
.It tin
characters read from terminals
.It tout
characters written to terminals
.El
.It disks
Disk operations.
The header of the field is the disk name and unit number.
If more drives are configured in the system that fit across the
current display,
.Nm
displays only those drives that fit on the display.
To force
.Nm
to display specific drives, they may be supplied on the command
line, either as names or
.Fn fnmatch
patterns.
.Pp
.Bl -tag -width indent -compact
.It KB/t
Kilobytes transferred per disk transfer
.It t/s
transfers per second
.It MB/s
Megabytes transferred per second
.Pp
.El
The alternative display format, (selected with
.Fl D ) ,
presents the following values.
.Bl -tag -width indent -compact
.It KB
Kilobytes transferred
.It xfr
Disk transfers
.It time
Seconds spent in disk activity
.Pp
.El
With the
.Fl y
flag, the following queuing measurements are added
.Bl -tag -width indent -compact
.It wait
Number of I/O requests queued up
.It actv
Number of currently active I/O requests
.It wsvc_t
Average waiting time of an I/O request in milliseconds
.It asvc_t
Average duration of an I/O request in milliseconds
.It wtime
Seconds spent in the waiting queue.
Queuing data might not be available from all drivers
and is then shown as zeros.
.El
.It cpu
.Bl -tag -width indent -compact
.It \&us
% of CPU time in user mode
.It \&ni
% of CPU time in user mode running niced processes
.It \&sy
% of CPU time in system mode
.It \&id
% of CPU time in idle mode
.El
.El
.Sh SEE ALSO
.Xr fstat 1 ,
.Xr netstat 1 ,
.Xr nfsstat 1 ,
.Xr \&ps 1 ,
.Xr systat 1 ,
.Xr vmstat 1 ,
.Xr fnmatch 3 ,
.Xr pstat 8
.Pp
The sections starting with ``Interpreting system activity'' in
.%T "Installing and Operating 4.3BSD" .
.Sh HISTORY
.Nm
appeared in
.At v6 .
The
.Fl x
option was added in
.Nx 1.4 .
Collection of queueing values and the
.Fl y
option were added in
.Nx 8.0 .