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

Add doc about profiling Alloy #1781

Merged
merged 3 commits into from
Oct 7, 2024
Merged

Add doc about profiling Alloy #1781

merged 3 commits into from
Oct 7, 2024

Conversation

ptodev
Copy link
Contributor

@ptodev ptodev commented Sep 27, 2024

We often get asked to help with Alloy consumiing lots of memory. It would be helpful to point people to a doc.

If there is a bug in Alloy that's causing the high consumption, then the doc would help people gather enough information to submit a GitHub issue. Even if there is no bug in Alloy, this doc could still help some users to gain more insight into what is consuming memory/CPU.

Copy link
Contributor

@clayton-cornell clayton-cornell left a comment

Choose a reason for hiding this comment

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

First pass at an edit :-)

docs/sources/troubleshoot/profile.md Outdated Show resolved Hide resolved
docs/sources/troubleshoot/profile.md Outdated Show resolved Hide resolved
docs/sources/troubleshoot/profile.md Outdated Show resolved Hide resolved
docs/sources/troubleshoot/profile.md Outdated Show resolved Hide resolved
docs/sources/troubleshoot/profile.md Outdated Show resolved Hide resolved
docs/sources/troubleshoot/profile.md Outdated Show resolved Hide resolved
docs/sources/troubleshoot/profile.md Outdated Show resolved Hide resolved
docs/sources/troubleshoot/profile.md Outdated Show resolved Hide resolved
docs/sources/troubleshoot/profile.md Outdated Show resolved Hide resolved
docs/sources/troubleshoot/profile.md Outdated Show resolved Hide resolved
@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Sep 27, 2024
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Copy link
Contributor

@clayton-cornell clayton-cornell left a comment

Choose a reason for hiding this comment

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

One minor tweak and we can get this one published

docs/sources/troubleshoot/profile.md Outdated Show resolved Hide resolved
@clayton-cornell
Copy link
Contributor

@ptodev Do we want to backport this? I am guessing yes?

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
@ptodev
Copy link
Contributor Author

ptodev commented Oct 7, 2024

@ptodev Do we want to backport this? I am guessing yes?

Sure, why not :) I added a backport label for all the previous releases. Thank you for the review!

@ptodev ptodev merged commit c3b9f51 into main Oct 7, 2024
28 checks passed
@ptodev ptodev deleted the ptodev/memory-usage-docs branch October 7, 2024 17:13
github-actions bot pushed a commit that referenced this pull request Oct 7, 2024
* Add doc about profiling Alloy

* Apply suggestions from code review

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>

* Update docs/sources/troubleshoot/profile.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>

---------

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
(cherry picked from commit c3b9f51)
github-actions bot pushed a commit that referenced this pull request Oct 7, 2024
* Add doc about profiling Alloy

* Apply suggestions from code review

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>

* Update docs/sources/troubleshoot/profile.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>

---------

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
(cherry picked from commit c3b9f51)
github-actions bot pushed a commit that referenced this pull request Oct 7, 2024
* Add doc about profiling Alloy

* Apply suggestions from code review

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>

* Update docs/sources/troubleshoot/profile.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>

---------

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
(cherry picked from commit c3b9f51)
github-actions bot pushed a commit that referenced this pull request Oct 7, 2024
* Add doc about profiling Alloy

* Apply suggestions from code review

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>

* Update docs/sources/troubleshoot/profile.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>

---------

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
(cherry picked from commit c3b9f51)
github-actions bot pushed a commit that referenced this pull request Oct 7, 2024
* Add doc about profiling Alloy

* Apply suggestions from code review

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>

* Update docs/sources/troubleshoot/profile.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>

---------

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
(cherry picked from commit c3b9f51)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants