C-Docs: New structure

Change-Id: I73d107f94b28b138f3350a9e1eedb0555583a9ca
Signed-off-by: Tibor Frank <tifrank@cisco.com>

1 files changed, 0 insertions, 238 deletions

diff --git a/docs/report/introduction/methodology_telemetry.rst b/docs/report/introduction/methodology_telemetry.rst
deleted file mode 100644
index c10f99affe..0000000000
--- a/docs/report/introduction/methodology_telemetry.rst
+++ /dev/null
@@ -1,238 +0,0 @@
-.. _telemetry:
-
-OpenMetrics
------------
-
-OpenMetrics specifies the de-facto standard for transmitting cloud-native
-metrics at scale, with support for both text representation and Protocol
-Buffers.
-
-RFC
-~~~
-
-- RFC2119
-- RFC5234
-- RFC8174
-- draft-richih-opsawg-openmetrics-00
-
-Reference
-~~~~~~~~~
-
-`OpenMetrics <https://github.com/OpenObservability/OpenMetrics/blob/master/specification/OpenMetrics.md>`_
-
-Metric Types
-~~~~~~~~~~~~
-
-- Gauge
-- Counter
-- StateSet
-- Info
-- Histogram
-- GaugeHistogram
-- Summary
-- Unknown
-
-Telemetry module in CSIT currently support only Gauge, Counter and Info.
-
-Example metric file
-~~~~~~~~~~~~~~~~~~~
-
-::
-
-  # HELP calls_total Number of calls total
-  # TYPE calls_total counter
-  calls_total{name="api-rx-from-ring",state="active",thread_id="0",thread_lcore="1",thread_name="vpp_main"} 0.0
-  calls_total{name="fib-walk",state="any wait",thread_id="0",thread_lcore="1",thread_name="vpp_main"} 0.0
-  calls_total{name="ip6-mld-process",state="any wait",thread_id="0",thread_lcore="1",thread_name="vpp_main"} 0.0
-  calls_total{name="ip6-ra-process",state="any wait",thread_id="0",thread_lcore="1",thread_name="vpp_main"} 0.0
-  calls_total{name="unix-epoll-input",state="polling",thread_id="0",thread_lcore="1",thread_name="vpp_main"} 39584.0
-  calls_total{name="avf-0/18/6/0-output",state="active",thread_id="1",thread_lcore="2",thread_name="vpp_wk_0"} 91.0
-  calls_total{name="avf-0/18/6/0-tx",state="active",thread_id="1",thread_lcore="2",thread_name="vpp_wk_0"} 91.0
-  calls_total{name="avf-input",state="polling",thread_id="1",thread_lcore="2",thread_name="vpp_wk_0"} 91.0
-  calls_total{name="ethernet-input",state="active",thread_id="1",thread_lcore="2",thread_name="vpp_wk_0"} 91.0
-  calls_total{name="ip4-input-no-checksum",state="active",thread_id="1",thread_lcore="2",thread_name="vpp_wk_0"} 91.0
-  calls_total{name="ip4-lookup",state="active",thread_id="1",thread_lcore="2",thread_name="vpp_wk_0"} 91.0
-  calls_total{name="ip4-rewrite",state="active",thread_id="1",thread_lcore="2",thread_name="vpp_wk_0"} 91.0
-  calls_total{name="avf-0/18/2/0-output",state="active",thread_id="2",thread_lcore="0",thread_name="vpp_wk_1"} 91.0
-  calls_total{name="avf-0/18/2/0-tx",state="active",thread_id="2",thread_lcore="0",thread_name="vpp_wk_1"} 91.0
-  calls_total{name="avf-input",state="polling",thread_id="2",thread_lcore="0",thread_name="vpp_wk_1"} 91.0
-  calls_total{name="ethernet-input",state="active",thread_id="2",thread_lcore="0",thread_name="vpp_wk_1"} 91.0
-  calls_total{name="ip4-input-no-checksum",state="active",thread_id="2",thread_lcore="0",thread_name="vpp_wk_1"} 91.0
-  calls_total{name="ip4-lookup",state="active",thread_id="2",thread_lcore="0",thread_name="vpp_wk_1"} 91.0
-  calls_total{name="ip4-rewrite",state="active",thread_id="2",thread_lcore="0",thread_name="vpp_wk_1"} 91.0
-  calls_total{name="unix-epoll-input",state="polling",thread_id="2",thread_lcore="0",thread_name="vpp_wk_1"} 1.0
-
-
-Anatomy of existing CSIT telemetry implementation
--------------------------------------------------
-
-Existing implementation consists of several measurment building blocks:
-the main measuring block running search algorithms (MLR, PLR, SOAK, MRR, ...),
-the latency measuring block and the several telemetry blocks with or without
-traffic running on a background.
-
-The main measuring block must not be interrupted by any read operation that can
-impact data plane traffic processing during throughput search algorithm. Thus
-operational reads are done before (pre-stat) and after (post-stat) that block.
-
-Some operational reads must be done while traffic is running and usually
-consists of two reads (pre-run-stat, post-run-stat) with defined delay between
-them.
-
-MRR measurement
-~~~~~~~~~~~~~~~
-
-::
-
-  traffic_start(r=mrr)               traffic_stop       |<     measure     >|
-    |                                  |                |      (r=mrr)      |
-    |   pre_run_stat   post_run_stat   |    pre_stat    |                   |  post_stat
-    |        |               |         |       |        |                   |      |
-  --o--------o---------------o---------o-------o--------+-------------------+------o------------>
-                                                                                              t
-
-  Legend:
-    - pre_run_stat
-      - vpp-clear-runtime
-    - post_run_stat
-      - vpp-show-runtime
-      - bash-perf-stat            // if extended_debug == True
-    - pre_stat
-      - vpp-clear-stats
-      - vpp-enable-packettrace    // if extended_debug == True
-      - vpp-enable-elog
-    - post_stat
-      - vpp-show-stats
-      - vpp-show-packettrace      // if extended_debug == True
-      - vpp-show-elog
-
-::
-
-    |<                                measure                                 >|
-    |                                 (r=mrr)                                  |
-    |                                                                          |
-    |<    traffic_trial0    >|<    traffic_trial1    >|<    traffic_trialN    >|
-    |    (i=0,t=duration)    |    (i=1,t=duration)    |    (i=N,t=duration)    |
-    |                        |                        |                        |
-  --o------------------------o------------------------o------------------------o--->
-                                                                                 t
-
-
-MLR measurement
-~~~~~~~~~~~~~~~
-
-::
-
-    |<     measure     >|   traffic_start(r=pdr)               traffic_stop   traffic_start(r=ndr)               traffic_stop  |< [    latency    ] >|
-    |      (r=mlr)      |    |                                  |              |                                  |            |     .9/.5/.1/.0     |
-    |                   |    |   pre_run_stat   post_run_stat   |              |   pre_run_stat   post_run_stat   |            |                     |
-    |                   |    |        |               |         |              |        |               |         |            |                     |
-  --+-------------------+----o--------o---------------o---------o--------------o--------o---------------o---------o------------[---------------------]--->
-                                                                                                                                                       t
-
-  Legend:
-    - pre_run_stat
-      - vpp-clear-runtime
-    - post_run_stat
-      - vpp-show-runtime
-      - bash-perf-stat          // if extended_debug == True
-    - pre_stat
-      - vpp-clear-stats
-      - vpp-enable-packettrace  // if extended_debug == True
-      - vpp-enable-elog
-    - post_stat
-      - vpp-show-stats
-      - vpp-show-packettrace    // if extended_debug == True
-      - vpp-show-elog
-
-
-Improving existing solution
----------------------------
-
-Improving existing CSIT telemetry implementaion including these areas.
-
-- telemetry optimization
-  - reducing ssh overhead
-  - removing stats without added value
-- telemetry scheduling
-  - improve accuracy
-  - improve configuration
-- telemetry output
-  - standardize output
-
-Exesting stats implementation was abstracted to having pre-/post-run-stats
-phases. Improvement will be done by merging pre-/post- logic implementation into
-separated stat-runtime block configurable and locally executed on SUT.
-
-This will increase precision, remove complexity and move implementation into
-spearated module.
-
-OpenMetric format for cloud native metric capturing will be used to ensure
-integration with post processing module.
-
-MRR measurement
-~~~~~~~~~~~~~~~
-
-::
-
-    traffic_start(r=mrr)               traffic_stop                 |<     measure     >|
-      |                                  |                          |      (r=mrr)      |
-      |   |<      stat_runtime      >|   |          stat_pre_trial  |                   |  stat_post_trial
-      |   |                          |   |             |            |                   |     |
-  ----o---+--------------------------+---o-------------o------------+-------------------+-----o------------->
-                                                                                                          t
-
-  Legend:
-    - stat_runtime
-      - vpp-runtime
-    - stat_pre_trial
-      - vpp-clear-stats
-      - vpp-enable-packettrace  // if extended_debug == True
-    - stat_post_trial
-      - vpp-show-stats
-      - vpp-show-packettrace    // if extended_debug == True
-
-
-::
-
-    |<                                measure                                 >|
-    |                                 (r=mrr)                                  |
-    |                                                                          |
-    |<    traffic_trial0    >|<    traffic_trial1    >|<    traffic_trialN    >|
-    |    (i=0,t=duration)    |    (i=1,t=duration)    |    (i=N,t=duration)    |
-    |                        |                        |                        |
-  --o------------------------o------------------------o------------------------o--->
-                                                                                 t
-
-::
-
-    |<                              stat_runtime                              >|
-    |                                                                          |
-    |<       program0       >|<       program1       >|<       programN       >|
-    |       (@=params)       |       (@=params)       |       (@=params)       |
-    |                        |                        |                        |
-  --o------------------------o------------------------o------------------------o--->
-                                                                                 t
-
-
-MLR measurement
-~~~~~~~~~~~~~~~
-
-::
-
-    |<     measure     >|   traffic_start(r=pdr)               traffic_stop   traffic_start(r=ndr)               traffic_stop  |< [    latency    ] >|
-    |      (r=mlr)      |     |                                  |              |                                  |           |     .9/.5/.1/.0     |
-    |                   |     |   |<      stat_runtime      >|   |              |   |<      stat_runtime      >|   |           |                     |
-    |                   |     |   |                          |   |              |   |                          |   |           |                     |
-  --+-------------------+-----o---+--------------------------+---o--------------o---+--------------------------+---o-----------[---------------------]--->
-                                                                                                                                                       t
-
-  Legend:
-    - stat_runtime
-      - vpp-runtime
-    - stat_pre_trial
-      - vpp-clear-stats
-      - vpp-enable-packettrace  // if extended_debug == True
-    - stat_post_trial
-      - vpp-show-stats
-      - vpp-show-packettrace    // if extended_debug == True