Report: Replace links to jobs by links to logs
[csit.git] / docs / report / dpdk_performance_tests / packet_throughput_graphs / index.rst
index 140b519..44718d8 100644 (file)
@@ -1,39 +1,77 @@
-Packet Throughput Graphs
-========================
-
-Plotted results are generated by multiple executions of the same CSIT
-performance tests across three physical testbeds within LF FD.io labs.
-To provide a descriptive summary view, Box-and-Whisker plots are used to
-display variation in measured throughput values, without making any
-assumptions of the underlying statistical distribution.
-
-For each plotted test case, Box-and-Whisker plots show the quartiles
-(Min, 1st quartile / 25th percentile, 2nd quartile / 50th percentile /
-mean, 3rd quartile / 75th percentile, Max) across collected data set
-(data set size stated in the note below). Outliers are plotted as
-individual points. Min and max values are plotted as bottom and top
-Whiskers respectively. 2nd and 3rd quartiles are plotted as bottom and
-top edge of the box. If multiple samples match only two values, and all
-samples fall between them, then no whiskers are plotted. If all samples
-have the same value, only a horizontal line is plotted.
-
-*Title of each graph* is a regex (regular expression) matching all
-throughput test cases plotted on this graph, *X-axis labels* are indices
-of individual test suites executed by
-`FD.io test executor dpdk performance jobs`_ jobs that created result output
-files used as data sources for the graph, *Y-axis labels* are measured Packets
-Per Second [pps] values, and the *Graph legend* lists the plotted test suites
-and their indices.
+
+.. raw:: latex
+
+    \clearpage
+
+Packet Throughput
+=================
+
+Throughput graphs are generated by multiple executions of the same
+performance tests across physical testbeds hosted LF FD.io labs:
+2n-skx, 3n-skx, 2n-clx. Box-and-Whisker plots are used to display variations in
+measured throughput values, without making any assumptions of the
+underlying statistical distribution.
+
+For each test case, Box-and-Whisker plots show the quartiles (Min, 1st
+quartile / 25th percentile, 2nd quartile / 50th percentile / mean, 3rd
+quartile / 75th percentile, Max) across collected data set. Outliers are
+plotted as individual points.
+
+Additional information about graph data:
+
+#. **Graph Title**: describes tested packet path, testbed topology,
+   processor model, NIC model, packet size, number of cores and
+   threads used by data plane workers and indication of DPDK DUT
+   configuration.
+
+#. **X-axis Labels**: indices of individual test suites as listed in
+   Graph Legend.
+
+#. **Y-axis Labels**: measured Packets Per Second [pps] throughput
+   values.
+
+#. **Graph Legend**: lists X-axis indices with associated CSIT test
+   suites executed to generate graphed test results.
+
+#. **Hover Information**: lists minimum, first quartile, median,
+   third quartile, and maximum. If either type of outlier is present the
+   whisker on the appropriate side is taken to 1.5×IQR from the quartile
+   (the "inner fence") rather than the max or min, and individual outlying
+   data points are displayed as unfilled circles (for suspected outliers)
+   or filled circles (for outliers). (The "outer fence" is 3×IQR from the
+   quartile.)
 
 .. note::
 
-    Test results have been generated by
-    `FD.io test executor dpdk performance jobs`_ with Robot Framework result
-    files csit-dpdk-perf-\*.zip `archived here <../../_static/archive/>`_.
-    Plotted data set size per test case is equal to the number of job executions
-    presented in this report version: **10**.
+    Test results are stored in
+    `build logs from FD.io dpdk performance job 2n-skx`_,
+    `build logs from FD.io dpdk performance job 3n-skx`_,
+    `build logs from FD.io dpdk performance job 2n-clx`_,
+    `build logs from FD.io dpdk performance job 2n-zn2`_,
+    `build logs from FD.io dpdk performance job 3n-tsh`_,
+    `build logs from FD.io dpdk performance job 2n-tx2`_,
+    `build logs from FD.io dpdk performance job 2n-dnv`_ and
+    `build logs from FD.io dpdk performance job 3n-dnv`_ with RF
+    result files csit-dpdk-perf-|srelease|-\*.zip
+    `archived here <../../_static/archive/>`_.
+    Required per test case data set size is **10** and for DPDK tests
+    this is the actual size, as all scheduled test executions completed
+    successfully.
 
 .. toctree::
+    :maxdepth: 3
+
+    2n-skx-xxv710
+    2n-skx-x710
+    3n-skx-xxv710
+    3n-skx-x710
+    2n-clx-xxv710
+    2n-clx-x710
+    2n-zn2-xxv710
+    2n-zn2-x710
+    3n-tsh-x520
+    2n-tx2-xl710
 
-    l2
-    ipv4
+..
+    2n-dnv-x553
+    3n-dnv-x553