1 .. This work is licensed under a Creative Commons Attribution 4.0 International
3 .. http://creativecommons.org/licenses/by/4.0
5 .. Convention for heading levels in Yardstick documentation:
7 ======= Heading 0 (reserved for the title in a document)
13 Avoid deeper levels because they do not render well.
15 ========================
16 Yardstick User Interface
17 ========================
19 This chapter describes how to generate HTML reports, used to view, store, share
20 or publish test results in table and graph formats.
22 The following layouts are available:
24 * The compact HTML report layout is suitable for testcases producing a few
25 metrics over a short period of time. All metrics for all timestamps are
26 displayed in the data table and on the graph.
28 * The dynamic HTML report layout consists of a wider data table, a graph, and
29 a tree that allows selecting the metrics to be displayed. This layout is
30 suitable for testcases, such as NSB ones, producing a lot of metrics over
31 a longer period of time.
37 To generate the compact HTML report, run::
39 yardstick report generate <task-ID> <testcase-filename>
41 To generate the dynamic HTML report, run::
43 yardstick report generate-nsb <task-ID> <testcase-filename>
49 1. When the command is triggered, the relevant values for the
50 provided task-id and testcase name are retrieved from the
51 database (`InfluxDB`_ in this particular case).
53 2. The values are then formatted and provided to the html
54 template to be rendered using `Jinja2`_.
56 3. Then the rendered template is written into a html file.
58 The graph is framed with Timestamp on x-axis and output values
59 (differ from testcase to testcase) on y-axis with the help of
62 .. _InfluxDB: https://www.influxdata.com/time-series-platform/influxdb/
63 .. _Jinja2: http://jinja.pocoo.org/docs/2.10/
64 .. _Chart.js: https://www.chartjs.org/