81c2547a826ebcfff6574e3f4610e04c35abd046
[csit.git] / resources / tools / presentation / doc / pal_lld.rst
1 Presentation and Analytics Layer
2 ================================
3
4 Overview
5 --------
6
7 The presentation and analytics layer (PAL) is the fourth layer of CSIT
8 hierarchy. The model of presentation and analytics layer consists of four
9 sub-layers, bottom up:
10
11  - sL1 - Data - input data to be processed:
12
13    - Static content - .rst text files, .svg static figures, and other files
14      stored in the CSIT git repository.
15    - Data to process - .xml files generated by Jenkins jobs executing tests,
16      stored as robot results files (output.xml).
17    - Specification - .yaml file with the models of report elements (tables,
18      plots, layout, ...) generated by this tool. There is also the configuration
19      of the tool and the specification of input data (jobs and builds).
20
21  - sL2 - Data processing
22
23    - The data are read from the specified input files (.xml) and stored as
24      multi-indexed `pandas.Series <https://pandas.pydata.org/pandas-docs/stable/
25      generated/pandas.Series.html>`_.
26    - This layer provides also interface to input data and filtering of the input
27      data.
28
29  - sL3 - Data presentation - This layer generates the elements specified in the
30    specification file:
31
32    - Tables: .csv files linked to static .rst files.
33    - Plots: .html files generated using plot.ly linked to static .rst files.
34
35  - sL4 - Report generation - Sphinx generates required formats and versions:
36
37    - formats: html, pdf
38    - versions: minimal, full (TODO: define the names and scope of versions)
39
40 .. only:: latex
41
42     .. raw:: latex
43
44         \begin{figure}[H]
45         \centering
46             \includesvg[width=0.90\textwidth]{../_tmp/src/csit_framework_documentation/pal_layers}
47             \label{fig:pal_layers}
48         \end{figure}
49
50 .. only:: html
51
52     .. figure:: pal_layers.svg
53         :alt: PAL Layers
54         :align: center
55
56 Data
57 ----
58
59 Report Specification
60 ````````````````````
61
62 The report specification file defines which data is used and which outputs are
63 generated. It is human readable and structured. It is easy to add / remove /
64 change items. The specification includes:
65
66  - Specification of the environment.
67  - Configuration of debug mode (optional).
68  - Specification of input data (jobs, builds, files, ...).
69  - Specification of the output.
70  - What and how is generated:
71    - What: plots, tables.
72    - How: specification of all properties and parameters.
73  - .yaml format.
74
75 Structure of the specification file
76 '''''''''''''''''''''''''''''''''''
77
78 The specification file is organized as a list of dictionaries distinguished by
79 the type:
80
81 ::
82
83     -
84       type: "environment"
85     -
86       type: "configuration"
87     -
88       type: "debug"
89     -
90       type: "static"
91     -
92       type: "input"
93     -
94       type: "output"
95     -
96       type: "table"
97     -
98       type: "plot"
99     -
100       type: "file"
101
102 Each type represents a section. The sections "environment", "debug", "static",
103 "input" and "output" are listed only once in the specification; "table", "file"
104 and "plot" can be there multiple times.
105
106 Sections "debug", "table", "file" and "plot" are optional.
107
108 Table(s), files(s) and plot(s) are referred as "elements" in this text. It is
109 possible to define and implement other elements if needed.
110
111
112 Section: Environment
113 ''''''''''''''''''''
114
115 This section has the following parts:
116
117  - type: "environment" - says that this is the section "environment".
118  - configuration - configuration of the PAL.
119  - paths - paths used by the PAL.
120  - urls - urls pointing to the data sources.
121  - make-dirs - a list of the directories to be created by the PAL while
122    preparing the environment.
123  - remove-dirs - a list of the directories to be removed while cleaning the
124    environment.
125  - build-dirs - a list of the directories where the results are stored.
126
127 The structure of the section "Environment" is as follows (example):
128
129 ::
130
131     -
132       type: "environment"
133       configuration:
134         # Debug mode:
135         # - Skip:
136         #   - Download of input data files
137         # - Do:
138         #   - Read data from given zip / xml files
139         #   - Set the configuration as it is done in normal mode
140         # If the section "type: debug" is missing, CFG[DEBUG] is set to 0.
141         CFG[DEBUG]: 0
142
143       paths:
144         # Top level directories:
145         ## Working directory
146         DIR[WORKING]: "_tmp"
147         ## Build directories
148         DIR[BUILD,HTML]: "_build"
149         DIR[BUILD,LATEX]: "_build_latex"
150
151         # Static .rst files
152         DIR[RST]: "../../../docs/report"
153
154         # Working directories
155         ## Input data files (.zip, .xml)
156         DIR[WORKING,DATA]: "{DIR[WORKING]}/data"
157         ## Static source files from git
158         DIR[WORKING,SRC]: "{DIR[WORKING]}/src"
159         DIR[WORKING,SRC,STATIC]: "{DIR[WORKING,SRC]}/_static"
160
161         # Static html content
162         DIR[STATIC]: "{DIR[BUILD,HTML]}/_static"
163         DIR[STATIC,VPP]: "{DIR[STATIC]}/vpp"
164         DIR[STATIC,DPDK]: "{DIR[STATIC]}/dpdk"
165         DIR[STATIC,ARCH]: "{DIR[STATIC]}/archive"
166
167         # Detailed test results
168         DIR[DTR]: "{DIR[WORKING,SRC]}/detailed_test_results"
169         DIR[DTR,PERF,DPDK]: "{DIR[DTR]}/dpdk_performance_results"
170         DIR[DTR,PERF,VPP]: "{DIR[DTR]}/vpp_performance_results"
171         DIR[DTR,PERF,HC]: "{DIR[DTR]}/honeycomb_performance_results"
172         DIR[DTR,FUNC,VPP]: "{DIR[DTR]}/vpp_functional_results"
173         DIR[DTR,FUNC,HC]: "{DIR[DTR]}/honeycomb_functional_results"
174         DIR[DTR,FUNC,NSHSFC]: "{DIR[DTR]}/nshsfc_functional_results"
175         DIR[DTR,PERF,VPP,IMPRV]: "{DIR[WORKING,SRC]}/vpp_performance_tests/performance_improvements"
176
177         # Detailed test configurations
178         DIR[DTC]: "{DIR[WORKING,SRC]}/test_configuration"
179         DIR[DTC,PERF,VPP]: "{DIR[DTC]}/vpp_performance_configuration"
180         DIR[DTC,FUNC,VPP]: "{DIR[DTC]}/vpp_functional_configuration"
181
182         # Detailed tests operational data
183         DIR[DTO]: "{DIR[WORKING,SRC]}/test_operational_data"
184         DIR[DTO,PERF,VPP]: "{DIR[DTO]}/vpp_performance_operational_data"
185
186         # .css patch file to fix tables generated by Sphinx
187         DIR[CSS_PATCH_FILE]: "{DIR[STATIC]}/theme_overrides.css"
188         DIR[CSS_PATCH_FILE2]: "{DIR[WORKING,SRC,STATIC]}/theme_overrides.css"
189
190       urls:
191         URL[JENKINS,CSIT]: "https://jenkins.fd.io/view/csit/job"
192         URL[JENKINS,HC]: "https://jenkins.fd.io/view/hc2vpp/job"
193
194       make-dirs:
195       # List the directories which are created while preparing the environment.
196       # All directories MUST be defined in "paths" section.
197       - "DIR[WORKING,DATA]"
198       - "DIR[STATIC,VPP]"
199       - "DIR[STATIC,DPDK]"
200       - "DIR[STATIC,ARCH]"
201       - "DIR[BUILD,LATEX]"
202       - "DIR[WORKING,SRC]"
203       - "DIR[WORKING,SRC,STATIC]"
204
205       remove-dirs:
206       # List the directories which are deleted while cleaning the environment.
207       # All directories MUST be defined in "paths" section.
208       #- "DIR[BUILD,HTML]"
209
210       build-dirs:
211       # List the directories where the results (build) is stored.
212       # All directories MUST be defined in "paths" section.
213       - "DIR[BUILD,HTML]"
214       - "DIR[BUILD,LATEX]"
215
216 It is possible to use defined items in the definition of other items, e.g.:
217
218 ::
219
220     DIR[WORKING,DATA]: "{DIR[WORKING]}/data"
221
222 will be automatically changed to
223
224 ::
225
226     DIR[WORKING,DATA]: "_tmp/data"
227
228
229 Section: Configuration
230 ''''''''''''''''''''''
231
232 This section specifies the groups of parameters which are repeatedly used in the
233 elements defined later in the specification file. It has the following parts:
234
235  - data sets - Specification of data sets used later in element's specifications
236    to define the input data.
237  - plot layouts - Specification of plot layouts used later in plots'
238    specifications to define the plot layout.
239
240 The structure of the section "Configuration" is as follows (example):
241
242 ::
243
244     -
245       type: "configuration"
246       data-sets:
247         plot-vpp-throughput-latency:
248           csit-vpp-perf-1710-all:
249           - 11
250           - 12
251           - 13
252           - 14
253           - 15
254           - 16
255           - 17
256           - 18
257           - 19
258           - 20
259         vpp-perf-results:
260           csit-vpp-perf-1710-all:
261           - 20
262           - 23
263       plot-layouts:
264         plot-throughput:
265           xaxis:
266             autorange: True
267             autotick: False
268             fixedrange: False
269             gridcolor: "rgb(238, 238, 238)"
270             linecolor: "rgb(238, 238, 238)"
271             linewidth: 1
272             showgrid: True
273             showline: True
274             showticklabels: True
275             tickcolor: "rgb(238, 238, 238)"
276             tickmode: "linear"
277             title: "Indexed Test Cases"
278             zeroline: False
279           yaxis:
280             gridcolor: "rgb(238, 238, 238)'"
281             hoverformat: ".4s"
282             linecolor: "rgb(238, 238, 238)"
283             linewidth: 1
284             range: []
285             showgrid: True
286             showline: True
287             showticklabels: True
288             tickcolor: "rgb(238, 238, 238)"
289             title: "Packets Per Second [pps]"
290             zeroline: False
291           boxmode: "group"
292           boxgroupgap: 0.5
293           autosize: False
294           margin:
295             t: 50
296             b: 20
297             l: 50
298             r: 20
299           showlegend: True
300           legend:
301             orientation: "h"
302           width: 700
303           height: 1000
304
305 The definitions from this sections are used in the elements, e.g.:
306
307 ::
308
309     -
310       type: "plot"
311       title: "VPP Performance 64B-1t1c-(eth|dot1q|dot1ad)-(l2xcbase|l2bdbasemaclrn)-ndrdisc"
312       algorithm: "plot_performance_box"
313       output-file-type: ".html"
314       output-file: "{DIR[STATIC,VPP]}/64B-1t1c-l2-sel1-ndrdisc"
315       data:
316         "plot-vpp-throughput-latency"
317       filter: "'64B' and ('BASE' or 'SCALE') and 'NDRDISC' and '1T1C' and ('L2BDMACSTAT' or 'L2BDMACLRN' or 'L2XCFWD') and not 'VHOST'"
318       parameters:
319       - "throughput"
320       - "parent"
321       traces:
322         hoverinfo: "x+y"
323         boxpoints: "outliers"
324         whiskerwidth: 0
325       layout:
326         title: "64B-1t1c-(eth|dot1q|dot1ad)-(l2xcbase|l2bdbasemaclrn)-ndrdisc"
327         layout:
328           "plot-throughput"
329
330
331 Section: Debug mode
332 '''''''''''''''''''
333
334 This section is optional as it configures the debug mode. It is used if one
335 does not want to download input data files and use local files instead.
336
337 If the debug mode is configured, the "input" section is ignored.
338
339 This section has the following parts:
340
341  - type: "debug" - says that this is the section "debug".
342  - general:
343
344    - input-format - xml or zip.
345    - extract - if "zip" is defined as the input format, this file is extracted
346      from the zip file, otherwise this parameter is ignored.
347
348  - builds - list of builds from which the data is used. Must include a job
349    name as a key and then a list of builds and their output files.
350
351 The structure of the section "Debug" is as follows (example):
352
353 ::
354
355     -
356       type: "debug"
357       general:
358         input-format: "zip"  # zip or xml
359         extract: "robot-plugin/output.xml"  # Only for zip
360       builds:
361         # The files must be in the directory DIR[WORKING,DATA]
362         csit-dpdk-perf-1707-all:
363         -
364           build: 10
365           file: "csit-dpdk-perf-1707-all__10.xml"
366         -
367           build: 9
368           file: "csit-dpdk-perf-1707-all__9.xml"
369         csit-nsh_sfc-verify-func-1707-ubuntu1604-virl:
370         -
371           build: 2
372           file: "csit-nsh_sfc-verify-func-1707-ubuntu1604-virl-2.xml"
373         csit-vpp-functional-1707-ubuntu1604-virl:
374         -
375           build: lastSuccessfulBuild
376           file: "csit-vpp-functional-1707-ubuntu1604-virl-lastSuccessfulBuild.xml"
377         hc2vpp-csit-integration-1707-ubuntu1604:
378         -
379           build: lastSuccessfulBuild
380           file: "hc2vpp-csit-integration-1707-ubuntu1604-lastSuccessfulBuild.xml"
381         csit-vpp-perf-1707-all:
382         -
383           build: 16
384           file: "csit-vpp-perf-1707-all__16__output.xml"
385         -
386           build: 17
387           file: "csit-vpp-perf-1707-all__17__output.xml"
388
389
390 Section: Static
391 '''''''''''''''
392
393 This section defines the static content which is stored in git and will be used
394 as a source to generate the report.
395
396 This section has these parts:
397
398  - type: "static" - says that this section is the "static".
399  - src-path - path to the static content.
400  - dst-path - destination path where the static content is copied and then
401    processed.
402
403 ::
404     -
405       type: "static"
406       src-path: "{DIR[RST]}"
407       dst-path: "{DIR[WORKING,SRC]}"
408
409
410 Section: Input
411 ''''''''''''''
412
413 This section defines the data used to generate elements. It is mandatory
414 if the debug mode is not used.
415
416 This section has the following parts:
417
418  - type: "input" - says that this section is the "input".
419  - general - parameters common to all builds:
420
421    - file-name: file to be downloaded.
422    - file-format: format of the downloaded file, ".zip" or ".xml" are supported.
423    - download-path: path to be added to url pointing to the file, e.g.:
424      "{job}/{build}/robot/report/*zip*/{filename}"; {job}, {build} and
425      {filename} are replaced by proper values defined in this section.
426    - extract: file to be extracted from downloaded zip file, e.g.: "output.xml";
427      if xml file is downloaded, this parameter is ignored.
428
429  - builds - list of jobs (keys) and numbers of builds which output data will be
430    downloaded.
431
432 The structure of the section "Input" is as follows (example from 17.07 report):
433
434 ::
435
436     -
437       type: "input"  # Ignored in debug mode
438       general:
439         file-name: "robot-plugin.zip"
440         file-format: ".zip"
441         download-path: "{job}/{build}/robot/report/*zip*/{filename}"
442         extract: "robot-plugin/output.xml"
443       builds:
444         csit-vpp-perf-1707-all:
445         - 9
446         - 10
447         - 13
448         - 14
449         - 15
450         - 16
451         - 17
452         - 18
453         - 19
454         - 21
455         - 22
456         csit-dpdk-perf-1707-all:
457         - 1
458         - 2
459         - 3
460         - 4
461         - 5
462         - 6
463         - 7
464         - 8
465         - 9
466         - 10
467         csit-vpp-functional-1707-ubuntu1604-virl:
468         - lastSuccessfulBuild
469         hc2vpp-csit-perf-master-ubuntu1604:
470         - 8
471         - 9
472         hc2vpp-csit-integration-1707-ubuntu1604:
473         - lastSuccessfulBuild
474         csit-nsh_sfc-verify-func-1707-ubuntu1604-virl:
475         - 2
476
477
478 Section: Output
479 '''''''''''''''
480
481 This section specifies which format(s) will be generated (html, pdf) and which
482 versions will be generated for each format.
483
484 This section has the following parts:
485
486  - type: "output" - says that this section is the "output".
487  - format: html or pdf.
488  - version: defined for each format separately.
489
490 The structure of the section "Output" is as follows (example):
491
492 ::
493
494     -
495       type: "output"
496       format:
497         html:
498         - full
499         pdf:
500         - full
501         - minimal
502
503 TODO: define the names of versions
504
505
506 Content of "minimal" version
507 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
508
509 TODO: define the name and content of this version
510
511
512 Section: Table
513 ''''''''''''''
514
515 This section defines a table to be generated. There can be 0 or more "table"
516 sections.
517
518 This section has the following parts:
519
520  - type: "table" - says that this section defines a table.
521  - title: Title of the table.
522  - algorithm: Algorithm which is used to generate the table. The other
523    parameters in this section must provide all information needed by the used
524    algorithm.
525  - template: (optional) a .csv file used as a template while generating the
526    table.
527  - output-file-ext: extension of the output file.
528  - output-file: file which the table will be written to.
529  - columns: specification of table columns:
530
531    - title: The title used in the table header.
532    - data: Specification of the data, it has two parts - command and arguments:
533
534      - command:
535
536        - template - take the data from template, arguments:
537
538          - number of column in the template.
539
540        - data - take the data from the input data, arguments:
541
542          - jobs and builds which data will be used.
543
544        - operation - performs an operation with the data already in the table,
545          arguments:
546
547          - operation to be done, e.g.: mean, stdev, relative_change (compute
548            the relative change between two columns) and display number of data
549            samples ~= number of test jobs. The operations are implemented in the
550            utils.py
551            TODO: Move from utils,py to e.g. operations.py
552          - numbers of columns which data will be used (optional).
553
554  - data: Specify the jobs and builds which data is used to generate the table.
555  - filter: filter based on tags applied on the input data, if "template" is
556    used, filtering is based on the template.
557  - parameters: Only these parameters will be put to the output data structure.
558
559 The structure of the section "Table" is as follows (example of
560 "table_performance_improvements"):
561
562 ::
563
564     -
565       type: "table"
566       title: "Performance improvements"
567       algorithm: "table_performance_improvements"
568       template: "{DIR[DTR,PERF,VPP,IMPRV]}/tmpl_performance_improvements.csv"
569       output-file-ext: ".csv"
570       output-file: "{DIR[DTR,PERF,VPP,IMPRV]}/performance_improvements"
571       columns:
572       -
573         title: "VPP Functionality"
574         data: "template 1"
575       -
576         title: "Test Name"
577         data: "template 2"
578       -
579         title: "VPP-16.09 mean [Mpps]"
580         data: "template 3"
581       -
582         title: "VPP-17.01 mean [Mpps]"
583         data: "template 4"
584       -
585         title: "VPP-17.04 mean [Mpps]"
586         data: "template 5"
587       -
588         title: "VPP-17.07 mean [Mpps]"
589         data: "data csit-vpp-perf-1707-all mean"
590       -
591         title: "VPP-17.07 stdev [Mpps]"
592         data: "data csit-vpp-perf-1707-all stdev"
593       -
594         title: "17.04 to 17.07 change [%]"
595         data: "operation relative_change 5 4"
596       data:
597         csit-vpp-perf-1707-all:
598         - 9
599         - 10
600         - 13
601         - 14
602         - 15
603         - 16
604         - 17
605         - 18
606         - 19
607         - 21
608       filter: "template"
609       parameters:
610       - "throughput"
611
612 Example of "table_details" which generates "Detailed Test Results - VPP
613 Performance Results":
614
615 ::
616
617     -
618       type: "table"
619       title: "Detailed Test Results - VPP Performance Results"
620       algorithm: "table_details"
621       output-file-ext: ".csv"
622       output-file: "{DIR[WORKING]}/vpp_performance_results"
623       columns:
624       -
625         title: "Name"
626         data: "data test_name"
627       -
628         title: "Documentation"
629         data: "data test_documentation"
630       -
631         title: "Status"
632         data: "data test_msg"
633       data:
634         csit-vpp-perf-1707-all:
635         - 17
636       filter: "all"
637       parameters:
638       - "parent"
639       - "doc"
640       - "msg"
641
642 Example of "table_details" which generates "Test configuration - VPP Performance
643 Test Configs":
644
645 ::
646
647     -
648       type: "table"
649       title: "Test configuration - VPP Performance Test Configs"
650       algorithm: "table_details"
651       output-file-ext: ".csv"
652       output-file: "{DIR[WORKING]}/vpp_test_configuration"
653       columns:
654       -
655         title: "Name"
656         data: "data name"
657       -
658         title: "VPP API Test (VAT) Commands History - Commands Used Per Test Case"
659         data: "data show-run"
660       data:
661         csit-vpp-perf-1707-all:
662         - 17
663       filter: "all"
664       parameters:
665       - "parent"
666       - "name"
667       - "show-run"
668
669
670 Section: Plot
671 '''''''''''''
672
673 This section defines a plot to be generated. There can be 0 or more "plot"
674 sections.
675
676 This section has these parts:
677
678  - type: "plot" - says that this section defines a plot.
679  - title: Plot title used in the logs. Title which is displayed is in the
680    section "layout".
681  - output-file-type: format of the output file.
682  - output-file: file which the plot will be written to.
683  - algorithm: Algorithm used to generate the plot. The other parameters in this
684    section must provide all information needed by plot.ly to generate the plot.
685    For example:
686
687    - traces
688    - layout
689
690    - These parameters are transparently passed to plot.ly.
691
692  - data: Specify the jobs and numbers of builds which data is used to generate
693    the plot.
694  - filter: filter applied on the input data.
695  - parameters: Only these parameters will be put to the output data structure.
696
697 The structure of the section "Plot" is as follows (example of a plot showing
698 throughput in a chart box-with-whiskers):
699
700 ::
701
702     -
703       type: "plot"
704       title: "VPP Performance 64B-1t1c-(eth|dot1q|dot1ad)-(l2xcbase|l2bdbasemaclrn)-ndrdisc"
705       algorithm: "plot_performance_box"
706       output-file-type: ".html"
707       output-file: "{DIR[STATIC,VPP]}/64B-1t1c-l2-sel1-ndrdisc"
708       data:
709         csit-vpp-perf-1707-all:
710         - 9
711         - 10
712         - 13
713         - 14
714         - 15
715         - 16
716         - 17
717         - 18
718         - 19
719         - 21
720       # Keep this formatting, the filter is enclosed with " (quotation mark) and
721       # each tag is enclosed with ' (apostrophe).
722       filter: "'64B' and 'BASE' and 'NDRDISC' and '1T1C' and ('L2BDMACSTAT' or 'L2BDMACLRN' or 'L2XCFWD') and not 'VHOST'"
723       parameters:
724       - "throughput"
725       - "parent"
726       traces:
727         hoverinfo: "x+y"
728         boxpoints: "outliers"
729         whiskerwidth: 0
730       layout:
731         title: "64B-1t1c-(eth|dot1q|dot1ad)-(l2xcbase|l2bdbasemaclrn)-ndrdisc"
732         xaxis:
733           autorange: True
734           autotick: False
735           fixedrange: False
736           gridcolor: "rgb(238, 238, 238)"
737           linecolor: "rgb(238, 238, 238)"
738           linewidth: 1
739           showgrid: True
740           showline: True
741           showticklabels: True
742           tickcolor: "rgb(238, 238, 238)"
743           tickmode: "linear"
744           title: "Indexed Test Cases"
745           zeroline: False
746         yaxis:
747           gridcolor: "rgb(238, 238, 238)'"
748           hoverformat: ".4s"
749           linecolor: "rgb(238, 238, 238)"
750           linewidth: 1
751           range: []
752           showgrid: True
753           showline: True
754           showticklabels: True
755           tickcolor: "rgb(238, 238, 238)"
756           title: "Packets Per Second [pps]"
757           zeroline: False
758         boxmode: "group"
759         boxgroupgap: 0.5
760         autosize: False
761         margin:
762           t: 50
763           b: 20
764           l: 50
765           r: 20
766         showlegend: True
767         legend:
768           orientation: "h"
769         width: 700
770         height: 1000
771
772 The structure of the section "Plot" is as follows (example of a plot showing
773 latency in a box chart):
774
775 ::
776
777     -
778       type: "plot"
779       title: "VPP Latency 64B-1t1c-(eth|dot1q|dot1ad)-(l2xcbase|l2bdbasemaclrn)-ndrdisc"
780       algorithm: "plot_latency_box"
781       output-file-type: ".html"
782       output-file: "{DIR[STATIC,VPP]}/64B-1t1c-l2-sel1-ndrdisc-lat50"
783       data:
784         csit-vpp-perf-1707-all:
785         - 9
786         - 10
787         - 13
788         - 14
789         - 15
790         - 16
791         - 17
792         - 18
793         - 19
794         - 21
795       filter: "'64B' and 'BASE' and 'NDRDISC' and '1T1C' and ('L2BDMACSTAT' or 'L2BDMACLRN' or 'L2XCFWD') and not 'VHOST'"
796       parameters:
797       - "latency"
798       - "parent"
799       traces:
800         boxmean: False
801       layout:
802         title: "64B-1t1c-(eth|dot1q|dot1ad)-(l2xcbase|l2bdbasemaclrn)-ndrdisc"
803         xaxis:
804           autorange: True
805           autotick: False
806           fixedrange: False
807           gridcolor: "rgb(238, 238, 238)"
808           linecolor: "rgb(238, 238, 238)"
809           linewidth: 1
810           showgrid: True
811           showline: True
812           showticklabels: True
813           tickcolor: "rgb(238, 238, 238)"
814           tickmode: "linear"
815           title: "Indexed Test Cases"
816           zeroline: False
817         yaxis:
818           gridcolor: "rgb(238, 238, 238)'"
819           hoverformat: ""
820           linecolor: "rgb(238, 238, 238)"
821           linewidth: 1
822           range: []
823           showgrid: True
824           showline: True
825           showticklabels: True
826           tickcolor: "rgb(238, 238, 238)"
827           title: "Latency min/avg/max [uSec]"
828           zeroline: False
829         boxmode: "group"
830         boxgroupgap: 0.5
831         autosize: False
832         margin:
833           t: 50
834           b: 20
835           l: 50
836           r: 20
837         showlegend: True
838         legend:
839           orientation: "h"
840         width: 700
841         height: 1000
842
843 The structure of the section "Plot" is as follows (example of a plot showing
844 VPP HTTP server performance in a box chart with pre-defined data
845 "plot-vpp-httlp-server-performance" set and  plot layout "plot-cps"):
846
847 ::
848
849     -
850       type: "plot"
851       title: "VPP HTTP Server Performance"
852       algorithm: "plot_http_server_performance_box"
853       output-file-type: ".html"
854       output-file: "{DIR[STATIC,VPP]}/http-server-performance-cps"
855       data:
856         "plot-vpp-httlp-server-performance"
857       # Keep this formatting, the filter is enclosed with " (quotation mark) and
858       # each tag is enclosed with ' (apostrophe).
859       filter: "'HTTP' and 'TCP_CPS'"
860       parameters:
861       - "result"
862       - "name"
863       traces:
864         hoverinfo: "x+y"
865         boxpoints: "outliers"
866         whiskerwidth: 0
867       layout:
868         title: "VPP HTTP Server Performance"
869         layout:
870           "plot-cps"
871
872
873 Section: file
874 '''''''''''''
875
876 This section defines a file to be generated. There can be 0 or more "file"
877 sections.
878
879 This section has the following parts:
880
881  - type: "file" - says that this section defines a file.
882  - title: Title of the table.
883  - algorithm: Algorithm which is used to generate the file. The other
884    parameters in this section must provide all information needed by the used
885    algorithm.
886  - output-file-ext: extension of the output file.
887  - output-file: file which the file will be written to.
888  - file-header: The header of the generated .rst file.
889  - dir-tables: The directory with the tables.
890  - data: Specify the jobs and builds which data is used to generate the table.
891  - filter: filter based on tags applied on the input data, if "all" is
892    used, no filtering is done.
893  - parameters: Only these parameters will be put to the output data structure.
894  - chapters: the hierarchy of chapters in the generated file.
895  - start-level: the level of the the top-level chapter.
896
897 The structure of the section "file" is as follows (example):
898
899 ::
900
901     -
902       type: "file"
903       title: "VPP Performance Results"
904       algorithm: "file_test_results"
905       output-file-ext: ".rst"
906       output-file: "{DIR[DTR,PERF,VPP]}/vpp_performance_results"
907       file-header: "\n.. |br| raw:: html\n\n    <br />\n\n\n.. |prein| raw:: html\n\n    <pre>\n\n\n.. |preout| raw:: html\n\n    </pre>\n\n"
908       dir-tables: "{DIR[DTR,PERF,VPP]}"
909       data:
910         csit-vpp-perf-1707-all:
911         - 22
912       filter: "all"
913       parameters:
914       - "name"
915       - "doc"
916       - "level"
917       data-start-level: 2  # 0, 1, 2, ...
918       chapters-start-level: 2  # 0, 1, 2, ...
919
920
921 Static content
922 ``````````````
923
924  - Manually created / edited files.
925  - .rst files, static .csv files, static pictures (.svg), ...
926  - Stored in CSIT git repository.
927
928 No more details about the static content in this document.
929
930
931 Data to process
932 ```````````````
933
934 The PAL processes tests results and other information produced by Jenkins jobs.
935 The data are now stored as robot results in Jenkins (TODO: store the data in
936 nexus) either as .zip and / or .xml files.
937
938
939 Data processing
940 ---------------
941
942 As the first step, the data are downloaded and stored locally (typically on a
943 Jenkins slave). If .zip files are used, the given .xml files are extracted for
944 further processing.
945
946 Parsing of the .xml files is performed by a class derived from
947 "robot.api.ResultVisitor", only necessary methods are overridden. All and only
948 necessary data is extracted from .xml file and stored in a structured form.
949
950 The parsed data are stored as the multi-indexed pandas.Series data type. Its
951 structure is as follows:
952
953 ::
954
955     <job name>
956       <build>
957         <metadata>
958         <suites>
959         <tests>
960
961 "job name", "build", "metadata", "suites", "tests" are indexes to access the
962 data. For example:
963
964 ::
965
966     data =
967
968     job 1 name:
969       build 1:
970         metadata: metadata
971         suites: suites
972         tests: tests
973       ...
974       build N:
975         metadata: metadata
976         suites: suites
977         tests: tests
978     ...
979     job M name:
980       build 1:
981         metadata: metadata
982         suites: suites
983         tests: tests
984       ...
985       build N:
986         metadata: metadata
987         suites: suites
988         tests: tests
989
990 Using indexes data["job 1 name"]["build 1"]["tests"] (e.g.:
991 data["csit-vpp-perf-1704-all"]["17"]["tests"]) we get a list of all tests with
992 all tests data.
993
994 Data will not be accessible directly using indexes, but using getters and
995 filters.
996
997 **Structure of metadata:**
998
999 ::
1000
1001     "metadata": {
1002         "version": "VPP version",
1003         "job": "Jenkins job name"
1004         "build": "Information about the build"
1005     },
1006
1007 **Structure of suites:**
1008
1009 ::
1010
1011     "suites": {
1012         "Suite name 1": {
1013             "doc": "Suite 1 documentation"
1014             "parent": "Suite 1 parent"
1015         }
1016         "Suite name N": {
1017             "doc": "Suite N documentation"
1018             "parent": "Suite N parent"
1019         }
1020
1021 **Structure of tests:**
1022
1023 Performance tests:
1024
1025 ::
1026
1027     "tests": {
1028         "ID": {
1029             "name": "Test name",
1030             "parent": "Name of the parent of the test",
1031             "doc": "Test documentation"
1032             "msg": "Test message"
1033             "tags": ["tag 1", "tag 2", "tag n"],
1034             "type": "PDR" | "NDR",
1035             "throughput": {
1036                 "value": int,
1037                 "unit": "pps" | "bps" | "percentage"
1038             },
1039             "latency": {
1040                 "direction1": {
1041                     "100": {
1042                         "min": int,
1043                         "avg": int,
1044                         "max": int
1045                     },
1046                     "50": {  # Only for NDR
1047                         "min": int,
1048                         "avg": int,
1049                         "max": int
1050                     },
1051                     "10": {  # Only for NDR
1052                         "min": int,
1053                         "avg": int,
1054                         "max": int
1055                     }
1056                 },
1057                 "direction2": {
1058                     "100": {
1059                         "min": int,
1060                         "avg": int,
1061                         "max": int
1062                     },
1063                     "50": {  # Only for NDR
1064                         "min": int,
1065                         "avg": int,
1066                         "max": int
1067                     },
1068                     "10": {  # Only for NDR
1069                         "min": int,
1070                         "avg": int,
1071                         "max": int
1072                     }
1073                 }
1074             },
1075             "lossTolerance": "lossTolerance"  # Only for PDR
1076             "vat-history": "DUT1 and DUT2 VAT History"
1077             },
1078             "show-run": "Show Run"
1079         },
1080         "ID" {
1081             # next test
1082         }
1083
1084 Functional tests:
1085
1086 ::
1087
1088     "tests": {
1089         "ID": {
1090             "name": "Test name",
1091             "parent": "Name of the parent of the test",
1092             "doc": "Test documentation"
1093             "msg": "Test message"
1094             "tags": ["tag 1", "tag 2", "tag n"],
1095             "vat-history": "DUT1 and DUT2 VAT History"
1096             "show-run": "Show Run"
1097             "status": "PASS" | "FAIL"
1098         },
1099         "ID" {
1100             # next test
1101         }
1102     }
1103
1104 Note: ID is the lowercase full path to the test.
1105
1106
1107 Data filtering
1108 ``````````````
1109
1110 The first step when generating an element is getting the data needed to
1111 construct the element. The data are filtered from the processed input data.
1112
1113 The data filtering is based on:
1114
1115  - job name(s).
1116  - build number(s).
1117  - tag(s).
1118  - required data - only this data is included in the output.
1119
1120 WARNING: The filtering is based on tags, so be careful with tagging.
1121
1122 For example, the element which specification includes:
1123
1124 ::
1125
1126     data:
1127       csit-vpp-perf-1707-all:
1128       - 9
1129       - 10
1130       - 13
1131       - 14
1132       - 15
1133       - 16
1134       - 17
1135       - 18
1136       - 19
1137       - 21
1138     filter:
1139       - "'64B' and 'BASE' and 'NDRDISC' and '1T1C' and ('L2BDMACSTAT' or 'L2BDMACLRN' or 'L2XCFWD') and not 'VHOST'"
1140
1141 will be constructed using data from the job "csit-vpp-perf-1707-all", for all
1142 listed builds and the tests with the list of tags matching the filter
1143 conditions.
1144
1145 The output data structure for filtered test data is:
1146
1147 ::
1148
1149     - job 1
1150       - build 1
1151         - test 1
1152           - parameter 1
1153           - parameter 2
1154           ...
1155           - parameter n
1156         ...
1157         - test n
1158         ...
1159       ...
1160       - build n
1161     ...
1162     - job n
1163
1164
1165 Data analytics
1166 ``````````````
1167
1168 Data analytics part implements:
1169
1170  - methods to compute statistical data from the filtered input data.
1171  - trending.
1172
1173 Throughput Speedup Analysis - Multi-Core with Multi-Threading
1174 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1175
1176 Throughput Speedup Analysis (TSA) calculates throughput speedup ratios
1177 for tested 1-, 2- and 4-core multi-threaded VPP configurations using the
1178 following formula:
1179
1180 ::
1181
1182                                 N_core_throughput
1183     N_core_throughput_speedup = -----------------
1184                                 1_core_throughput
1185
1186 Multi-core throughput speedup ratios are plotted in grouped bar graphs
1187 for throughput tests with 64B/78B frame size, with number of cores on
1188 X-axis and speedup ratio on Y-axis.
1189
1190 For better comparison multiple test results' data sets are plotted per
1191 each graph:
1192
1193     - graph type: grouped bars;
1194     - graph X-axis: (testcase index, number of cores);
1195     - graph Y-axis: speedup factor.
1196
1197 Subset of existing performance tests is covered by TSA graphs.
1198
1199 **Model for TSA:**
1200
1201 ::
1202
1203     -
1204       type: "plot"
1205       title: "TSA: 64B-*-(eth|dot1q|dot1ad)-(l2xcbase|l2bdbasemaclrn)-ndrdisc"
1206       algorithm: "plot_throughput_speedup_analysis"
1207       output-file-type: ".html"
1208       output-file: "{DIR[STATIC,VPP]}/10ge2p1x520-64B-l2-tsa-ndrdisc"
1209       data:
1210         "plot-throughput-speedup-analysis"
1211       filter: "'NIC_Intel-X520-DA2' and '64B' and 'BASE' and 'NDRDISC' and ('L2BDMACSTAT' or 'L2BDMACLRN' or 'L2XCFWD') and not 'VHOST'"
1212       parameters:
1213       - "throughput"
1214       - "parent"
1215       - "tags"
1216       layout:
1217         title: "64B-*-(eth|dot1q|dot1ad)-(l2xcbase|l2bdbasemaclrn)-ndrdisc"
1218         layout:
1219           "plot-throughput-speedup-analysis"
1220
1221
1222 Comparison of results from two sets of the same test executions
1223 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1224
1225 This algorithm enables comparison of results coming from two sets of the
1226 same test executions. It is used to quantify performance changes across
1227 all tests after test environment changes e.g. Operating System
1228 upgrades/patches, Hardware changes.
1229
1230 It is assumed that each set of test executions includes multiple runs
1231 of the same tests, 10 or more, to verify test results repeatibility and
1232 to yield statistically meaningful results data.
1233
1234 Comparison results are presented in a table with a specified number of
1235 the best and the worst relative changes between the two sets. Following table
1236 columns are defined:
1237
1238     - name of the test;
1239     - throughput mean values of the reference set;
1240     - throughput standard deviation  of the reference set;
1241     - throughput mean values of the set to compare;
1242     - throughput standard deviation  of the set to compare;
1243     - relative change of the mean values.
1244
1245 **The model**
1246
1247 The model specifies:
1248
1249     - type: "table" - means this section defines a table.
1250     - title: Title of the table.
1251     - algorithm: Algorithm which is used to generate the table. The other
1252       parameters in this section must provide all information needed by the used
1253       algorithm.
1254     - output-file-ext: Extension of the output file.
1255     - output-file: File which the table will be written to.
1256     - reference - the builds which are used as the reference for comparison.
1257     - compare - the builds which are compared to the reference.
1258     - data: Specify the sources, jobs and builds, providing data for generating
1259       the table.
1260     - filter: Filter based on tags applied on the input data, if "template" is
1261       used, filtering is based on the template.
1262     - parameters: Only these parameters will be put to the output data
1263       structure.
1264     - nr-of-tests-shown: Number of the best and the worst tests presented in the
1265       table. Use 0 (zero) to present all tests.
1266
1267 *Example:*
1268
1269 ::
1270
1271     -
1272       type: "table"
1273       title: "Performance comparison"
1274       algorithm: "table_performance_comparison"
1275       output-file-ext: ".csv"
1276       output-file: "{DIR[DTR,PERF,VPP,IMPRV]}/vpp_performance_comparison"
1277       reference:
1278         title: "csit-vpp-perf-1801-all - 1"
1279         data:
1280           csit-vpp-perf-1801-all:
1281           - 1
1282           - 2
1283       compare:
1284         title: "csit-vpp-perf-1801-all - 2"
1285         data:
1286           csit-vpp-perf-1801-all:
1287           - 1
1288           - 2
1289       data:
1290         "vpp-perf-comparison"
1291       filter: "all"
1292       parameters:
1293       - "name"
1294       - "parent"
1295       - "throughput"
1296       nr-of-tests-shown: 20
1297
1298
1299 Advanced data analytics
1300 ```````````````````````
1301
1302 In the future advanced data analytics (ADA) will be added to analyze the
1303 telemetry data collected from SUT telemetry sources and correlate it to
1304 performance test results.
1305
1306 :TODO:
1307
1308     - describe the concept of ADA.
1309     - add specification.
1310
1311
1312 Data presentation
1313 -----------------
1314
1315 Generates the plots and tables according to the report models per
1316 specification file. The elements are generated using algorithms and data
1317 specified in their models.
1318
1319
1320 Tables
1321 ``````
1322
1323  - tables are generated by algorithms implemented in PAL, the model includes the
1324    algorithm and all necessary information.
1325  - output format: csv
1326  - generated tables are stored in specified directories and linked to .rst
1327    files.
1328
1329
1330 Plots
1331 `````
1332
1333  - `plot.ly <https://plot.ly/>`_ is currently used to generate plots, the model
1334    includes the type of plot and all the necessary information to render it.
1335  - output format: html.
1336  - generated plots are stored in specified directories and linked to .rst files.
1337
1338
1339 Report generation
1340 -----------------
1341
1342 Report is generated using Sphinx and Read_the_Docs template. PAL generates html
1343 and pdf formats. It is possible to define the content of the report by
1344 specifying the version (TODO: define the names and content of versions).
1345
1346
1347 The process
1348 ```````````
1349
1350 1. Read the specification.
1351 2. Read the input data.
1352 3. Process the input data.
1353 4. For element (plot, table, file) defined in specification:
1354
1355    a. Get the data needed to construct the element using a filter.
1356    b. Generate the element.
1357    c. Store the element.
1358
1359 5. Generate the report.
1360 6. Store the report (Nexus).
1361
1362 The process is model driven. The elements' models (tables, plots, files
1363 and report itself) are defined in the specification file. Script reads
1364 the elements' models from specification file and generates the elements.
1365
1366 It is easy to add elements to be generated in the report. If a new type
1367 of an element is required, only a new algorithm needs to be implemented
1368 and integrated.
1369
1370
1371 Continuous Performance Measurements and Trending
1372 ------------------------------------------------
1373
1374 Performance analysis and trending execution sequence:
1375 `````````````````````````````````````````````````````
1376
1377 CSIT PA runs performance analysis, change detection and trending using specified
1378 trend analysis metrics over the rolling window of last <N> sets of historical
1379 measurement data. PA is defined as follows:
1380
1381     #. PA job triggers:
1382
1383         #. By PT job at its completion.
1384         #. Manually from Jenkins UI.
1385
1386     #. Download and parse archived historical data and the new data:
1387
1388         #. New data from latest PT job is evaluated against the rolling window
1389            of <N> sets of historical data.
1390         #. Download RF output.xml files and compressed archived data.
1391         #. Parse out the data filtering test cases listed in PA specification
1392            (part of CSIT PAL specification file).
1393
1394     #. Calculate trend metrics for the rolling window of <N> sets of historical data:
1395
1396         #. Calculate quartiles Q1, Q2, Q3.
1397         #. Trim outliers using IQR.
1398         #. Calculate TMA and TMSD.
1399         #. Calculate normal trending range per test case based on TMA and TMSD.
1400
1401     #. Evaluate new test data against trend metrics:
1402
1403         #. If within the range of (TMA +/- 3*TMSD) => Result = Pass,
1404            Reason = Normal.
1405         #. If below the range => Result = Fail, Reason = Regression.
1406         #. If above the range => Result = Pass, Reason = Progression.
1407
1408     #. Generate and publish results
1409
1410         #. Relay evaluation result to job result.
1411         #. Generate a new set of trend analysis summary graphs and drill-down
1412            graphs.
1413
1414             #. Summary graphs to include measured values with Normal,
1415                Progression and Regression markers. MM shown in the background if
1416                possible.
1417             #. Drill-down graphs to include MM, TMA and TMSD.
1418
1419         #. Publish trend analysis graphs in html format on
1420            https://docs.fd.io/csit/master/trending/.
1421
1422
1423 Parameters to specify:
1424 ``````````````````````
1425
1426 - job to be monitored - the Jenkins job which results are used as input data for
1427   this test;
1428 - builds used for trending plot(s) - specified by a list of build numbers or by
1429   a range of builds defined by the first and the last buld number;
1430 - list plots to generate:
1431
1432   - plot title;
1433   - output file name;
1434   - data for plots;
1435   - tests to be displayed in the plot defined by a filter;
1436   - list of parameters to extract from the data;
1437   - periods (daily = 1, weekly = 5, monthly = 30);
1438   - plot layout
1439
1440 *Example:*
1441
1442 ::
1443
1444     -
1445       type: "cpta"
1446       title: "Continuous Performance Trending and Analysis"
1447       algorithm: "cpta"
1448       output-file-type: ".html"
1449       output-file: "{DIR[STATIC,VPP]}/cpta"
1450       data: "plot-performance-trending"
1451       plots:
1452         - title: "VPP 1T1C L2 64B Packet Throughput - {period} Trending"
1453           output-file-name: "l2-1t1c-x520"
1454           data: "plot-performance-trending"
1455           filter: "'NIC_Intel-X520-DA2' and 'MRR' and '64B' and ('BASE' or 'SCALE') and '1T1C' and ('L2BDMACSTAT' or 'L2BDMACLRN' or 'L2XCFWD') and not 'VHOST' and not 'MEMIF'"
1456           parameters:
1457           - "result"
1458     #      - "name"
1459           periods:
1460           - 1
1461           - 5
1462           - 30
1463           layout: "plot-cpta"
1464
1465         - title: "VPP 2T2C L2 64B Packet Throughput - {period} Trending"
1466           output-file-name: "l2-2t2c-x520"
1467           data: "plot-performance-trending"
1468           filter: "'NIC_Intel-X520-DA2' and 'MRR' and '64B' and ('BASE' or 'SCALE') and '2T2C' and ('L2BDMACSTAT' or 'L2BDMACLRN' or 'L2XCFWD') and not 'VHOST' and not 'MEMIF'"
1469           parameters:
1470           - "result"
1471     #      - "name"
1472           periods:
1473           - 1
1474           - 5
1475           - 30
1476           layout: "plot-cpta"
1477
1478 API
1479 ---
1480
1481 List of modules, classes, methods and functions
1482 ```````````````````````````````````````````````
1483
1484 ::
1485
1486     specification_parser.py
1487
1488         class Specification
1489
1490             Methods:
1491                 read_specification
1492                 set_input_state
1493                 set_input_file_name
1494
1495             Getters:
1496                 specification
1497                 environment
1498                 debug
1499                 is_debug
1500                 input
1501                 builds
1502                 output
1503                 tables
1504                 plots
1505                 files
1506                 static
1507
1508
1509     input_data_parser.py
1510
1511         class InputData
1512
1513             Methods:
1514                 read_data
1515                 filter_data
1516
1517             Getters:
1518                 data
1519                 metadata
1520                 suites
1521                 tests
1522
1523
1524     environment.py
1525
1526         Functions:
1527             clean_environment
1528
1529         class Environment
1530
1531             Methods:
1532                 set_environment
1533
1534             Getters:
1535                 environment
1536
1537
1538     input_data_files.py
1539
1540         Functions:
1541             download_data_files
1542             unzip_files
1543
1544
1545     generator_tables.py
1546
1547         Functions:
1548             generate_tables
1549
1550         Functions implementing algorithms to generate particular types of
1551         tables (called by the function "generate_tables"):
1552             table_details
1553             table_performance_improvements
1554
1555
1556     generator_plots.py
1557
1558         Functions:
1559             generate_plots
1560
1561         Functions implementing algorithms to generate particular types of
1562         plots (called by the function "generate_plots"):
1563             plot_performance_box
1564             plot_latency_box
1565
1566
1567     generator_files.py
1568
1569         Functions:
1570             generate_files
1571
1572         Functions implementing algorithms to generate particular types of
1573         files (called by the function "generate_files"):
1574             file_test_results
1575
1576
1577     report.py
1578
1579         Functions:
1580             generate_report
1581
1582         Functions implementing algorithms to generate particular types of
1583         report (called by the function "generate_report"):
1584             generate_html_report
1585             generate_pdf_report
1586
1587         Other functions called by the function "generate_report":
1588             archive_input_data
1589             archive_report
1590
1591
1592 PAL functional diagram
1593 ``````````````````````
1594
1595 .. only:: latex
1596
1597     .. raw:: latex
1598
1599         \begin{figure}[H]
1600         \centering
1601             \includesvg[width=0.90\textwidth]{../_tmp/src/csit_framework_documentation/pal_func_diagram}
1602             \label{fig:pal_func_diagram}
1603         \end{figure}
1604
1605 .. only:: html
1606
1607     .. figure:: pal_func_diagram.svg
1608         :alt: PAL functional diagram
1609         :align: center
1610
1611
1612 How to add an element
1613 `````````````````````
1614
1615 Element can be added by adding it's model to the specification file. If
1616 the element is to be generated by an existing algorithm, only it's
1617 parameters must be set.
1618
1619 If a brand new type of element needs to be added, also the algorithm
1620 must be implemented. Element generation algorithms are implemented in
1621 the files with names starting with "generator" prefix. The name of the
1622 function implementing the algorithm and the name of algorithm in the
1623 specification file have to be the same.

©2016 FD.io a Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.
Please see our privacy policy and terms of use.