CSIT-1041: Trending dashboard

Change-Id: I2b08c3c1859302437092456da4bb8f1ebe4756bf
Signed-off-by: Tibor Frank <tifrank@cisco.com>

1 files changed, 20 insertions, 19 deletions

diff --git a/docs/cpta/introduction/index.rst b/docs/cpta/introduction/index.rst
index 31da9aeb18..516e8b36e0 100644
--- a/docs/cpta/introduction/index.rst
+++ b/docs/cpta/introduction/index.rst
@@ -4,27 +4,29 @@ VPP MRR 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 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, trend compliance and anomaly calculations are 
+based on a rolling window of <N> samples, currently N=14 covering last 7 days. 
+Separate tables are generated for tested VPP worker-thread-core combinations 
+(1t1c, 2t2c, 4t4c).
 
 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.
+    - "Test Case": name of CSIT test case, naming convention on
+      `CSIT wiki <https://wiki.fd.io/view/CSIT/csit-test-naming>`_.
+    - "Throughput Trend [Mpps]": last value of trend calculated over a
+      rolling window.
+    - "Trend Compliance": calculated based on detected anomalies, listed in
+       precedence order - i) "failure" if 3 consecutive outliers,
+       ii) "regression" if any regressions, iii) "progression" if any
+       progressions, iv) "normal" if data compliant with trend.
+    - "Anomaly Value [Mpps]": i) highest outlier if "failure", ii) highest
+      regression if "regression", iii) highest progression if "progression",
+      iv) "-" if normal i.e. within trend.
+    - "Change [%]": "Anomaly Value" vs. "Throughput Trend", "-" if normal.
+    - "# Outliers": number of outliers detected within a rolling window.
 
 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
@@ -44,4 +46,3 @@ VPP worker on 4t4c
 ------------------
 
 .. include:: ../../../_build/_static/vpp/performance-trending-dashboard-4t4c.rst
-