This work is done according to "Milestone 9: Build performance test report 
view" as stated in the Scope of Work with Sovereign Tech Fund (STF) 
(https://www.sovereigntechfund.de/).
The current report can be accessed here: 
Performance test report HTML 
(https://autobuilder.yocto.io/pub/non-release/20240117-15/testresults/buildperf-alma8/perf-alma8_master_20240117090048_663f180574.html)
The report is created using the `oe-build-perf-report` script in the poky 
repository. This script generates a performance test report in HTML format 
using the data from the yocto-buildstats 
(https://git.yoctoproject.org/yocto-buildstats/) repository.
The report displays the performance test results in line chart format. The 
chart x-axis represents the commit numbers, and the y-axis represents the test 
duration in minutes. 
The report also includes a table that displays the measurement statistics data 
for each test. The report is interactive and allows users to zoom in on 
specific sections of the line chart.

The current report format required some updates to make it more interactive and 
user-friendly. And this patch addresses such improvements:

- Add [Apache echart](https://echarts.apache.org/en/index.html) library to 
create oe build performance report charts and make them interactive.
- Restructure data to time and value array format to be used by echarts. It 
also converts test duration to minutes and adds zoom to the charts.
- Update measurement statistics data to include `start_time` so that time can 
be displayed instead of commit numbers on the chart. It also updates default 
commit history length to 300.
- Add styling updates including page margin, labels for x and y axis, tooltip, 
and section descriptions.
- The charts are created as step charts instead of plain line charts.
- Add start time, size, and commit number to tooltip.
- Add dark mode view

Updated report screenshots: 
https://github.com/neighbourhoodie/poky/assets/13760198/65a1890c-fd2a-40d4-ac90-f13055735e53
https://github.com/neighbourhoodie/poky/assets/13760198/b40c326b-17d2-42e2-8e41-72e52ed2c003
https://github.com/neighbourhoodie/poky/assets/13760198/cc7ec996-9dab-435a-8fdc-82a2a4193c0a
https://github.com/neighbourhoodie/poky/assets/13760198/6e0fe09d-50e5-4b0b-b70b-6943f71b5208

For local setup, you can do the following:

1. Clone the yocto-buildstats (https://git.yoctoproject.org/yocto-buildstats/) 
and the poky repository (https://git.yoctoproject.org/poky/)

2. In the poky repository run the following to build the report HTML:
```bash
./scripts/oe-build-perf-report -r "LOCAL_PATH_TO_YOCTO_BUILDSTATS" --branch 
"master" --commit "663f1805742ff6fb6955719d0ab7846a425debcf" --branch2 "master" 
--html > test.html
```
Note:
- Add your local path to the yocto-buildstats repo
- The above command builds the report in a file called `test.html`. You can 
access it in the root directory in poky.
- This exmaple report uses the commit 
`663f1805742ff6fb6955719d0ab7846a425debcf` from `master` branch.


Ninette Adhikari (5):
  oe-build-perf-report: Add apache echarts to make report interactive
  oe-build-perf-report: Display more than 300 commits and date instead
    of commit number
  oe-build-perf-report: Improve report styling and add descriptions
  oe-build-perf-report: Update chart tooltip and chart type
  oe-build-perf-report: Add dark mode

 .../build_perf/html/measurement_chart.html    | 140 ++++++++++++------
 scripts/lib/build_perf/html/report.html       | 124 +++++++++++-----
 scripts/lib/build_perf/report.py              |   5 +-
 scripts/oe-build-perf-report                  |   6 +-
 4 files changed, 193 insertions(+), 82 deletions(-)

-- 
2.44.0

-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#198996): 
https://lists.openembedded.org/g/openembedded-core/message/198996
Mute This Topic: https://lists.openembedded.org/mt/105889450/21656
Group Owner: openembedded-core+ow...@lists.openembedded.org
Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub 
[arch...@mail-archive.com]
-=-=-=-=-=-=-=-=-=-=-=-

Reply via email to