| 1 |
Introduction |
| 2 |
============ |
| 3 |
|
| 4 |
Flent is a wrapper around *netperf* and similar tools to run predefined |
| 5 |
tests and aggregate and plot the results. It defines several tests that |
| 6 |
can be run against one or more hosts, primarily targeted at testing for |
| 7 |
the presence of bufferbloat under various conditions. |
| 8 |
|
| 9 |
The aggregated data is saved in (gzipped) JSON format for later |
| 10 |
processing and/or import into other tools. The JSON format is documented |
| 11 |
below. |
| 12 |
|
| 13 |
Apart from the JSON format, the data can be output as csv values, emacs |
| 14 |
org mode tables or plots. Each test can specify several different plots, |
| 15 |
including time-series plots of the values against each other, as well as |
| 16 |
CDF plots of (e.g.) ping times. |
| 17 |
|
| 18 |
Plots can be output to the formats supported by matplotlib by specifying |
| 19 |
the output filename with :option:`-o` *output.{png,ps,pdf,svg}*. If no output |
| 20 |
file is specified, the plot is displayed using matplotlib’s interactive |
| 21 |
plot browser, which also allows saving of the output (in .png format). |
| 22 |
|
| 23 |
Requirements |
| 24 |
------------ |
| 25 |
Flent runs on Python, versions 2.7+ and 3.3+. Plotting requires a functional |
| 26 |
:py:mod:`matplotlib` installation (but everything else can run without |
| 27 |
:py:mod:`matplotlib`). For the interactive plot viewer, a graphical display (and |
| 28 |
suitably configured :py:mod:`matplotlib`) is required. |
| 29 |
|
| 30 |
Most tests employ the :command:`netperf` benchmarking tool to run the tests. |
| 31 |
Version 2.6 or higher is required, and netperf must be compiled with the |
| 32 |
:command:`--enable-demo` option passed to :command:`./configure`. Some tests use |
| 33 |
iperf in addition to, or instead of netperf. Both tools must be available in the |
| 34 |
:envvar:`PATH`. |
| 35 |
|
| 36 |
For ICMP ping measurements, the version of ping employed must support output |
| 37 |
timestamping (the -D parameter to GNU ping). This is not supported by the BSD |
| 38 |
and OSX versions of ping. As an alternative to the regular ping command, the |
| 39 |
:command:`fping` utility (see http://fping.org) can be employed. In that case |
| 40 |
fping must be version 3.5 or greater. Flent will attempt to detect the presence |
| 41 |
of fping in the :envvar:`PATH` and check for support for the -D parameter. If |
| 42 |
this check is successful, :command:`fping` will be employed for ping data, |
| 43 |
otherwise the system ping will be used. |
| 44 |
|
| 45 |
The :command:`irtt` tool is highly recommended for UDP measurements. See |
| 46 |
https://github.com/peteheist/irtt. Flent will automatically detect if irtt is |
| 47 |
available in the :envvar:`PATH` and use it if it is detected. Note that the |
| 48 |
server component of irtt needs to be running on the target host(s) as well. |