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