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 .SH OPTIONS
  38 .PP
  39 .SS -d <netdev>, --dev <netdev>
  40 Networking device to fetch statistics from, for example, eth0, wlan0.
  41 .PP
  42 .SS -t <time>, --interval <time>
  43 Statistics refresh interval in milliseconds, default is 1000ms.
  44 .PP
  45 .SS -p, --promisc
  46 Turn on promiscuous mode for the given networking device.
  47 .PP
  48 .SS -c, --csv
  49 Output (once) the ncurses data to the terminal as gnuplot(1)-ready data.
  50 .PP
  51 .SS -l, --loop
  52 Continuously output the terminal data after a refresh interval. This option
  53 is only available, if option \[lq]-c\[rq] is given. For \[lq]-l\[rq] it is usually
  54 recommended to redirect the output into a file that is to be be processed
  55 later with gnuplot(1).
  56 .PP
  57 .SS -v, --version
  58 Show version information.
  59 .PP
  60 .SS -h, --help
  61 Show user help.
  62 .PP
  63 .SH USAGE EXAMPLE
  64 .PP
  65 .SS ifpps eth0
  66 Default ncurses output for the eth0 device.
  67 .PP
  68 .SS ifpps -pd eth0
  69 Ncurses output for the eth0 device in promiscuous mode.
  70 .PP
  71 .SS ifpps -lpcd wlan0 > plot.dat
  72 Continuous terminal output for the wlan0 device in promiscuous mode.
  73 .PP
  74 .SH NOTE
  75 On 10Gbit/s cards or higher, receive and transmit statistics are usually
  76 accumulated at a higher duration interval than 1 second. Thus, it might
  77 be advisable to alter the timing to a higher accumulation interval for such cards.
  78 .PP
  79 .SH BUGS
  80 Systems with greater than 32 cores are currently not supported. This
  81 should, however, not be a big task to fix. The only challenge would
  82 be to display the presented information in a sane way, probably by
  83 selectively hiding uninteresting statistics.
  84 .PP
  85 .SH LEGAL
  86 ifpps is licensed under the GNU GPL version 2.0.
  87 .PP
  88 .SH HISTORY
  89 .B ifpps
  90 was originally written for the netsniff-ng toolkit by Daniel Borkmann. It
  91 is currently maintained by Tobias Klauser <tklauser@distanz.ch> and Daniel
  92 Borkmann <dborkma@tik.ee.ethz.ch>.
  93 .PP
  94 .SH SEE ALSO
  95 .BR netsniff-ng (8),
  96 .BR trafgen (8),
  97 .BR mausezahn (8),
  98 .BR bpfc (8),
  99 .BR flowtop (8),
 100 .BR astraceroute (8),
 101 .BR curvetun (8)
 102 .PP
 103 .SH AUTHOR
 104 Manpage was written by Daniel Borkmann.