About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Documentation / filesystems / nfs / knfsd-stats.txt

Custom Search

Based on kernel version 4.1. Page generated on 2015-06-28 12:12 EST.

2	Kernel NFS Server Statistics
3	============================
5	This document describes the format and semantics of the statistics
6	which the kernel NFS server makes available to userspace.  These
7	statistics are available in several text form pseudo files, each of
8	which is described separately below.
10	In most cases you don't need to know these formats, as the nfsstat(8)
11	program from the nfs-utils distribution provides a helpful command-line
12	interface for extracting and printing them.
14	All the files described here are formatted as a sequence of text lines,
15	separated by newline '\n' characters.  Lines beginning with a hash
16	'#' character are comments intended for humans and should be ignored
17	by parsing routines.  All other lines contain a sequence of fields
18	separated by whitespace.
20	/proc/fs/nfsd/pool_stats
21	------------------------
23	This file is available in kernels from 2.6.30 onwards, if the
24	/proc/fs/nfsd filesystem is mounted (it almost always should be).
26	The first line is a comment which describes the fields present in
27	all the other lines.  The other lines present the following data as
28	a sequence of unsigned decimal numeric fields.  One line is shown
29	for each NFS thread pool.
31	All counters are 64 bits wide and wrap naturally.  There is no way
32	to zero these counters, instead applications should do their own
33	rate conversion.
35	pool
36		The id number of the NFS thread pool to which this line applies.
37		This number does not change.
39		Thread pool ids are a contiguous set of small integers starting
40		at zero.  The maximum value depends on the thread pool mode, but
41		currently cannot be larger than the number of CPUs in the system.
42		Note that in the default case there will be a single thread pool
43		which contains all the nfsd threads and all the CPUs in the system,
44		and thus this file will have a single line with a pool id of "0".
46	packets-arrived
47		Counts how many NFS packets have arrived.  More precisely, this
48		is the number of times that the network stack has notified the
49		sunrpc server layer that new data may be available on a transport
50		(e.g. an NFS or UDP socket or an NFS/RDMA endpoint).
52		Depending on the NFS workload patterns and various network stack
53		effects (such as Large Receive Offload) which can combine packets
54		on the wire, this may be either more or less than the number
55		of NFS calls received (which statistic is available elsewhere).
56		However this is a more accurate and less workload-dependent measure
57		of how much CPU load is being placed on the sunrpc server layer
58		due to NFS network traffic.
60	sockets-enqueued
61		Counts how many times an NFS transport is enqueued to wait for
62		an nfsd thread to service it, i.e. no nfsd thread was considered
63		available.
65		The circumstance this statistic tracks indicates that there was NFS
66		network-facing work to be done but it couldn't be done immediately,
67		thus introducing a small delay in servicing NFS calls.  The ideal
68		rate of change for this counter is zero; significantly non-zero
69		values may indicate a performance limitation.
71		This can happen either because there are too few nfsd threads in the
72		thread pool for the NFS workload (the workload is thread-limited),
73		or because the NFS workload needs more CPU time than is available in
74		the thread pool (the workload is CPU-limited).  In the former case,
75		configuring more nfsd threads will probably improve the performance
76		of the NFS workload.  In the latter case, the sunrpc server layer is
77		already choosing not to wake idle nfsd threads because there are too
78		many nfsd threads which want to run but cannot, so configuring more
79		nfsd threads will make no difference whatsoever.  The overloads-avoided
80		statistic (see below) can be used to distinguish these cases.
82	threads-woken
83		Counts how many times an idle nfsd thread is woken to try to
84		receive some data from an NFS transport.
86		This statistic tracks the circumstance where incoming
87		network-facing NFS work is being handled quickly, which is a good
88		thing.  The ideal rate of change for this counter will be close
89		to but less than the rate of change of the packets-arrived counter.
91	overloads-avoided
92		Counts how many times the sunrpc server layer chose not to wake an
93		nfsd thread, despite the presence of idle nfsd threads, because
94		too many nfsd threads had been recently woken but could not get
95		enough CPU time to actually run.
97		This statistic counts a circumstance where the sunrpc layer
98		heuristically avoids overloading the CPU scheduler with too many
99		runnable nfsd threads.  The ideal rate of change for this counter
100		is zero.  Significant non-zero values indicate that the workload
101		is CPU limited.  Usually this is associated with heavy CPU usage
102		on all the CPUs in the nfsd thread pool.
104		If a sustained large overloads-avoided rate is detected on a pool,
105		the top(1) utility should be used to check for the following
106		pattern of CPU usage on all the CPUs associated with the given
107		nfsd thread pool.
109		 - %us ~= 0 (as you're *NOT* running applications on your NFS server)
111		 - %wa ~= 0
113		 - %id ~= 0
115		 - %sy + %hi + %si ~= 100
117		If this pattern is seen, configuring more nfsd threads will *not*
118		improve the performance of the workload.  If this patten is not
119		seen, then something more subtle is wrong.
121	threads-timedout
122		Counts how many times an nfsd thread triggered an idle timeout,
123		i.e. was not woken to handle any incoming network packets for
124		some time.
126		This statistic counts a circumstance where there are more nfsd
127		threads configured than can be used by the NFS workload.  This is
128		a clue that the number of nfsd threads can be reduced without
129		affecting performance.  Unfortunately, it's only a clue and not
130		a strong indication, for a couple of reasons:
132		 - Currently the rate at which the counter is incremented is quite
133		   slow; the idle timeout is 60 minutes.  Unless the NFS workload
134		   remains constant for hours at a time, this counter is unlikely
135		   to be providing information that is still useful.
137		 - It is usually a wise policy to provide some slack,
138		   i.e. configure a few more nfsds than are currently needed,
139		   to allow for future spikes in load.
142	Note that incoming packets on NFS transports will be dealt with in
143	one of three ways.  An nfsd thread can be woken (threads-woken counts
144	this case), or the transport can be enqueued for later attention
145	(sockets-enqueued counts this case), or the packet can be temporarily
146	deferred because the transport is currently being used by an nfsd
147	thread.  This last case is not very interesting and is not explicitly
148	counted, but can be inferred from the other counters thus:
150	packets-deferred = packets-arrived - ( sockets-enqueued + threads-woken )
153	More
154	----
155	Descriptions of the other statistics file should go here.
158	Greg Banks <gnb@sgi.com>
159	26 Mar 2009
Hide Line Numbers
About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Information is copyright its respective author. All material is available from the Linux Kernel Source distributed under a GPL License. This page is provided as a free service by mjmwired.net.