CSIT-1332: Proposal of new layout of all graphs

[csit.git] / docs / report / vpp_performance_tests / packet_latency_graphs / index.rst

diff --git a/docs/report/vpp_performance_tests/packet_latency_graphs/index.rst b/docs/report/vpp_performance_tests/packet_latency_graphs/index.rst
index dd8d320..c2dc2ae 100644 (file)
--- a/docs/report/vpp_performance_tests/packet_latency_graphs/index.rst
+++ b/docs/report/vpp_performance_tests/packet_latency_graphs/index.rst
@@ -1,29 +1,45 @@
+
+.. raw:: latex
+
+    \clearpage
+
 Packet Latency
 ==============
 
-Plotted results are generated from a single execution of CSIT NDR discovery
-test. Box plots are used to show the Minimum, Median and Maximum packet
+Latency results are generated from a single execution of NDR discovery
+test across physical testbeds hosted LF FD.io labs: 3n-hsw, 2n-skx, 2n-
+skx. Box plots are used to show the Minimum, Median and Maximum packet
 latency per test.
 
-*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 vpp performance jobs`_ that created result output file
-used as data source for the graph, *Y-axis labels* are measured packet Latency
-[uSec] values, and the *Graph legend* lists the plotted test suites and their
-indices. Latency is reported for concurrent symmetric bi-directional flows,
-separately for each direction: i) West-to-East:
-TGint1-to-SUT1-to-SUT2-to-TGint2, and ii) East-to-West:
-TGint2-to-SUT2-to-SUT1-to-TGint1.
+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 DUT
+   configuration.
+
+#. **X-axis Labels**: indices of individual test suites as listed in
+   Graph Legend and direction of latency flow:
+
+   - West-to-East: TGint1-to-SUT1-to-SUT2-to-TGint2.
+   - East-to-West: TGint2-to-SUT2-to-SUT1-to-TGint1.
+
+#. **Y-axis Labels**: measured packet latency values in [uSec].
+
+#. **Graph Legend**: lists X-axis indices with associated CSIT test
+   suites executed to generate graphed test results.
 
 .. note::
 
     Test results have been generated by
-    `FD.io test executor vpp performance jobs`_ with Robot Framework result
-    files csit-vpp-perf-|srelease|-\*.zip `archived here <../../_static/archive/>`_.
+    `FD.io test executor vpp performance job 3n-hsw`_,
+    `FD.io test executor vpp performance job 3n-skx`_ and
+    `FD.io test executor vpp performance job 2n-skx`_ with RF
+    result files csit-vpp-perf-|srelease|-\*.zip
+    `archived here <../../_static/archive/>`_.
 
 .. toctree::
-    :maxdepth: 1
+    :maxdepth: 3
 
     l2
     ip4