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

docs: memory profiling and OOM debugging tutorial #3819

Merged
merged 22 commits into from
Jan 10, 2024
Merged

Conversation

Rjected
Copy link
Member

@Rjected Rjected commented Jul 17, 2023

This distills some of my previous attempts at fixing memory leaks in reth, so that memory leak debugging can be more accessible.

I aim to give an overview on the process one should go through when faced with a memory related bug or incident, as well as provide some useful intuition for rust and reth-specific debugging. This will be a more advanced tutorial, and will assume some knowledge about linux, memory, and how to set up reth, but should otherwise be a general document that anyone can learn from.

@Rjected Rjected added C-docs An addition or correction to our documentation S-feedback-wanted This issue/PR is looking for feedback labels Jul 17, 2023
@codecov
Copy link

codecov bot commented Jul 17, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4dc15c3) 26.07% compared to head (b938364) 70.04%.
Report is 566 commits behind head on main.

❗ Current head b938364 differs from pull request most recent head b3a704a. Consider uploading reports for the commit b3a704a to get more accurate results

Additional details and impacted files

Impacted file tree graph

see 578 files with indirect coverage changes

Flag Coverage Δ
integration-tests 17.17% <ø> (-8.90%) ⬇️
unit-tests 64.85% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
reth binary 28.54% <ø> (+2.76%) ⬆️
blockchain tree 84.03% <ø> (+55.56%) ⬆️
pipeline 91.16% <ø> (+86.11%) ⬆️
storage (db) 76.52% <ø> (+46.55%) ⬆️
trie 95.97% <ø> (+73.44%) ⬆️
txpool 49.74% <ø> (+8.37%) ⬆️
networking 78.25% <ø> (+47.35%) ⬆️
rpc 61.77% <ø> (+35.29%) ⬆️
consensus 69.86% <ø> (+44.79%) ⬆️
revm 30.27% <ø> (+20.41%) ⬆️
payload builder 6.40% <ø> (-7.76%) ⬇️
primitives 89.29% <ø> (+60.11%) ⬆️

@github-actions github-actions bot added the S-stale This issue/PR is stale and will close with no further activity label Aug 3, 2023
@github-actions github-actions bot closed this Aug 10, 2023
@Rjected Rjected added M-prevent-stale Prevents old inactive issues/PRs from being closed due to inactivity and removed S-stale This issue/PR is stale and will close with no further activity labels Aug 10, 2023
@Rjected Rjected reopened this Aug 10, 2023
@mattsse
Copy link
Collaborator

mattsse commented Sep 14, 2023

what to do with this @Rjected ?

@mattsse
Copy link
Collaborator

mattsse commented Sep 21, 2023

bump @Rjected

@Rjected
Copy link
Member Author

Rjected commented Sep 21, 2023

bump @Rjected

going to take a small chunk of time soon to finish this up and mark r4r

@rkrasiuk
Copy link
Member

@Rjected bump :)

@gakonst
Copy link
Member

gakonst commented Jan 9, 2024

This still relevant @Rjected? If so let's merge or clsoe

@Rjected Rjected marked this pull request as ready for review January 9, 2024 22:18
@Rjected Rjected requested a review from gakonst as a code owner January 9, 2024 22:18
@Rjected
Copy link
Member Author

Rjected commented Jan 9, 2024

This still relevant @Rjected? If so let's merge or clsoe

Should be useful, finished it up, let's merge

@Rjected Rjected removed the S-feedback-wanted This issue/PR is looking for feedback label Jan 9, 2024
@mattsse mattsse added this pull request to the merge queue Jan 10, 2024
Merged via the queue into main with commit 42326fd Jan 10, 2024
27 checks passed
@mattsse mattsse deleted the dan/managing-memory branch January 10, 2024 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-docs An addition or correction to our documentation M-prevent-stale Prevents old inactive issues/PRs from being closed due to inactivity
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants