Trending docs: format and section naming fixes.
[csit.git] / docs / cpta / introduction / index.rst
1 VPP Performance Dashboard
2 =========================
3
4 Description
5 -----------
6
7 Performance dashboard tables provide the latest VPP throughput trend,
8 trend compliance and detected anomalies, all on a per VPP test case
9 basis.  Linked trendline graphs enable further drill-down into the
10 trendline compliance, sequence and nature of anomalies, as well as
11 pointers to performance test builds/logs and VPP builds. Performance
12 trending is currently based on the Maximum Receive Rate (MRR) tests. MRR
13 tests measure the packet forwarding rate under the maximum load offered
14 by traffic generator over a set trial duration, regardless of packet
15 loss. See :ref:`trending_methodology` section for more detail including
16 trend and anomaly calculations.
17
18 Data samples are generated by the CSIT VPP performance trending jobs
19 executed twice a day (target start: every 12 hrs, 02:00, 14:00 UTC). All
20 trend and anomaly evaluation is based on a rolling window of <N=14> data
21 samples, covering last 7 days.
22
23 Legend to table:
24
25     - **Test Case** : name of FD.io CSIT test case, naming convention
26       `here <https://wiki.fd.io/view/CSIT/csit-test-naming>`_.
27     - **Trend [Mpps]** : last value of performance trend.
28     - **Short-Term Change [%]** : Relative change of last trend value
29       vs. last week trend value.
30     - **Long-Term Change [%]** : Relative change of last trend value vs.
31       maximum of trend values over the last quarter except last week.
32     - **Regressions [#]** : Number of regressions detected.
33     - **Progressions [#]** : Number of progressions detected.
34     - **Outliers [#]** : Number of outliers detected.
35
36 Tested VPP worker-thread-core combinations (1t1c, 2t2c, 4t4c) are listed
37 in separate tables in section 1.x. Followed by trending methodology in
38 section 2. and trendline graphs in sections 3.x. Performance test  data
39 used for trendline graphs is provided in sections 4.x.
40
41 VPP worker on 1t1c
42 ------------------
43
44 .. include:: ../../../_build/_static/vpp/performance-trending-dashboard-1t1c.rst
45
46 VPP worker on 2t2c
47 ------------------
48
49 .. include:: ../../../_build/_static/vpp/performance-trending-dashboard-2t2c.rst
50
51 VPP worker on 4t4c
52 ------------------
53
54 .. include:: ../../../_build/_static/vpp/performance-trending-dashboard-4t4c.rst

©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.