| 1 |
Output Formats |
| 2 |
============== |
| 3 |
|
| 4 |
The following output formats are currently supported by Flent: |
| 5 |
|
| 6 |
|
| 7 |
Plot output (:option:`-f plot<-f>`) |
| 8 |
----------------------------------- |
| 9 |
|
| 10 |
Output test data as one of a series of graphical plots of timeseries data or |
| 11 |
summarised as a CDF plot. Each test supplies a number of different plots; the |
| 12 |
list of plots for a given test is output by the :option:`--list-plots` switch |
| 13 |
(which must be supplied along with a test name). |
| 14 |
|
| 15 |
The plots are drawn by matplotlib, and can be displayed on the screen |
| 16 |
interactively (requires a graphical display), or output to a file in svg, pdf, |
| 17 |
ps and png formats. Using the :option:`-o` switch turns out file output (the |
| 18 |
file format is inferred from the file name), while not supplying the switch |
| 19 |
turns on the interactive plot viewer. |
| 20 |
|
| 21 |
Tabulated output (:option:`-f csv<-f>` and :option:`-f org_table<-f>`) |
| 22 |
---------------------------------------------------------------------- |
| 23 |
|
| 24 |
These formats output the numeric data in a tabulated format to be consumed by |
| 25 |
other applications. The *csv* output format is a comma-separated output that can |
| 26 |
be imported into e.g. spreadsheets, while *org_table* outputs a tabulated output |
| 27 |
in the table format supported by Emacs org mode. The data is output in text |
| 28 |
format to standard output, or written to a file if invoked with the :option:`-o` |
| 29 |
parameter. |
| 30 |
|
| 31 |
Statistics output (:option:`-f stats<-f>`) |
| 32 |
------------------------------------------ |
| 33 |
|
| 34 |
This output format outputs various statistics about the test data, such as total |
| 35 |
bandwidth consumed, and various statistical measures (min/max/mean/median/std |
| 36 |
dev/variance) for each data source specified in the relevant test (this can |
| 37 |
include some data sources not includes on plots). The data is output in text |
| 38 |
format to standard output, or written to a file if invoked with the :option:`-o` |
| 39 |
parameter. |
| 40 |
|
| 41 |
Metadata output (:option:`-f metadata<-f>`) |
| 42 |
------------------------------------------- |
| 43 |
|
| 44 |
This output format outputs the test metadata as pretty-printed JSON (also |
| 45 |
suitable for human consumption). It is output as a list of objects, where each |
| 46 |
object corresponds to the metadata of one test. Mostly useful for inspecting |
| 47 |
metadata of stored data files. |