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 .\" 4. 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 August 13, 2016
  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 cdemszW
  42 .Op Fl M Ar core
  43 .Op Fl N Ar system
  44 .Op Fl w Ar wait
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 command displays statistics kept about
  49 .Tn NFS
  50 client and server activity.
  51 For the NFSv4 server, the statistics are for operations within the Compound
  52 RPCs and not the count of RPCs.
  53 If you wish to compare RPC counts between NFSv3 and NFSv4, you must use
  54 statistics in the client(s).
  55 .Pp
  56 The options are as follows:
  57 .Bl -tag -width indent
  58 .It Fl c
  59 Only display client side statistics.
  60 .It Fl d
  61 Display statistics for the new NFS server that are similar to those
  62 displayed by
  63 .Xr iostat 8 .
  64 This includes kilobytes per transfer, transfers per second, and megabytes per
  65 second for read, write, and all operations.
  66 It also includes the current queue depth, the busy percentage, and latency
  67 for all operations.
  68 If the
  69 .Fl W
  70 flag is added, commits per second, commit latency, read latency, and write
  71 latency are also added to the display.
  72 The busy percentage shown can exceed 100 at times.
  73 This is because of the way busy percentages are calculated.
  74 The busy time is calculated by adding the elapsed time between the
  75 last time an operation started or finished,
  76 and the current time.
  77 If there is only one operation outstanding, the "busy time" time
  78 will get updated with the total time of that operation.
  79 That means that the difference in the busy time between the two
  80 measurement intervals (often 1 second)
  81 will increase by more than the measurement interval.
  82 .It Fl e
  83 Report the extra statistics collected by the NFS client and
  84 server for NFSv4.
  85 .It Fl M
  86 Extract values associated with the name list from the specified core
  87 instead of the default
  88 .Pa /dev/kmem .
  89 .It Fl m
  90 Report the mount options for all new NFS client mounts.
  91 This option overrides all others and
  92 .Nm
  93 will exit after completing the report.
  94 This option is only supported by the new NFS client.
  95 .It Fl N
  96 Extract the name list from the specified system instead of the default
  97 .Pa /boot/kernel/kernel .
  98 .It Fl s
  99 Only display server side statistics.
 100 .It Fl W
 101 Use wide format with interval short summary.
 102 This option is especially
 103 useful when combined with
 104 .Fl c ,
 105 .Fl d ,
 106 or
 107 .Fl s
 108 and a time delay.
 109 .It Fl w
 110 Display a shorter summary of
 111 .Tn NFS
 112 activity for both the client and server at
 113 .Ar wait
 114 second intervals.
 115 .It Fl z
 116 Reset statistics after displaying them.
 117 .El
 118 .Sh FILES
 119 .Bl -tag -width ".Pa /boot/kernel/kernel" -compact
 120 .It Pa /boot/kernel/kernel
 121 default kernel namelist
 122 .It Pa /dev/kmem
 123 default memory file
 124 .El
 125 .Sh SEE ALSO
 126 .Xr fstat 1 ,
 127 .Xr netstat 1 ,
 128 .Xr ps 1 ,
 129 .Xr systat 1 ,
 130 .Xr sysctl 3 ,
 131 .Xr iostat 8 ,
 132 .Xr nfsdumpstate 8 ,
 133 .Xr pstat 8 ,
 134 .Xr vmstat 8
 135 .Sh HISTORY
 136 The
 137 .Nm
 138 command appeared in
 139 .Bx 4.4 .