Report: Data sources
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index 0a5d25e..377bd30 100644 (file)
@@ -4,122 +4,147 @@ CSIT Release Notes
 Changes in CSIT |release|\r
 -------------------------\r
 \r
-#. VPP performance test environment changes\r
+#. **VPP performance tests**\r
 \r
-   - Further optimizations of VM and vhost-user test environment - various\r
-     Qemu virtio queue size testing with value of 256 and 1024. Applied\r
-     Linux CFS optimization to run VPP worker threads and Qemu worker threads\r
-     with highest priority.\r
+   - *MRR tests* - New Maximum Receive Rate tests measure the packet\r
+     forwarding rate under the maximum load offered by traffic\r
+     generator over a set trial duration, regardless of packet loss.\r
+     MRR tests are used for continuous performance trending and for\r
+     comparison between releases.\r
 \r
-#. VPP performance test framework changes\r
+   - *Service Chaining with SRv6* - New SRv6 (Segment Routing IPv6) proxy\r
+     tests measure performance of SRv6 Endpoint fronting SR-unaware\r
+     appliance via masquerading (End.AM), dynamic proxy (End.AD) or\r
+     static proxy (End.AS) SR functions.\r
 \r
-   - Full code review, optimization and refactor.\r
+#. **Presentation and Analytics Layer**\r
 \r
-#. T-rex changes\r
+   - *Performance trending* - Added continuous performance trending and\r
+     analysis. New Performance Trending and Performance Analysis jobs\r
+     executed regular throughput tests, with results being subsequently\r
+     analysed and trend and anomalies summarized and presented in VPP\r
+     Performance Dashboard and trendline graphs.\r
 \r
-   - Full refactor of T-rex driver and introduce of traffic profiles that\r
-     improves readability, manageability of traffic profiles for various\r
-     test scenarios.\r
+#. **Test Framework Optimizations**\r
 \r
-#. Added VPP performance tests\r
+   - *Performance tests efficiency* - Qemu build/install optimizations,\r
+     warmup phase handling, vpp restart handling. Resulted in improved\r
+     stability and reduced total execution time by 30% for single pkt\r
+     size e.g. 64B/78B.\r
 \r
-   - **LXC memif**\r
+   - *General code housekeeping* - ongoing RF keywords optimizations,\r
+     removal of redundant RF keywords.\r
 \r
-     - Memif interface tests interconnecting two VPP instances on single SUT.\r
-       Master VPP instance running on native OS with Intel x520 NIC and guest\r
-       VPP instance running in Linux Container (LXC) doing the L2 cross\r
-       connect loop. LXC running in privileged mode is pinned to dedicated\r
-       cores. All VPP instances are same version.\r
+Performance Changes\r
+-------------------\r
 \r
-   - **Stateful Security Groups**\r
+Relative performance changes in measured packet throughput in CSIT\r
+|release| are calculated against the results from CSIT |release-1|\r
+report. Listed mean and standard deviation values are computed based on\r
+a series of the same tests executed against respective VPP releases to\r
+verify test results repeatibility, with percentage change calculated for\r
+mean values. Note that the standard deviation is quite high for a small\r
+number of packet throughput tests, what indicates poor test results\r
+repeatability and makes the relative change of mean throughput value not\r
+fully representative for these tests. The root causes behind poor\r
+results repeatibility vary between the test cases.\r
 \r
-   - **VM vhost use cases**\r
+NDR Changes\r
+~~~~~~~~~~~\r
 \r
-Performance Improvements\r
-------------------------\r
+NDR small packet throughput changes between releases are available in a\r
+CSV and pretty ASCII formats:\r
 \r
-Substantial improvements in measured packet throughput have been\r
-observed in a number of CSIT |release| tests listed below, with relative\r
-increase  of double-digit percentage points. Relative improvements are\r
-calculated against the test results listed in CSIT |release-1| report.\r
-VPP-16.09 numbers are provided for reference.\r
+  - `csv format for 1t1c <../_static/vpp/performance-changes-ndr-1t1c-full.csv>`_,\r
+  - `csv format for 2t2c <../_static/vpp/performance-changes-ndr-2t2c-full.csv>`_,\r
+  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-ndr-1t1c-full.txt>`_,\r
+  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-ndr-2t2c-full.txt>`_.\r
 \r
