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: adding new tutorial on how to handle heaptrack with nim waku #1719

Merged
merged 4 commits into from
May 9, 2023

Conversation

Ivansete-status
Copy link
Collaborator

Description

As per the issue "Heap analysis using heaptrack" we are adding a new tutorial that explains how to interact with heaptrack and nimwaku

Heaptrack is a memory analysis tool very useful to get a good insight of the underlying memory usage.

In this tutorial we describe the next "how to's":

  • get and build locally the heaptrack tool (Ubuntu.).
  • generate a heaptrack memory report.
  • analyse the resulting report.
  • create docker image with both heaptrack plus wakunode2

@Ivansete-status Ivansete-status self-assigned this May 5, 2023
@Ivansete-status Ivansete-status changed the title doc: adding new tutorial on how to handle heaptrack with nim waku docs: adding new tutorial on how to handle heaptrack with nim waku May 5, 2023
Copy link
Contributor

@jm-clius jm-clius left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work on this (both getting heaptrack working properly and documenting it in a tutorial)!🙌 Consider using semantic breaks between lines and clauses: https://sembr.org/

docs/tutorial/heaptrack.md Outdated Show resolved Hide resolved
docs/tutorial/heaptrack.md Outdated Show resolved Hide resolved
docs/tutorial/heaptrack.md Outdated Show resolved Hide resolved
Copy link
Contributor

@alrevuelta alrevuelta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great thanks for all the work with this!

Ivansete-status and others added 3 commits May 9, 2023 15:36
Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>
Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>
Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>
@Ivansete-status Ivansete-status merged commit 4b59e47 into master May 9, 2023
9 checks passed
@Ivansete-status Ivansete-status deleted the doc-add-heaptrack-tutorial branch May 9, 2023 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants