[Self managed docs] Document memory profiles and prometheus snapshots in debug tool #32608
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 tasks
SangJunBak
force-pushed
the
jun/self-managed/document-mz-debug-new-metrics
branch
from
92566ce to
d4a1586
Compare
kay-kim
approved these changes
May 30, 2025
kay-kim
reviewed
May 30, 2025
| @@ -0,0 +1,5 @@ | |||
| ### Memory profiles | |||
|
|
|||
| `mz-debug` outputs heap profiles if | |||
There was a problem hiding this comment.
Depending on what we want to emphasize, we could flip these sentences as (something like)
By default, mz-debug outputs heap profiles for each service in profiles/{service}.memprof.pprof.gz. To turn off this behavior, you can set --dump-heap-profiles to false.
There was a problem hiding this comment.
Also, where are these configs doc'ed? I don't see them on the page.
There was a problem hiding this comment.
I do see them in the main branch version's mz_debug_option.yml though... just an oversight on the self-managed-docs branch
kay-kim
requested changes
May 30, 2025
| @@ -0,0 +1,5 @@ | |||
| ### Memory profiles | |||
|
|
|||
| `mz-debug` outputs heap profiles if | |||
There was a problem hiding this comment.
Also, where are these configs doc'ed? I don't see them on the page.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
sibling pr #32607
Motivation
Tips for reviewer
Checklist
$T ⇔ Proto$Tmapping (possibly in a backwards-incompatible way), then it is tagged with aT-protolabel.