/usr/sbin/nfsiostat is in nfs-common 1:1.2.8-9.
This file is owned by root:root, with mode 0o755.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 | #!/usr/bin/python
# -*- python-mode -*-
"""Emulate iostat for NFS mount points using /proc/self/mountstats
"""
from __future__ import print_function
__copyright__ = """
Copyright (C) 2005, Chuck Lever <cel@netapp.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2 as
published by the Free Software Foundation.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
MA 02110-1301 USA
"""
import sys, os, time
from optparse import OptionParser, OptionGroup
Iostats_version = '0.2'
def difference(x, y):
"""Used for a map() function
"""
return x - y
NfsEventCounters = [
'inoderevalidates',
'dentryrevalidates',
'datainvalidates',
'attrinvalidates',
'vfsopen',
'vfslookup',
'vfspermission',
'vfsupdatepage',
'vfsreadpage',
'vfsreadpages',
'vfswritepage',
'vfswritepages',
'vfsreaddir',
'vfssetattr',
'vfsflush',
'vfsfsync',
'vfslock',
'vfsrelease',
'congestionwait',
'setattrtrunc',
'extendwrite',
'sillyrenames',
'shortreads',
'shortwrites',
'delay'
]
NfsByteCounters = [
'normalreadbytes',
'normalwritebytes',
'directreadbytes',
'directwritebytes',
'serverreadbytes',
'serverwritebytes',
'readpages',
'writepages'
]
class DeviceData:
"""DeviceData objects provide methods for parsing and displaying
data for a single mount grabbed from /proc/self/mountstats
"""
def __init__(self):
self.__nfs_data = dict()
self.__rpc_data = dict()
self.__rpc_data['ops'] = []
def __parse_nfs_line(self, words):
if words[0] == 'device':
self.__nfs_data['export'] = words[1]
self.__nfs_data['mountpoint'] = words[4]
self.__nfs_data['fstype'] = words[7]
if words[7] == 'nfs':
self.__nfs_data['statvers'] = words[8]
elif 'nfs' in words or 'nfs4' in words:
self.__nfs_data['export'] = words[0]
self.__nfs_data['mountpoint'] = words[3]
self.__nfs_data['fstype'] = words[6]
if words[6] == 'nfs':
self.__nfs_data['statvers'] = words[7]
elif words[0] == 'age:':
self.__nfs_data['age'] = long(words[1])
elif words[0] == 'opts:':
self.__nfs_data['mountoptions'] = ''.join(words[1:]).split(',')
elif words[0] == 'caps:':
self.__nfs_data['servercapabilities'] = ''.join(words[1:]).split(',')
elif words[0] == 'nfsv4:':
self.__nfs_data['nfsv4flags'] = ''.join(words[1:]).split(',')
elif words[0] == 'sec:':
keys = ''.join(words[1:]).split(',')
self.__nfs_data['flavor'] = int(keys[0].split('=')[1])
self.__nfs_data['pseudoflavor'] = 0
if self.__nfs_data['flavor'] == 6:
self.__nfs_data['pseudoflavor'] = int(keys[1].split('=')[1])
elif words[0] == 'events:':
i = 1
for key in NfsEventCounters:
self.__nfs_data[key] = int(words[i])
i += 1
elif words[0] == 'bytes:':
i = 1
for key in NfsByteCounters:
self.__nfs_data[key] = long(words[i])
i += 1
def __parse_rpc_line(self, words):
if words[0] == 'RPC':
self.__rpc_data['statsvers'] = float(words[3])
self.__rpc_data['programversion'] = words[5]
elif words[0] == 'xprt:':
self.__rpc_data['protocol'] = words[1]
if words[1] == 'udp':
self.__rpc_data['port'] = int(words[2])
self.__rpc_data['bind_count'] = int(words[3])
self.__rpc_data['rpcsends'] = int(words[4])
self.__rpc_data['rpcreceives'] = int(words[5])
self.__rpc_data['badxids'] = int(words[6])
self.__rpc_data['inflightsends'] = long(words[7])
self.__rpc_data['backlogutil'] = long(words[8])
elif words[1] == 'tcp':
self.__rpc_data['port'] = words[2]
self.__rpc_data['bind_count'] = int(words[3])
self.__rpc_data['connect_count'] = int(words[4])
self.__rpc_data['connect_time'] = int(words[5])
self.__rpc_data['idle_time'] = int(words[6])
self.__rpc_data['rpcsends'] = int(words[7])
self.__rpc_data['rpcreceives'] = int(words[8])
self.__rpc_data['badxids'] = int(words[9])
self.__rpc_data['inflightsends'] = long(words[10])
self.__rpc_data['backlogutil'] = long(words[11])
elif words[1] == 'rdma':
self.__rpc_data['port'] = words[2]
self.__rpc_data['bind_count'] = int(words[3])
self.__rpc_data['connect_count'] = int(words[4])
self.__rpc_data['connect_time'] = int(words[5])
self.__rpc_data['idle_time'] = int(words[6])
self.__rpc_data['rpcsends'] = int(words[7])
self.__rpc_data['rpcreceives'] = int(words[8])
self.__rpc_data['badxids'] = int(words[9])
self.__rpc_data['backlogutil'] = int(words[10])
self.__rpc_data['read_chunks'] = int(words[11])
self.__rpc_data['write_chunks'] = int(words[12])
self.__rpc_data['reply_chunks'] = int(words[13])
self.__rpc_data['total_rdma_req'] = int(words[14])
self.__rpc_data['total_rdma_rep'] = int(words[15])
self.__rpc_data['pullup'] = int(words[16])
self.__rpc_data['fixup'] = int(words[17])
self.__rpc_data['hardway'] = int(words[18])
self.__rpc_data['failed_marshal'] = int(words[19])
self.__rpc_data['bad_reply'] = int(words[20])
elif words[0] == 'per-op':
self.__rpc_data['per-op'] = words
else:
op = words[0][:-1]
self.__rpc_data['ops'] += [op]
self.__rpc_data[op] = [long(word) for word in words[1:]]
def parse_stats(self, lines):
"""Turn a list of lines from a mount stat file into a
dictionary full of stats, keyed by name
"""
found = False
for line in lines:
words = line.split()
if len(words) == 0:
continue
if (not found and words[0] != 'RPC'):
self.__parse_nfs_line(words)
continue
found = True
self.__parse_rpc_line(words)
def is_nfs_mountpoint(self):
"""Return True if this is an NFS or NFSv4 mountpoint,
otherwise return False
"""
if self.__nfs_data['fstype'] == 'nfs':
return True
elif self.__nfs_data['fstype'] == 'nfs4':
return True
return False
def compare_iostats(self, old_stats):
"""Return the difference between two sets of stats
"""
result = DeviceData()
# copy self into result
for key, value in self.__nfs_data.items():
result.__nfs_data[key] = value
for key, value in self.__rpc_data.items():
result.__rpc_data[key] = value
# compute the difference of each item in the list
# note the copy loop above does not copy the lists, just
# the reference to them. so we build new lists here
# for the result object.
for op in result.__rpc_data['ops']:
result.__rpc_data[op] = map(difference, self.__rpc_data[op], old_stats.__rpc_data[op])
# update the remaining keys we care about
result.__rpc_data['rpcsends'] -= old_stats.__rpc_data['rpcsends']
result.__rpc_data['backlogutil'] -= old_stats.__rpc_data['backlogutil']
for key in NfsEventCounters:
result.__nfs_data[key] -= old_stats.__nfs_data[key]
for key in NfsByteCounters:
result.__nfs_data[key] -= old_stats.__nfs_data[key]
return result
def __print_data_cache_stats(self):
"""Print the data cache hit rate
"""
nfs_stats = self.__nfs_data
app_bytes_read = float(nfs_stats['normalreadbytes'])
if app_bytes_read != 0:
client_bytes_read = float(nfs_stats['serverreadbytes'] - nfs_stats['directreadbytes'])
ratio = ((app_bytes_read - client_bytes_read) * 100) / app_bytes_read
print()
print('app bytes: %f client bytes %f' % (app_bytes_read, client_bytes_read))
print('Data cache hit ratio: %4.2f%%' % ratio)
def __print_attr_cache_stats(self, sample_time):
"""Print attribute cache efficiency stats
"""
nfs_stats = self.__nfs_data
getattr_stats = self.__rpc_data['GETATTR']
if nfs_stats['inoderevalidates'] != 0:
getattr_ops = float(getattr_stats[1])
opens = float(nfs_stats['vfsopen'])
revalidates = float(nfs_stats['inoderevalidates']) - opens
if revalidates != 0:
ratio = ((revalidates - getattr_ops) * 100) / revalidates
else:
ratio = 0.0
data_invalidates = float(nfs_stats['datainvalidates'])
attr_invalidates = float(nfs_stats['attrinvalidates'])
print()
print('%d inode revalidations, hitting in cache %4.2f%% of the time' % \
(revalidates, ratio))
print('%d open operations (mandatory GETATTR requests)' % opens)
if getattr_ops != 0:
print('%4.2f%% of GETATTRs resulted in data cache invalidations' % \
((data_invalidates * 100) / getattr_ops))
def __print_dir_cache_stats(self, sample_time):
"""Print directory stats
"""
nfs_stats = self.__nfs_data
lookup_ops = self.__rpc_data['LOOKUP'][0]
readdir_ops = self.__rpc_data['READDIR'][0]
if self.__rpc_data.has_key('READDIRPLUS'):
readdir_ops += self.__rpc_data['READDIRPLUS'][0]
dentry_revals = nfs_stats['dentryrevalidates']
opens = nfs_stats['vfsopen']
lookups = nfs_stats['vfslookup']
getdents = nfs_stats['vfsreaddir']
print()
print('%d open operations (pathname lookups)' % opens)
print('%d dentry revalidates and %d vfs lookup requests' % \
(dentry_revals, lookups))
print('resulted in %d LOOKUPs on the wire' % lookup_ops)
print('%d vfs getdents calls resulted in %d READDIRs on the wire' % \
(getdents, readdir_ops))
def __print_page_stats(self, sample_time):
"""Print page cache stats
"""
nfs_stats = self.__nfs_data
vfsreadpage = nfs_stats['vfsreadpage']
vfsreadpages = nfs_stats['vfsreadpages']
pages_read = nfs_stats['readpages']
vfswritepage = nfs_stats['vfswritepage']
vfswritepages = nfs_stats['vfswritepages']
pages_written = nfs_stats['writepages']
print()
print('%d nfs_readpage() calls read %d pages' % \
(vfsreadpage, vfsreadpage))
print('%d nfs_readpages() calls read %d pages' % \
(vfsreadpages, pages_read - vfsreadpage))
if vfsreadpages != 0:
print('(%.1f pages per call)' % \
(float(pages_read - vfsreadpage) / vfsreadpages))
else:
print()
print()
print('%d nfs_updatepage() calls' % nfs_stats['vfsupdatepage'])
print('%d nfs_writepage() calls wrote %d pages' % \
(vfswritepage, vfswritepage))
print('%d nfs_writepages() calls wrote %d pages' % \
(vfswritepages, pages_written - vfswritepage))
if (vfswritepages) != 0:
print('(%.1f pages per call)' % \
(float(pages_written - vfswritepage) / vfswritepages))
else:
print()
congestionwaits = nfs_stats['congestionwait']
if congestionwaits != 0:
print()
print('%d congestion waits' % congestionwaits)
def __print_rpc_op_stats(self, op, sample_time):
"""Print generic stats for one RPC op
"""
if not self.__rpc_data.has_key(op):
return
rpc_stats = self.__rpc_data[op]
ops = float(rpc_stats[0])
retrans = float(rpc_stats[1] - rpc_stats[0])
kilobytes = float(rpc_stats[3] + rpc_stats[4]) / 1024
rtt = float(rpc_stats[6])
exe = float(rpc_stats[7])
# prevent floating point exceptions
if ops != 0:
kb_per_op = kilobytes / ops
retrans_percent = (retrans * 100) / ops
rtt_per_op = rtt / ops
exe_per_op = exe / ops
else:
kb_per_op = 0.0
retrans_percent = 0.0
rtt_per_op = 0.0
exe_per_op = 0.0
op += ':'
print('%s' % op.lower().ljust(15))
print(' ops/s\t\t kB/s\t\t kB/op\t\tretrans\t\tavg RTT (ms)\tavg exe (ms)')
print('\t\t%7.3f' % (ops / sample_time))
print('\t%7.3f' % (kilobytes / sample_time))
print('\t%7.3f' % kb_per_op)
print(' %7d (%3.1f%%)' % (retrans, retrans_percent))
print('\t%7.3f' % rtt_per_op)
print('\t%7.3f' % exe_per_op)
def ops(self, sample_time):
sends = float(self.__rpc_data['rpcsends'])
if sample_time == 0:
sample_time = float(self.__nfs_data['age'])
return (sends / sample_time)
def display_iostats(self, sample_time, which):
"""Display NFS and RPC stats in an iostat-like way
"""
sends = float(self.__rpc_data['rpcsends'])
if sample_time == 0:
sample_time = float(self.__nfs_data['age'])
# sample_time could still be zero if the export was just mounted.
# Set it to 1 to avoid divide by zero errors in this case since we'll
# likely still have relevant mount statistics to show.
#
if sample_time == 0:
sample_time = 1;
if sends != 0:
backlog = (float(self.__rpc_data['backlogutil']) / sends) / sample_time
else:
backlog = 0.0
print()
print('%s mounted on %s:' % \
(self.__nfs_data['export'], self.__nfs_data['mountpoint']))
print()
print(' op/s\t\trpc bklog')
print('%7.2f' % (sends / sample_time))
print('\t%7.2f' % backlog)
if which == 0:
self.__print_rpc_op_stats('READ', sample_time)
self.__print_rpc_op_stats('WRITE', sample_time)
elif which == 1:
self.__print_rpc_op_stats('GETATTR', sample_time)
self.__print_rpc_op_stats('ACCESS', sample_time)
self.__print_attr_cache_stats(sample_time)
elif which == 2:
self.__print_rpc_op_stats('LOOKUP', sample_time)
self.__print_rpc_op_stats('READDIR', sample_time)
if self.__rpc_data.has_key('READDIRPLUS'):
self.__print_rpc_op_stats('READDIRPLUS', sample_time)
self.__print_dir_cache_stats(sample_time)
elif which == 3:
self.__print_rpc_op_stats('READ', sample_time)
self.__print_rpc_op_stats('WRITE', sample_time)
self.__print_page_stats(sample_time)
#
# Functions
#
def parse_stats_file(filename):
"""pop the contents of a mountstats file into a dictionary,
keyed by mount point. each value object is a list of the
lines in the mountstats file corresponding to the mount
point named in the key.
"""
ms_dict = dict()
key = ''
f = open(filename)
for line in f.readlines():
words = line.split()
if len(words) == 0:
continue
if words[0] == 'device':
key = words[4]
new = [ line.strip() ]
elif 'nfs' in words or 'nfs4' in words:
key = words[3]
new = [ line.strip() ]
else:
new += [ line.strip() ]
ms_dict[key] = new
f.close
return ms_dict
def print_iostat_summary(old, new, devices, time, options):
stats = {}
diff_stats = {}
if old:
# Trim device list to only include intersection of old and new data,
# this addresses umounts due to autofs mountpoints
devicelist = filter(lambda x:x in devices,old)
else:
devicelist = devices
for device in devicelist:
stats[device] = DeviceData()
stats[device].parse_stats(new[device])
if old:
old_stats = DeviceData()
old_stats.parse_stats(old[device])
diff_stats[device] = stats[device].compare_iostats(old_stats)
if options.sort:
if old:
# We now have compared data and can print a comparison
# ordered by mountpoint ops per second
devicelist.sort(key=lambda x: diff_stats[x].ops(time), reverse=True)
else:
# First iteration, just sort by newly parsed ops/s
devicelist.sort(key=lambda x: stats[x].ops(time), reverse=True)
count = 1
for device in devicelist:
if old:
diff_stats[device].display_iostats(time, options.which)
else:
stats[device].display_iostats(time, options.which)
count += 1
if (count > options.list):
return
def list_nfs_mounts(givenlist, mountstats):
"""return a list of NFS mounts given a list to validate or
return a full list if the given list is empty -
may return an empty list if none found
"""
list = []
if len(givenlist) > 0:
for device in givenlist:
stats = DeviceData()
stats.parse_stats(mountstats[device])
if stats.is_nfs_mountpoint():
list += [device]
else:
for device, descr in mountstats.items():
stats = DeviceData()
stats.parse_stats(descr)
if stats.is_nfs_mountpoint():
list += [device]
return list
def iostat_command(name):
"""iostat-like command for NFS mount points
"""
mountstats = parse_stats_file('/proc/self/mountstats')
devices = []
origdevices = []
interval_seen = False
count_seen = False
mydescription= """
Sample iostat-like program to display NFS client per-mount'
statistics. The <interval> parameter specifies the amount of time in seconds
between each report. The first report contains statistics for the time since
each file system was mounted. Each subsequent report contains statistics
collected during the interval since the previous report. If the <count>
parameter is specified, the value of <count> determines the number of reports
generated at <interval> seconds apart. If the interval parameter is specified
without the <count> parameter, the command generates reports continuously.
If one or more <mount point> names are specified, statistics for only these
mount points will be displayed. Otherwise, all NFS mount points on the
client are listed.
"""
parser = OptionParser(
usage="usage: %prog [ <interval> [ <count> ] ] [ <options> ] [ <mount point> ]",
description=mydescription,
version='version %s' % Iostats_version)
parser.set_defaults(which=0, sort=False, list=sys.maxsize)
statgroup = OptionGroup(parser, "Statistics Options",
'File I/O is displayed unless one of the following is specified:')
statgroup.add_option('-a', '--attr',
action="store_const",
dest="which",
const=1,
help='displays statistics related to the attribute cache')
statgroup.add_option('-d', '--dir',
action="store_const",
dest="which",
const=2,
help='displays statistics related to directory operations')
statgroup.add_option('-p', '--page',
action="store_const",
dest="which",
const=3,
help='displays statistics related to the page cache')
parser.add_option_group(statgroup)
displaygroup = OptionGroup(parser, "Display Options",
'Options affecting display format:')
displaygroup.add_option('-s', '--sort',
action="store_true",
dest="sort",
help="Sort NFS mount points by ops/second")
displaygroup.add_option('-l','--list',
action="store",
type="int",
dest="list",
help="only print stats for first LIST mount points")
parser.add_option_group(displaygroup)
(options, args) = parser.parse_args(sys.argv)
for arg in args:
if arg == sys.argv[0]:
continue
if arg in mountstats:
origdevices += [arg]
elif not interval_seen:
try:
interval = int(arg)
except:
print('Illegal <interval> value %s' % arg)
return
if interval > 0:
interval_seen = True
else:
print('Illegal <interval> value %s' % arg)
return
elif not count_seen:
try:
count = int(arg)
except:
print('Ilegal <count> value %s' % arg)
return
if count > 0:
count_seen = True
else:
print('Illegal <count> value %s' % arg)
return
# make certain devices contains only NFS mount points
devices = list_nfs_mounts(origdevices, mountstats)
if len(devices) == 0:
print('No NFS mount points were found')
return
old_mountstats = None
sample_time = 0.0
if not interval_seen:
print_iostat_summary(old_mountstats, mountstats, devices, sample_time, options)
return
if count_seen:
while count != 0:
print_iostat_summary(old_mountstats, mountstats, devices, sample_time, options)
old_mountstats = mountstats
time.sleep(interval)
sample_time = interval
mountstats = parse_stats_file('/proc/self/mountstats')
# automount mountpoints add and drop, if automount is involved
# we need to recheck the devices list when reparsing
devices = list_nfs_mounts(origdevices,mountstats)
if len(devices) == 0:
print('No NFS mount points were found')
return
count -= 1
else:
while True:
print_iostat_summary(old_mountstats, mountstats, devices, sample_time, options)
old_mountstats = mountstats
time.sleep(interval)
sample_time = interval
mountstats = parse_stats_file('/proc/self/mountstats')
# automount mountpoints add and drop, if automount is involved
# we need to recheck the devices list when reparsing
devices = list_nfs_mounts(origdevices,mountstats)
if len(devices) == 0:
print('No NFS mount points were found')
return
#
# Main
#
prog = os.path.basename(sys.argv[0])
try:
iostat_command(prog)
except KeyboardInterrupt:
print('Caught ^C... exiting')
sys.exit(1)
sys.exit(0)
|