CSIT-1041: Trending dashboard

[csit.git] / docs / cpta / introduction / index.rst

diff --git a/docs/cpta/introduction/index.rst b/docs/cpta/introduction/index.rst
index 5d31b33..df47dc5 100644 (file)
--- a/docs/cpta/introduction/index.rst
+++ b/docs/cpta/introduction/index.rst
@@ -1,8 +1,47 @@
-VPP Performance Trending
-========================
-
-This auto-generated document contains VPP performance trending graphs and data.
-It is generated using CSIT continuous trending test and analysis jobs and is
-updated daily. More detail is available on
-`CSIT Performance Trending and Analysis <https://wiki.fd.io/view/CSIT/PerformanceTrendingAnalysis>`_
-wiki page.
+VPP MRR Performance Dashboard
+=============================
+
+Description
+-----------
+
+Dashboard tables list a summary of per test-case VPP MRR performance
+trend and trend compliance metrics, and detected number of anomalies.
+Data samples come from the CSIT VPP trending MRR jobs executed twice a
+day, every 12 hrs (02:00, 14:00 UTC). All trend and anomaly evaluation
+is based on a rolling window of <N=14> data samples, covering last 7
+days.
+
+Legend to table:
+
+    - **Test Case** : name of CSIT test case, naming convention in
+      `CSIT wiki <https://wiki.fd.io/view/CSIT/csit-test-naming>`_.
+    - **Trend [Mpps]** : last value of trend.
+    - **Short-Term Change [%]** : Relative change of last trend value vs. last
+      week trend value.
+    - **Long-Term Change [%]** : Relative change of last trend value vs. maximum
+      of trend values over the last quarter except last week.
+    - **Regressions [#]** : Number of regressions detected.
+    - **Progressions [#]** : Number of progressions detected.
+    - **Outliers [#]** : Number of outliers detected.
+
+All trend and anomaly calculations are defined in :ref:`trending_methodology`.
+
+Tested VPP worker-thread-core combinations (1t1c, 2t2c, 4t4c) are listed
+in separate tables in section 1.x. Followed by trending methodology in
+section 2. and daily trending graphs in sections 3.x. Daily trending
+data used is provided in sections 4.x.
+
+VPP worker on 1t1c
+------------------
+
+.. include:: ../../../_build/_static/vpp/performance-trending-dashboard-1t1c.rst
+
+VPP worker on 2t2c
+------------------
+
+.. include:: ../../../_build/_static/vpp/performance-trending-dashboard-2t2c.rst
+
+VPP worker on 4t4c
+------------------
+
+.. include:: ../../../_build/_static/vpp/performance-trending-dashboard-4t4c.rst