-NDR Throughput\r
-~~~~~~~~~~~~~~\r
+.. note::\r
 \r
-Non-Drop Rate Throughput discovery tests:\r
+    Test results have been generated by\r
+    `FD.io test executor vpp performance jobs`_ with Robot Framework result\r
+    files csit-vpp-perf-|srelease|-\*.zip `archived here <../_static/archive/>`_.\r
 \r
-.. csv-table::\r
-    :align: center\r
-    :header-rows: 1\r
-    :file: ../../../docs/report/vpp_performance_tests/performance_improvements/ndr_throughput.csv\r
+PDR Changes\r
+~~~~~~~~~~~\r
 \r
-PDR Throughput\r
-~~~~~~~~~~~~~~\r
+NDR small packet throughput changes between releases are available in a\r
+CSV and pretty ASCII formats:\r
 \r
-Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:\r
+  - `csv format for 1t1c <../_static/vpp/performance-changes-pdr-1t1c-full.csv>`_,\r
+  - `csv format for 2t2c <../_static/vpp/performance-changes-pdr-2t2c-full.csv>`_,\r
+  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-pdr-1t1c-full.txt>`_,\r
+  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-pdr-2t2c-full.txt>`_.\r
 \r
-.. csv-table::\r
-    :align: center\r
-    :header-rows: 1\r
-    :file: ../../../docs/report/vpp_performance_tests/performance_improvements/pdr_throughput.csv\r
+.. note::\r
 \r
-Measured improvements are in line with VPP code optimizations listed in\r
-`VPP-17.07 release notes\r
-<https://docs.fd.io/vpp/17.07/release_notes_1707.html>`_.\r
+    Test results have been generated by\r
+    `FD.io test executor vpp performance jobs`_ with Robot Framework result\r
+    files csit-vpp-perf-|srelease|-\*.zip `archived here <../_static/archive/>`_.\r
 \r
-Other Performance Changes\r
--------------------------\r
+MRR Changes\r
+~~~~~~~~~~~\r
+\r
+MRR small packet throughput changes between releases are available in a\r
+CSV and pretty ASCII formats:\r
 \r
-Other changes in measured packet throughput, with either minor relative\r
-increase or decrease, have been observed in a number of CSIT |release|\r
-tests listed below. Relative changes are calculated against the test\r
-results listed in CSIT |release-1| report.\r
+  - `csv format for 1t1c <../_static/vpp/performance-changes-mrr-1t1c-full.csv>`_,\r
+  - `csv format for 2t2c <../_static/vpp/performance-changes-mrr-2t2c-full.csv>`_,\r
+  - `csv format for 4t4c <../_static/vpp/performance-changes-mrr-4t4c-full.csv>`_,\r
+  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-mrr-1t1c-full.txt>`_,\r
+  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-mrr-2t2c-full.txt>`_,\r
+  - `pretty ASCII format for 4t4c <../_static/vpp/performance-changes-mrr-4t4c-full.txt>`_.\r
 \r
-NDR Throughput\r
-~~~~~~~~~~~~~~\r
+.. note::\r
 \r
-Non-Drop Rate Throughput discovery tests:\r
+    Test results have been generated by\r
+    `FD.io test executor vpp mrr jobs <https://jenkins.fd.io/view/csit/job/csit-vpp-perf-mrr-daily-master/>`_\r
+    with Robot Framework result files csit-vpp-perf-mrr-daily-master__*__output.xml.gz\r
+    `archived here <https://docs.fd.io/csit/master/trending/_static/archive/>`_.\r
 \r
-.. csv-table::\r
-    :align: center\r
-    :header-rows: 1\r
-    :file: ../../../docs/report/vpp_performance_tests/performance_improvements/ndr_throughput_others.csv\r
+Throughput Trending\r
+-------------------\r
 \r
-PDR Throughput\r
-~~~~~~~~~~~~~~\r
+In addition to reporting throughput changes between VPP releases, CSIT\r
+provides continuous performance trending for VPP master branch:\r
 \r
-Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:\r
+#. `VPP Performance Dashboard <https://docs.fd.io/csit/master/trending/introduction/index.html>`_\r
+   - per VPP test case throughput trend, trend compliance and summary of\r
+   detected anomalies.\r
 \r
