Trending: Add link to testbed HW specification.
[csit.git] / docs / cpta / methodology / index.rst
index 8bff734..3497789 100644 (file)
@@ -94,7 +94,7 @@ over the rolling window of last <N> sets of historical measurement data:
 Outlier Detection
 `````````````````
 
-Outlier evaluation of test result of value <X> follows the definition
+Outlier evaluation of test result of value *X* follows the definition
 from previous section:
 
 +----------------------------+----------------------+
@@ -112,16 +112,15 @@ To verify compliance of test result of valid value <X> against defined
 trend metrics and detect anomalies, three simple evaluation formulas are
 used:
 
-+-------------------------------------------+------------------+-------------+
-|       Anomaly                             |    Compliance    | Evaluation  |
-| Evaluation Formula                        | Confidence Level |   Result    |
-+===========================================+==================+=============+
-| (TMM - 3 * TMSD) <= X <= (TMM + 3 * TMSD) |      99.73%      |   Normal    |
-+-------------------------------------------+------------------+-------------+
-| X < (TMM - 3 * TMSD)                      |      Anomaly     | Regression  |
-+-------------------------------------------+------------------+-------------+
-| X > (TMM + 3 * TMSD)                      |      Anomaly     | Progression |
-+-------------------------------------------+------------------+-------------+
++-------------------------------------------+-----------------------------+-------------------+
+| Anomaly Evaluation Formula                | Compliance Confidence Level | Evaluation Result |
++===========================================+=============================+===================+
+| (TMM - 3 * TMSD) <= X <= (TMM + 3 * TMSD) | 99.73%                      | Normal            |
++-------------------------------------------+-----------------------------+-------------------+
+| X < (TMM - 3 * TMSD)                      | Anomaly                     | Regression        |
++-------------------------------------------+-----------------------------+-------------------+
+| X > (TMM + 3 * TMSD)                      | Anomaly                     | Progression       |
++-------------------------------------------+-----------------------------+-------------------+
 
 TMM is used for the central trend reference point instead of TMA as it
 is more robust to anomalies.
@@ -136,14 +135,13 @@ ago, TMM[last - 1week] and to the maximum of trend values over last
 quarter except last week, max(TMM[(last - 3mths)..(last - 1week)]),
 respectively. This results in following trend compliance calculations:
 
-+-------------------+----------------+-----------+------------------------------------------+
-|      Trend        |                |           |                                          |
-| Compliance Metric | Change Formula | V(alue)   | R(eference)                              |
-+===================+================+===========+==========================================+
-| Short-Term Change | ((V - R) / R)  | TMM[last] | TMM[last - 1week]                        |
-+-------------------+----------------+-----------+------------------------------------------+
-| Long-Term Change  | ((V - R) / R)  | TMM[last] | max(TMM[(last - 3mths)..(last - 1week)]) |
-+-------------------+----------------+-----------+------------------------------------------+
++-------------------------+---------------------------------+-----------+------------------------------------------+
+| Trend Compliance Metric | Trend Change Formula            | Value     | Reference                                |
++=========================+=================================+===========+==========================================+
+| Short-Term Change       | (Value - Reference) / Reference | TMM[last] | TMM[last - 1week]                        |
++-------------------------+---------------------------------+-----------+------------------------------------------+
+| Long-Term Change        | (Value - Reference) / Reference | TMM[last] | max(TMM[(last - 3mths)..(last - 1week)]) |
++-------------------------+---------------------------------+-----------+------------------------------------------+
 
 Trend Presentation
 ------------------
@@ -247,3 +245,9 @@ PA is defined as follows:
    b) Generate a new set of trend summary dashboard and graphs.
    c) Publish trend dashboard and graphs in html format on
       https://docs.fd.io/.
+
+Testbed HW configuration
+------------------------
+
+The testbed HW configuration is described on
+`this FD.IO wiki page <https://wiki.fd.io/view/CSIT/CSIT_LF_testbed#FD.IO_CSIT_testbed_-_Server_HW_Configuration>`_.