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 .\"
  30 .Dd June 5, 2023
  31 .Dt NFSSTAT 1
  32 .Os
  33 .Sh NAME
  34 .Nm nfsstat
  35 .Nd display
  36 .Tn NFS
  37 statistics
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl -libxo
  41 .Op Fl cdEemszW
  42 .Op Fl w Ar wait
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 command displays statistics kept about
  47 .Tn NFS
  48 client and server activity.
  49 For the NFSv4 server, the statistics are for operations within the Compound
  50 RPCs and not the count of RPCs.
  51 If you wish to compare RPC counts between NFSv3 and NFSv4, you must use
  52 statistics in the client(s).
  53 .Pp
  54 The options are as follows:
  55 .Bl -tag -width "-w wait"
  56 .It Fl c
  57 Only display client side statistics.
  58 .It Fl d
  59 Display statistics for the NFS server that are similar to those
  60 displayed by
  61 .Xr iostat 8 .
  62 This includes kilobytes per transfer, transfers per second, and megabytes per
  63 second for read, write, and all operations.
  64 It also includes the current queue depth, the busy percentage, and latency
  65 for all operations.
  66 If the
  67 .Fl W
  68 flag is added, commits per second, commit latency, read latency, and write
  69 latency are also added to the display.
  70 The busy percentage shown can exceed 100 at times.
  71 This is because of the way busy percentages are calculated.
  72 The busy time is calculated by adding the elapsed time between the
  73 last time an operation started or finished,
  74 and the current time.
  75 If there is only one operation outstanding, the "busy time" time
  76 will get updated with the total time of that operation.
  77 That means that the difference in the busy time between the two
  78 measurement intervals (often 1 second)
  79 will increase by more than the measurement interval.
  80 .It Fl e
  81 Report the extra statistics collected by the NFS client and
  82 server for NFSv4.
  83 .It Fl E
  84 Similar to
  85 .Fl e
  86 except that the statistics include NFSv4.1 and NFSv4.2 and the numbers aren't
  87 clipped at one billion.
  88 Only one of
  89 .Fl e
  90 or
  91 .Fl E
  92 can be specified.
  93 .It Fl M
  94 Deprecated and ignored.
  95 .It Fl m
  96 Report the mount options for all NFS client mounts.
  97 This option overrides all others and
  98 .Nm
  99 will exit after completing the report.
 100 .It Fl N
 101 Deprecated and ignored.
 102 .It Fl s
 103 Only display server side statistics.
 104 .It Fl W
 105 Use wide format with interval short summary.
 106 This option is especially
 107 useful when combined with
 108 .Fl c ,
 109 .Fl d ,
 110 or
 111 .Fl s
 112 and a time delay.
 113 .It Fl w Ar wait
 114 Display a shorter summary of
 115 .Tn NFS
 116 activity for both the client and server at
 117 .Ar wait
 118 second intervals.
 119 .It Fl z
 120 Reset statistics after displaying them.
 121 .It Fl q
 122 Do not print header
 123 .It Fl -libxo
 124 Generate output via
 125 .Xr libxo 3
 126 in a selection of different human and machine readable formats.
 127 See
 128 .Xr xo_parse_args 3
 129 for details on command line arguments.
 130 .El
 131 .Sh SEE ALSO
 132 .Xr fstat 1 ,
 133 .Xr netstat 1 ,
 134 .Xr ps 1 ,
 135 .Xr systat 1 ,
 136 .Xr sysctl 3 ,
 137 .Xr iostat 8 ,
 138 .Xr nfsdumpstate 8 ,
 139 .Xr pstat 8 ,
 140 .Xr vmstat 8
 141 .Sh HISTORY
 142 The
 143 .Nm
 144 command appeared in
 145 .Bx 4.4 .