-.. csv-table::\r
-    :align: center\r
-    :header-rows: 1\r
-    :file: ../../../docs/report/vpp_performance_tests/performance_improvements/pdr_throughput_others.csv\r
+#. `Trending Methodology <https://docs.fd.io/csit/master/trending/methodology/index.html>`_\r
+   - throughput test metrics, trend calculations and anomaly\r
+   classification (progression, regression, outlier).\r
 \r
+#. `Trendline Graphs <https://docs.fd.io/csit/master/trending/trending/index.html>`_\r
+   - per VPP build MRR throughput measurements against the trendline\r
+   with anomaly highlights, with associated CSIT test jobs.\r
 \r
 Known Issues\r
 ------------\r
 \r
-Here is the list of known issues in CSIT |release| for VPP performance tests:\r
+List of known issues in CSIT |release| for VPP performance tests:\r
 \r
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
 | # | Issue                                           | Jira ID    | Description                                                     |\r
++===+=================================================+============+=================================================================+\r
+| 1 | Sporadic (1 in 200) NDR discovery test failures | CSIT-570   | DPDK reporting rx-errors, indicating L1 issue. Suspected issue  |\r
+|   | on x520.                                        |            | with HW combination of X710-X520 in LF testbeds. Not observed   |\r
+|   |                                                 |            | outside of LF testbeds.                                         |\r
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 1 | NDR discovery test failures 1518B frame size    | VPP-663    | VPP reporting errors: dpdk-input Rx ip checksum errors.         |\r
-|   | for ip4scale200k, ip4scale2m scale IPv4 routed- |            | Observed frequency: all test runs.                              |\r
-|   | forwarding tests. ip4scale20k tests are fine.   |            |                                                                 |\r
+| 2 | Lower than expected NDR throughput of DPDK      | CSIT-571   | Suspected NIC firmware or DPDK driver issue affecting NDR and   |\r
+|   | testpmd and VPP L2 path NDR throughput with     |            | PDR throughput on XL710 and X710 NICs.                          |\r
+|   | xl710 and x710 NICs, compared to x520 NICs.     |            |                                                                 |\r
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 2 | Vic1385 and Vic1227 low performance.            | VPP-664    | Low NDR performance.                                            |\r
-|   |                                                 |            |                                                                 |\r
+| 3 | Tagged Ethernet dot1q and dot1ad L2 path        | CSIT-1066  | Tagged Ethernet dot1q and dot1ad L2 path throughput regression: |\r
+|   | throughput regression.                          |            | NDR -2%..-5%, PDR -2%..-6%, MRR. Affects l2xc and l2bd          |\r
+|   |                                                 |            | performance tests.                                              |\r
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 3 | Sporadic NDR discovery test failures on x520.   | CSIT-750   | Suspected issue with HW settings (BIOS, FW) in LF               |\r
-|   |                                                 |            | infrastructure. Issue can't be replicated outside LF.           |\r
+| 4 | IPSec (software, no QAT HW) throughput          | CSIT-1064  | IPSec throughput regression: NDR -3%..-8%, PDR -2%..-8%, MRR    |\r
+|   | regression.                                     |            | -3%..-7%. Affects IPSec SW tests, QAT HW tests not affected.    |\r
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 4 | VPP in 2t2c setups - large variation            | CSIT-568   | Suspected NIC firmware or DPDK driver issue affecting NDR       |\r
-|   | of discovered NDR throughput values across      |            | throughput. Applies to XL710 and X710 NICs, x520 NICs are fine. |\r
-|   | multiple test runs with xl710 and x710 NICs.    |            |                                                                 |\r
+| 5 | High failure rate of creating working container | CSIT-1065  | About 20% of orchestrated container topology tests failing data |\r
+|   | topologies with K8s/Ligato orchestration.       |            | plane verification indicating configuration issue. Suspected    |\r
+|   |                                                 |            | issue with Ligato vpp-agent.                                    |\r
 +---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 5 | Lower than expected NDR and PDR throughput with | CSIT-569   | Suspected NIC firmware or DPDK driver issue affecting NDR and   |\r
-|   | xl710 and x710 NICs, compared to x520 NICs.     |            | PDR throughput. Applies to XL710 and X710 NICs.                 |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-\r