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