Edits in trending docs: methodology, dashboard.
[csit.git] / docs / cpta / introduction / index.rst
index df47dc5..8b3c170 100644 (file)
@@ -1,30 +1,35 @@
-VPP MRR Performance Dashboard
-=============================
+VPP 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.
+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 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.
+    - **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`.
+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

©2016 FD.io a Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.
Please see our privacy policy and terms of use.