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