Skip to content
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

Support memory profiling with Scalene and add flag to ./run.sh. #2260

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,7 @@ venv.bak/
*.swp

*.gpg

# Scalene memory profiling artifacts
client/profile.json
client/profile.html
8 changes: 8 additions & 0 deletions client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -477,3 +477,11 @@ Logs can be found in the `{sdc-home}/logs`. If you are debugging a version of th
[MAY]: https://datatracker.ietf.org/doc/html/rfc2119#section-5
[MUST]: https://datatracker.ietf.org/doc/html/rfc2119#section-1
[MUST NOT]: https://datatracker.ietf.org/doc/html/rfc2119#section-2


## Memory Profiling

Use [Scalene](https://github.com/plasma-umass/scalene) for memory profiling by running the client
with the `--memprofile` flag. After a few seconds, a browser-based GUI will appear and allow you to
inspect the CPU usage and memory usage of various calls over time, as well as point to code that may
create memory leaks. It's also possible to profile specific components, or tune the parameters to profile only specific components, only certain thresholds, and so on.
Loading
Loading