-
Notifications
You must be signed in to change notification settings - Fork 55
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding Benchmark section to our documentation page #3125
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: gligorisaev <[email protected]>
Signed-off-by: gligorisaev <[email protected]>
Signed-off-by: gligorisaev <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅ Additional details and impacted files📢 Thoughts on this report? Let us know! |
scripts/download_svgs.py
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file has to be under ci/build_scripts
and not under yet another top level directory.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The script was at that location, but if I understand right @reubenmiller, he proposed not to be there so thats why I have it in the To Do section as needed to be decided
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Though I'm pretty sure we can reduce some dependencies (e.g. requests
which is not available by default in python) and just use a simple shell script which just depends on wget
...
wget --user "$MUNIN_USERNAME" --password "$MUNIN_PASSWORD" https://munin.osadl.org/munin/osadl.org/rackfslot1.osadl.org/tedgecpuprocent-month.svg
wget --user "$MUNIN_USERNAME" --password "$MUNIN_PASSWORD" https://munin.osadl.org/munin/osadl.org/rackfslot1.osadl.org/memory-month.svg
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@reubenmiller you are right, I changed the downloading script according you comment
sidebar_position: 10 | ||
--- | ||
|
||
# Benchmarks |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A key point is missing: what is the workload used for these benchmarks?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree fully, I put it in the ToDo section as decision needed what we want to be the workload
|
||
![Memory Usage](./memory-month.svg) | ||
|
||
### Monitored Metrics: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see these metrics as useful for giving an idea of the memory footprint of thin-edge, since there are not directly related.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, there are other metrics which just look at the memory for each of the thin-edge.io related memory usage, e.g. https://munin.osadl.org/munin/osadl.org/rackfslot1.osadl.org/tedgemem.html
docs/src/benchmarks/index.md
Outdated
|
||
Below is a visual representation of the memory consumption on the device over the past month. | ||
|
||
![Memory Usage](./memory-month.svg) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The memory script should only show the thin-edge.io applications and not the whole OS memory usage etc.
Signed-off-by: gligorisaev <[email protected]>
Signed-off-by: gligorisaev <[email protected]>
Signed-off-by: gligorisaev <[email protected]>
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, thetedgemonitorcpu
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
Types of changes
Paste Link to the issue
Checklist
cargo fmt
as mentioned in CODING_GUIDELINEScargo clippy
as mentioned in CODING_GUIDELINESFurther comments