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 \fB ifpps\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 apply any user space monitoring libraries
  18 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 per cent
  32 occurs. Tools like iptraf might display much more information such as
  33 TCP per flow statistics (hence the use of the pcap library), that is not
  34 possible with ifpps, because overall networking statistics are our 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 10 or the number specified by the user with the
  40 \[lq]\-n\[rq] command line option, ifpps will only display the top heavy
  41 hitters.
  42 .PP
  43 .SH OPTIONS
  44 .PP
  45 .SS -d <netdev>, --dev <netdev>
  46 Networking device to fetch statistics from, for example, eth0, wlan0.
  47 .PP
  48 .SS -t <time>, --interval <time>
  49 Statistics refresh interval in milliseconds, default is 1000ms.
  50 .PP
  51 .SS -n, --num-cpus
  52 Set maximum number of top hitter CPUs (in terms of time spent in system/user
  53 mode) to display in ncurses mode, default is 10.
  54 .PP
  55 .SS -p, --promisc
  56 Turn on promiscuous mode for the given networking device.
  57 .PP
  58 .SS -c, --csv
  59 Output (once) the ncurses data to the terminal as gnuplot(1)-ready data.
  60 .PP
  61 .SS -l, --loop
  62 Continuously output the terminal data after a refresh interval. This option
  63 is only available, if option \[lq]\-c\[rq] is given. For \[lq]\-l\[rq] it is
  64 usually recommended to redirect the output into a file that is to be be
  65 processed later with gnuplot(1).
  66 .PP
  67 .SS -v, --version
  68 Show version information.
  69 .PP
  70 .SS -h, --help
  71 Show user help.
  72 .PP
  73 .SH USAGE EXAMPLE
  74 .PP
  75 .SS ifpps eth0
  76 Default ncurses output for the eth0 device.
  77 .PP
  78 .SS ifpps -pd eth0
  79 Ncurses output for the eth0 device in promiscuous mode.
  80 .PP
  81 .SS ifpps -lpcd wlan0 > plot.dat
  82 Continuous terminal output for the wlan0 device in promiscuous mode.
  83 .PP
  84 .SH NOTE
  85 On 10Gbit/s cards or higher, receive and transmit statistics are usually
  86 accumulated at a higher duration interval than 1 second. Thus, it might
  87 be advisable to alter the timing to a higher accumulation interval for such cards.
  88 .PP
  89 .SH LEGAL
  90 ifpps is licensed under the GNU GPL version 2.0.
  91 .PP
  92 .SH HISTORY
  93 .B ifpps
  94 was originally written for the netsniff-ng toolkit by Daniel Borkmann. It
  95 is currently maintained by Tobias Klauser <tklauser@distanz.ch> and Daniel
  96 Borkmann <dborkma@tik.ee.ethz.ch>.
  97 .PP
  98 .SH SEE ALSO
  99 .BR netsniff-ng (8),
 100 .BR trafgen (8),
 101 .BR mausezahn (8),
 102 .BR bpfc (8),
 103 .BR flowtop (8),
 104 .BR astraceroute (8),
 105 .BR curvetun (8)
 106 .PP
 107 .SH AUTHOR
 108 Manpage was written by Daniel Borkmann.