docs/cpta/methodology/index.rst

   1 .. _trending_methodology:
   2
   3 Trending Methodology
   4 ====================
   5
   6 Overview
   7 --------
   8
   9 This document describes a high-level design of a system for continuous
  10 performance measuring, trending and change detection for FD.io VPP SW
  11 data plane. It builds upon the existing FD.io CSIT framework with
  12 extensions to its throughput testing methodology, CSIT data analytics
  13 engine (PAL – Presentation-and-Analytics-Layer) and associated Jenkins
  14 jobs definitions.
  15
  16 Proposed design replaces existing CSIT performance trending jobs and
  17 tests with new Performance Trending (PT) CSIT module and separate
  18 Performance Analysis (PA) module ingesting results from PT and
  19 analysing, detecting and reporting any performance anomalies using
  20 historical trending data and statistical metrics. PA does also produce
  21 trending dashboard and graphs with summary and drill-down views across
  22 all specified tests that can be reviewed and inspected regularly by
  23 FD.io developers and users community.
  24
  25 Performance Tests
  26 -----------------
  27
  28 Performance trending is currently relying on the Maximum Receive Rate
  29 (MRR) tests. MRR tests measure the packet forwarding rate under the
  30 maximum load offered by traffic generator over a set trial duration,
  31 regardless of packet loss. Maximum load for specified Ethernet frame
  32 size is set to the bi-directional link rate.
  33
  34 Current parameters for performance trending MRR tests:
  35
  36 - **Ethernet frame sizes**: 64B (78B for IPv6 tests) for all tests, IMIX for
  37   selected tests (vhost, memif); all quoted sizes include frame CRC, but
  38   exclude per frame transmission overhead of 20B (preamble, inter frame
  39   gap).
  40 - **Maximum load offered**: 10GE and 40GE link (sub-)rates depending on NIC
  41   tested, with the actual packet rate depending on frame size,
  42   transmission overhead and traffic generator NIC forwarding capacity.
  43
  44   - For 10GE NICs the maximum packet rate load is 2* 14.88 Mpps for 64B,
  45     a 10GE bi-directional link rate.
  46   - For 40GE NICs the maximum packet rate load is 2* 18.75 Mpps for 64B,
  47     a 40GE bi-directional link sub-rate limited by TG 40GE NIC used,
  48     XL710.
  49
  50 - **Trial duration**: 10sec.
  51 - **Execution frequency**: twice a day, every 12 hrs (02:00, 14:00 UTC).
  52
  53 Note: MRR tests should be reporting bi-directional link rate (or NIC
  54 rate, if lower) if tested VPP configuration can handle the packet rate
  55 higher than bi-directional link rate, e.g. large packet tests and/or
  56 multi-core tests. In other words MRR = min(VPP rate, bi-dir link rate,
  57 NIC rate).
  58
  59 Trend Analysis
  60 --------------
  61
  62 All measured performance trend data is treated as time-series data that
  63 can be modelled using normal distribution. After trimming the outliers,
  64 the median and deviations from median are used for detecting performance
  65 change anomalies following the three-sigma rule of thumb (a.k.a.
  66 68-95-99.7 rule).
  67
  68 Metrics
  69 ````````````````
  70
  71 Following statistical metrics are used as performance trend indicators
  72 over the rolling window of last <N> sets of historical measurement data:
  73
  74 - **Q1**, **Q2**, **Q3** : **Quartiles**, three points dividing a ranked
  75   data set of <N> values into four equal parts, Q2 is the median of the
  76   data.
  77 - **IQR** = Q3 - Q1 : **Inter Quartile Range**, measure of variability,
  78   used here to calculate and eliminate outliers.
  79 - **Outliers** : extreme values that are at least (1.5 * IQR) below Q1.
  80
  81   - Note: extreme values that are at least (1.5 * IQR) above Q3 are not
  82     considered outliers, and are likely to be classified as
  83     progressions.
  84
  85 - **TMA** : **Trimmed Moving Average**, average across the data set of
  86   <N> values without the outliers. Used here to calculate TMSD.
  87 - **TMSD** : **Trimmed Moving Standard Deviation**, standard deviation
  88   over the data set of <N> values without the outliers, requires
  89   calculating TMA. Used for anomaly detection.
  90 - **TMM** : **Trimmed Moving Median**, median across the data set of <N>
  91   values excluding the outliers. Used as a trending value and as a
  92   reference for anomaly detection.
  93
  94 Outlier Detection
  95 `````````````````
  96
  97 Outlier evaluation of test result of value <X> follows the definition
  98 from previous section:
  99
 100 +----------------------------+----------------------+
 101 | Outlier Evaluation Formula | Evaluation Result    |
 102 +============================+======================+
 103 | X < (Q1 - 1.5 * IQR)       | Outlier              |
 104 +----------------------------+----------------------+
 105 | X >= (Q1 - 1.5 * IQR)      | Valid (For Trending) |
 106 +----------------------------+----------------------+
 107
 108 Anomaly Detection
 109 `````````````````
 110
 111 To verify compliance of test result of valid value <X> against defined
 112 trend metrics and detect anomalies, three simple evaluation formulas are
 113 used:
 114
 115 +-------------------------------------------+------------------+-------------+
 116 |       Anomaly                             |    Compliance    | Evaluation  |
 117 | Evaluation Formula                        | Confidence Level |   Result    |
 118 +===========================================+==================+=============+
 119 | (TMM - 3 * TMSD) <= X <= (TMM + 3 * TMSD) |      99.73%      |   Normal    |
 120 +-------------------------------------------+------------------+-------------+
 121 | X < (TMM - 3 * TMSD)                      |      Anomaly     | Regression  |
 122 +-------------------------------------------+------------------+-------------+
 123 | X > (TMM + 3 * TMSD)                      |      Anomaly     | Progression |
 124 +-------------------------------------------+------------------+-------------+
 125
 126 TMM is used for the central trend reference point instead of TMA as it
 127 is more robust to anomalies.
 128
 129 Trend Compliance
 130 ````````````````
 131
 132 Trend compliance metrics are targeted to provide an indication of trend
 133 changes over a short-term (i.e. weekly) and a long-term (i.e.
 134 quarterly), comparing the last trend value, TMM[last], to one from week
 135 ago, TMM[last - 1week] and to the maximum of trend values over last
 136 quarter except last week, max(TMM[(last - 3mths)..(last - 1week)]),
 137 respectively. This results in following trend compliance calculations:
 138
 139 +-------------------+----------------+-----------+------------------------------------------+
 140 |      Trend        |                |           |                                          |
 141 | Compliance Metric | Change Formula | V(alue)   | R(eference)                              |
 142 +===================+================+===========+==========================================+
 143 | Short-Term Change | ((V - R) / R)  | TMM[last] | TMM[last - 1week]                        |
 144 +-------------------+----------------+-----------+------------------------------------------+
 145 | Long-Term Change  | ((V - R) / R)  | TMM[last] | max(TMM[(last - 3mths)..(last - 1week)]) |
 146 +-------------------+----------------+-----------+------------------------------------------+
 147
 148 Trend Presentation
 149 ------------------
 150
 151 Performance Dashboard
 152 `````````````````````
 153
 154 Dashboard tables list a summary of per test-case VPP MRR performance
 155 trend and trend compliance metrics and detected number of anomalies.
 156
 157 Separate tables are generated for tested VPP worker-thread-core
 158 combinations (1t1c, 2t2c, 4t4c). Test case names are linked to
 159 respective trending graphs for ease of navigation thru the test data.
 160
 161 Trendline Graphs
 162 ````````````````
 163
 164 Trendline graphs show per test case measured MRR throughput values with
 165 associated trendlines. The graphs are constructed as follows:
 166
 167 - X-axis represents performance trend job build Id (csit-vpp-perf-mrr-
 168   daily-master-build).
 169 - Y-axis represents MRR throughput in Mpps.
 170 - Markers to indicate anomaly classification:
 171
 172   - Outlier - gray circle around MRR value point.
 173   - Regression - red circle.
 174   - Progression - green circle.
 175
 176 In addition the graphs show dynamic labels while hovering over graph
 177 data points, representing (trend job build Id, MRR value) and the actual
 178 vpp build number (b<XXX>) tested.
 179
 180
 181 Jenkins Jobs
 182 ------------
 183
 184 Performance Trending (PT)
 185 `````````````````````````
 186
 187 CSIT PT runs regular performance test jobs measuring and collecting MRR
 188 data per test case. PT is designed as follows:
 189
 190 1. PT job triggers:
 191
 192    a) Periodic e.g. daily.
 193    b) On-demand gerrit triggered.
 194
 195 2. Measurements and data calculations per test case:
 196
 197   a) Max Received Rate (MRR) - send packets at link rate over a trial
 198      period, count total received packets, divide by trial period.
 199
 200 3. Archive MRR per test case.
 201 4. Archive all counters collected at MRR.
 202
 203 Performance Analysis (PA)
 204 `````````````````````````
 205
 206 CSIT PA runs performance analysis including trendline calculation, trend
 207 compliance and anomaly detection using specified trend analysis metrics
 208 over the rolling window of last <N> sets of historical measurement data.
 209 PA is defined as follows:
 210
 211 1. PA job triggers:
 212
 213    a) By PT job at its completion.
 214    b) On-demand gerrit triggered.
 215
 216 2. Download and parse archived historical data and the new data:
 217
 218    a) Download RF output.xml files from latest PT job and compressed
 219       archived data.
 220    b) Parse out the data filtering test cases listed in PA specification
 221       (part of CSIT PAL specification file).
 222    c) Evalute new data from latest PT job against the rolling window of
 223       <N> sets of historical data for trendline calculation, anomaly
 224       detection and short-term trend compliance. And against long-term
 225       trendline metrics for long-term trend compliance.
 226
 227 3. Calculate trend metrics for the rolling window of <N> sets of
 228    historical data:
 229
 230    a) Calculate quartiles Q1, Q2, Q3.
 231    b) Trim outliers using IQR.
 232    c) Calculate TMA and TMSD.
 233    d) Calculate normal trending range per test case based on TMM and
 234       TMSD.
 235
 236 4. Evaluate new test data against trend metrics:
 237
 238    a) If within the range of (TMA +/- 3*TMSD) => Result = Pass,
 239       Reason = Normal. (to be updated base on the final Jenkins code).
 240    b) If below the range => Result = Fail, Reason = Regression.
 241    c) If above the range => Result = Pass, Reason = Progression.
 242
 243 5. Generate and publish results
 244
 245    a) Relay evaluation result to job result. (to be updated base on the
 246       final Jenkins code).
 247    b) Generate a new set of trend summary dashboard and graphs.
 248    c) Publish trend dashboard and graphs in html format on
 249       https://docs.fd.io/.