diff options
Diffstat (limited to 'docs/testing/user/userguide/10-yardstick-user-interface.rst')
| -rw-r--r-- | docs/testing/user/userguide/10-yardstick-user-interface.rst | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/docs/testing/user/userguide/10-yardstick-user-interface.rst b/docs/testing/user/userguide/10-yardstick-user-interface.rst new file mode 100644 index 000000000..246e1b1df --- /dev/null +++ b/docs/testing/user/userguide/10-yardstick-user-interface.rst @@ -0,0 +1,64 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 + +.. Convention for heading levels in Yardstick documentation: + + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ^^^^^^^ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + + Avoid deeper levels because they do not render well. + +======================== +Yardstick User Interface +======================== + +This chapter describes how to generate HTML reports, used to view, store, share +or publish test results in table and graph formats. + +The following layouts are available: + +* The compact HTML report layout is suitable for testcases producing a few + metrics over a short period of time. All metrics for all timestamps are + displayed in the data table and on the graph. + +* The dynamic HTML report layout consists of a wider data table, a graph, and + a tree that allows selecting the metrics to be displayed. This layout is + suitable for testcases, such as NSB ones, producing a lot of metrics over + a longer period of time. + + +Commands +-------- + +To generate the compact HTML report, run:: + + yardstick report generate <task-ID> <testcase-filename> + +To generate the dynamic HTML report, run:: + + yardstick report generate-nsb <task-ID> <testcase-filename> + + +Description +----------- + +1. When the command is triggered, the relevant values for the + provided task-id and testcase name are retrieved from the + database (`InfluxDB`_ in this particular case). + +2. The values are then formatted and provided to the html + template to be rendered using `Jinja2`_. + +3. Then the rendered template is written into a html file. + +The graph is framed with Timestamp on x-axis and output values +(differ from testcase to testcase) on y-axis with the help of +`Chart.js`_. + +.. _InfluxDB: https://www.influxdata.com/time-series-platform/influxdb/ +.. _Jinja2: http://jinja.pocoo.org/docs/2.10/ +.. _Chart.js: https://www.chartjs.org/ |