X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=docs%2Freport%2Fvpp_performance_tests%2Fpacket_throughput_graphs%2Findex.rst;h=7c2a1a9e263b70e5360ee6475cef9ce0eeedb68f;hp=bf2a87fab74297378210561d584189561c3e1857;hb=7b213e217377d9862c1aef426fd0b6b27b3e6d8d;hpb=da2aa127ee071e37bc4d6060dd39476179e65365 diff --git a/docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst b/docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst index bf2a87fab7..7c2a1a9e26 100644 --- a/docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst +++ b/docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst @@ -1,11 +1,47 @@ 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 vpp 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. + + +.. note:: + + Test results have been generated by + `FD.io test executor vpp performance jobs`_ with Robot Framework result + files csit-vpp-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**. + .. toctree:: l2 - ipv4 - ipv6 - ipv4_tunnels - ipv6_tunnels + ip4 + ip6 + ip4_tunnels + ip6_tunnels vm_vhost + container_memif + container_orchestrated + ipsec