thin-edge.io icon indicating copy to clipboard operation
thin-edge.io copied to clipboard

Adding Benchmark section to our documentation page

Open gligorisaev opened this issue 5 months ago • 1 comments

Proposed changes

This PR provides performance benchmarks for ThinEdge.io, including detailed CPU and memory usage for key processes. The metrics are measured on a device rackfslot1 running in the OSADL QA Farm.

  • Included are also the Munin plugin files which are located on the OSADL QA Farm at /etc/munin/plugins/

  • The tedgecpuprocent plugin is up and running, the tedgemonitorcpu is still in draft and under work because I am trying to trigger the needed condition to raise an alarm, commiting it here only because somebody can maybe see some problem, improvement, etc. to the code.

  • Prepared script for downloading the needed .svg files which are showing the graphs on the documents page.

  • Included is also the workflow file which should trigger automatic download of the files once per month on month beggining

TODO

  • [ ] Decision needed for the final location of the downloading script
  • [ ] adding the munin username and password to GIT Secrets
  • [ ] Decision needed on which repo the workflow will be located and automaticaly trigerred
  • [ ] Decision needed what should be the workload we want to measure and show in the benchmark

Types of changes

  • [ ] Bugfix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • [x] Documentation Update (if none of the other choices apply)
  • [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • [x] I have read the CONTRIBUTING doc
  • [x] I have signed the CLA (in all commits with git commit -s)
  • [ ] I ran cargo fmt as mentioned in CODING_GUIDELINES
  • [ ] I used cargo clippy as mentioned in CODING_GUIDELINES
  • [ ] I have added tests that prove my fix is effective or that my feature works
  • [ ] I have added necessary documentation (if appropriate)

Further comments

gligorisaev avatar Sep 20 '24 07:09 gligorisaev