usr.bin/nfsstat/nfsstat.1

   1 .\" Copyright (c) 1989, 1990, 1993
   2 .\"     The Regents of the University of California.  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 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     From: @(#)nfsstat.1     8.1 (Berkeley) 6/6/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd October 1, 2018
  32 .Dt NFSSTAT 1
  33 .Os
  34 .Sh NAME
  35 .Nm nfsstat
  36 .Nd display
  37 .Tn NFS
  38 statistics
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Op Fl -libxo
  42 .Op Fl cdEemszW
  43 .Op Fl M Ar core
  44 .Op Fl N Ar system
  45 .Op Fl w Ar wait
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 command displays statistics kept about
  50 .Tn NFS
  51 client and server activity.
  52 For the NFSv4 server, the statistics are for operations within the Compound
  53 RPCs and not the count of RPCs.
  54 If you wish to compare RPC counts between NFSv3 and NFSv4, you must use
  55 statistics in the client(s).
  56 .Pp
  57 The options are as follows:
  58 .Bl -tag -width indent
  59 .It Fl c
  60 Only display client side statistics.
  61 .It Fl d
  62 Display statistics for the NFS server that are similar to those
  63 displayed by
  64 .Xr iostat 8 .
  65 This includes kilobytes per transfer, transfers per second, and megabytes per
  66 second for read, write, and all operations.
  67 It also includes the current queue depth, the busy percentage, and latency
  68 for all operations.
  69 If the
  70 .Fl W
  71 flag is added, commits per second, commit latency, read latency, and write
  72 latency are also added to the display.
  73 The busy percentage shown can exceed 100 at times.
  74 This is because of the way busy percentages are calculated.
  75 The busy time is calculated by adding the elapsed time between the
  76 last time an operation started or finished,
  77 and the current time.
  78 If there is only one operation outstanding, the "busy time" time
  79 will get updated with the total time of that operation.
  80 That means that the difference in the busy time between the two
  81 measurement intervals (often 1 second)
  82 will increase by more than the measurement interval.
  83 .It Fl e
  84 Report the extra statistics collected by the NFS client and
  85 server for NFSv4.
  86 .It Fl E
  87 Similar to
  88 .Fl e
  89 except that the statistics include NFSv4.1 and the numbers aren't clipped
  90 at one billion.
  91 Only one of
  92 .Fl e
  93 or
  94 .Fl E
  95 can be specified.
  96 .It Fl M
  97 Extract values associated with the name list from the specified core
  98 instead of the default
  99 .Pa /dev/kmem .
 100 .It Fl m
 101 Report the mount options for all NFS client mounts.
 102 This option overrides all others and
 103 .Nm
 104 will exit after completing the report.
 105 .It Fl N
 106 Extract the name list from the specified system instead of the default
 107 .Pa /boot/kernel/kernel .
 108 .It Fl s
 109 Only display server side statistics.
 110 .It Fl W
 111 Use wide format with interval short summary.
 112 This option is especially
 113 useful when combined with
 114 .Fl c ,
 115 .Fl d ,
 116 or
 117 .Fl s
 118 and a time delay.
 119 .It Fl w
 120 Display a shorter summary of
 121 .Tn NFS
 122 activity for both the client and server at
 123 .Ar wait
 124 second intervals.
 125 .It Fl z
 126 Reset statistics after displaying them.
 127 .It Fl q
 128 Do not print header
 129 .It Fl -libxo
 130 Generate output via
 131 .Xr libxo 3
 132 in a selection of different human and machine readable formats.
 133 See
 134 .Xr xo_parse_args 3
 135 for details on command line arguments.
 136 .El
 137 .Sh FILES
 138 .Bl -tag -width ".Pa /boot/kernel/kernel" -compact
 139 .It Pa /boot/kernel/kernel
 140 default kernel namelist
 141 .It Pa /dev/kmem
 142 default memory file
 143 .El
 144 .Sh SEE ALSO
 145 .Xr fstat 1 ,
 146 .Xr netstat 1 ,
 147 .Xr ps 1 ,
 148 .Xr systat 1 ,
 149 .Xr sysctl 3 ,
 150 .Xr iostat 8 ,
 151 .Xr nfsdumpstate 8 ,
 152 .Xr pstat 8 ,
 153 .Xr vmstat 8
 154 .Sh HISTORY
 155 The
 156 .Nm
 157 command appeared in
 158 .Bx 4.4 .