Code Review / csit.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
C-Docs: New structure
[csit.git] / docs / content / methodology / measurements / telemetry.md
diff --git a/docs/content/methodology/telemetry.md b/docs/content/methodology/measurements/telemetry.md
similarity index 55%
rename from docs/content/methodology/telemetry.md
rename to docs/content/methodology/measurements/telemetry.md
index e7a2571..aed32d9 100644 (file)
--- a/docs/content/methodology/telemetry.md
+++ b/docs/content/methodology/measurements/telemetry.md
@@ -1,6 +1,6 @@
 ---
 title: "Telemetry"
-weight: 20
+weight: 3
 ---
 
 # Telemetry
@@ -50,14 +50,13 @@ 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:
+    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
@@ -72,27 +71,25 @@ them.
       - 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--->
+    |<                               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:
+    |<  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
@@ -107,17 +104,15 @@ them.
       - vpp-show-packettrace    // if extended_debug == True
       - vpp-show-elog
 
-
 ## 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:
+    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
@@ -127,36 +122,32 @@ them.
       - 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
-
+    o------------------------o------------------------o------------------------o--->
+                                                                                  t
 
     |<                              stat_runtime                              >|
     |                                                                          |
     |<       program0       >|<       program1       >|<       programN       >|
     |       (@=params)       |       (@=params)       |       (@=params)       |
     |                        |                        |                        |
-  --o------------------------o------------------------o------------------------o--->
-                                                                                 t
-
+    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:
+    |<  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
Integration tests