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