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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add doc about profiling Alloy #1781

wants to merge 2 commits into from

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
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

You may not want to upload your profiles to a public location.
{{< /admonition >}}

The port you use to send the HTTP request is governed by Alloy's `--server.http.listen-addr` [command line argument][cmd-cli].
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The port you use to send the HTTP request is governed by Alloy's `--server.http.listen-addr` [command line argument][cmd-cli].
The port you use to send the HTTP request is controlled by the `--server.http.listen-addr` [command line argument][cmd-cli].

Missed this one in the first pass. I think we can drop the Alloy's and assume the reader knows we are talking about the CLI arg in Alloy here.

@clayton-cornell
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants