Edits in trending docs: methodology, dashboard.
[csit.git] / docs / cpta / introduction / index.rst
index 31da9ae..8b3c170 100644 (file)
@@ -1,34 +1,40 @@
-VPP MRR Performance Dashboard
-=============================
+VPP Performance Dashboard
+=========================
 
 Description
 -----------
 
-Dashboard tables list a summary of per test-case VPP MRR performance trend
-values and detected anomalies (Maximum Receive Rate - received packet rate
-under line rate load). Data comes from trending MRR jobs executed every 12 hrs
-(2:00, 14:00 UTC). Trend and anomaly calculations are done over a rolling
-window of <N> samples, currently with N=14 covering last 7 days. Separate
-tables are generated for tested VPP worker-thread-core combinations (1t1c,
-2t2c, 4t4c).
+Dashboard tables list a summary of latest per test-case VPP Maximum
+Receive Rate (MRR) performance trend, trend compliance metrics and
+detected number of anomalies. Data samples come from the CSIT VPP
+performance trending 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 here
-      `CSIT/csit-test-naming <https://wiki.fd.io/view/CSIT/csit-test-naming>`_
-    - "Thput trend [Mpps]": last value of trend over rolling window.
-    - "Anomaly value [Mpps]": in precedence - i) highest outlier if 3
-      consecutive outliers, ii) highest regression if regressions detected,
-      iii) highest progression if progressions detected, iv) nil if normal i.e.
-      within trend.
-    - "Anomaly vs. Trend [%]": anomaly value vs. trend value.
-    - "Classification": outlier, regression, progression, normal - observed
-      over a rolling window.
-    - "# Outliers": number of outliers detected.
-
-Tables are listed in sections 1.x. Followed by daily trending graphs in
-sections 2.x. Daily trending data used to generate the graphs is listed in
-sections 3.x.
+    - **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.
+
+MRR tests measure the packet forwarding rate under the maximum load
+offered by traffic generator over a set trial duration, regardless of
+packet loss.
+
+For more detail about MRR tests, trend and anomaly calculations please
+refer to :ref:`trending_methodology` section.
+
+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
 ------------------
@@ -44,4 +50,3 @@ VPP worker on 4t4c
 ------------------
 
 .. include:: ../../../_build/_static/vpp/performance-trending-dashboard-4t4c.rst
-