ifpps.8

   1 .\" netsniff-ng - the packet sniffing beast
   2 .\" Copyright 2013 Daniel Borkmann.
   3 .\" Subject to the GPL, version 2.
   4 .PP
   5 .TH IFPPS 8 "03 March 2013" "Linux" "netsniff-ng toolkit"
   6 .SH NAME
   7 ifpps \- top-like networking and system statistics
   8 .PP
   9 .SH SYNOPSIS
  10 .PP
  11 \fBifpps\fR { [\fIoptions\fR] | [\fIdevice\fR] }
  12 .PP
  13 .SH DESCRIPTION
  14 .PP
  15 ifpps is a small utility which periodically provides top-like networking
  16 and system statistics from the kernel. ifpps gathers its data directly
  17 from procfs files and does not make use of any user space monitoring
  18 libraries which would falsify statistics under high load.
  19 .PP
  20 For instance, consider the following scenario: two directly connected
  21 Linux machines with Intel Core 2 Quad Q6600 2.40GHz CPUs, 4 GB RAM, and
  22 an Intel 82566DC-2 Gigabit Ethernet NIC are used for performance evaluation.
  23 One machine generates 64 byte network packets by using the kernel space
  24 packet generator pktgen with a maximum possible packet rate. The other
  25 machine displays statistics about incoming network packets by using i)
  26 iptraf(8) and ii) ifpps.
  27 .PP
  28 iptraf which incorporates pcap(3) shows an average packet rate of
  29 246,000 pps while on the other hand ifpps shows an average packet rate
  30 of 1,378,000 pps. Hence, due to packet copies and deferring statistics
  31 creation into user space, a measurement error of approximately 460 percent
  32 occurs. Tools like iptraf might display much more information such as
  33 TCP per flow statistics (hence the use of the pcap library). This is not
  34 possible with ifpps, because overall networking statistics are its focus;
  35 statistics, which are also fairly reliable under high packet load.
  36 .PP
  37 ifpps also periodically displays CPU load, interrupt, software interrupt
  38 data per sample interval as well as total interrupts, all per CPU. In case
  39 the number of CPUs exceeds 5 or the number specified by the user with the
  40 \[lq]\-n\[rq] command line option, ifpps will only display this number top
  41 heavy hitters. The topmost heavy hitter CPU will be marked with \[lq]+\[rq].
  42 The least heavy hitter will always be displayed and is marked with
  43 \[lq]-\[rq]. In addition, the average for all the above per-CPU data is
  44 shown. Optionally the median values can be displayed using the \[lq]\-m\[rq]
  45 command line option.
  46 .PP
  47 ifpps also supports directly the gnuplot(1) data sample format. This
  48 facilitates creation of gnuplot figures from ifpps time series.
  49 .PP
  50 .SH OPTIONS
  51 .PP
  52 .SS -d <netdev>, --dev <netdev>
  53 Networking device to fetch statistics from, for example eth0, wlan0.
  54 .PP
  55 .SS -n, --num-cpus
  56 Set maximum number of top hitter CPUs (in terms of time spent in system/user
  57 mode) to display in ncurses mode, default is 10.
  58 .PP
  59 .SS -t <time>, --interval <time>
  60 Statistics refresh interval in milliseconds, default is 1000ms.
  61 .PP
  62 .SS -c, --csv
  63 Output (once) the ncurses data to the terminal as gnuplot(1)-ready data.
  64 .PP
  65 .SS -l, --loop
  66 Continuously output the terminal data after a refresh interval. This option
  67 is only available if option \[lq]\-c\[rq] is given. For \[lq]\-l\[rq] it is
  68 usually recommended to redirect the output into a file that is to be processed
  69 later with gnuplot(1).
  70 .PP
  71 .SS -m, --median
  72 Show median values across all CPUs for CPU load, interrupts (per interval and
  73 absolute) and software interrupts.
  74 .PP
  75 .SS -o, --omit-header
  76 Omit printing the CSV header. This option is only available if \[lq]\-c\[rq] is given.
  77 .PP
  78 .SS -p, --promisc
  79 Turn on promiscuous mode for the given networking device.
  80 .PP
  81 .SS -P, --percentage
  82 Show percentage of current throughput in relation to theoretical line rate.
  83 .PP
  84 .SS -W, --no-warn
  85 Suppress possible warnings in the ncurses output, e.g. about a too low sampling
  86 interval that could cause performance regression.
  87 .PP
  88 .SS -v, --version
  89 Show version information.
  90 .PP
  91 .SS -h, --help
  92 Show user help.
  93 .PP
  94 .SH USAGE EXAMPLE
  95 .PP
  96 .SS ifpps eth0
  97 Default ncurses output for the eth0 device.
  98 .PP
  99 .SS ifpps -pd eth0
 100 Ncurses output for the eth0 device in promiscuous mode.
 101 .PP
 102 .SS ifpps -lpcd wlan0 > plot.dat
 103 Continuous terminal output for the wlan0 device in promiscuous mode.
 104 .PP
 105 .SH NOTE
 106 On 10Gbit/s cards or higher, receive and transmit statistics are usually
 107 accumulated at a higher duration interval than 1 second. Thus, it might
 108 be advisable to alter the timing to a higher accumulation interval for such cards.
 109 .PP
 110 .SH LEGAL
 111 ifpps is licensed under the GNU GPL version 2.0.
 112 .PP
 113 .SH HISTORY
 114 .B ifpps
 115 was originally written for the netsniff-ng toolkit by Daniel Borkmann. It
 116 is currently maintained by Tobias Klauser <tklauser@distanz.ch> and Daniel
 117 Borkmann <dborkma@tik.ee.ethz.ch>.
 118 .PP
 119 .SH SEE ALSO
 120 .BR netsniff-ng (8),
 121 .BR trafgen (8),
 122 .BR mausezahn (8),
 123 .BR bpfc (8),
 124 .BR flowtop (8),
 125 .BR astraceroute (8),
 126 .BR curvetun (8)
 127 .PP
 128 .SH AUTHOR
 129 Manpage was written by Daniel Borkmann.
 130 .PP
 131 .SH COLOPHON
 132 This page is part of the Linux netsniff-ng toolkit project. A description of the project,
 133 and information about reporting bugs, can be found at http://netsniff-ng.org/.