======================== 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 To generate the dynamic HTML report, run:: yardstick report generate-nsb 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/