Improve the documentation for two memory counters#23126
Merged
yingsu00 merged 1 commit intoprestodb:masterfrom Jul 5, 2024
Merged
Improve the documentation for two memory counters#23126yingsu00 merged 1 commit intoprestodb:masterfrom
yingsu00 merged 1 commit intoprestodb:masterfrom
Conversation
steveburnett
requested changes
Jul 2, 2024
Contributor
steveburnett
left a comment
steveburnett
left a comment
There was a problem hiding this comment.
Looks good, thanks! Nits of formatting, nothing else. Let me know if my suggestions are not correct, please.
xiaoxmeng
previously approved these changes
Jul 2, 2024
| /// The minimal amount of memory capacity in bytes reserved for each query | ||
| /// memory pool. | ||
| /// The amount of memory in bytes reserved for each query memory pool. When | ||
| /// a query is trying to allocate memory from the reserved space whose size is |
| /// Specifies the total amount of memory in GB reserved for the queries on | ||
| /// a single worker node. A query can only allocate from this reserved space if | ||
| /// 1) the non-reserved space in "query-memory-gb" is used up; and 2) the amount | ||
| /// it is trying to get is less than 'memory-pool-reserved-capacity'. |
Contributor
Author
|
@steveburnett Thanks for reviewing! I have updated the PR with your comment addressed. Can you please review again? |
steveburnett
previously approved these changes
Jul 3, 2024
Contributor
steveburnett
left a comment
steveburnett
left a comment
There was a problem hiding this comment.
LGTM! (docs)
Pull updated branch, new local docs build, looks good. Thanks!
xiaoxmeng
approved these changes
Jul 3, 2024
Contributor
Author
|
Thanks @xiaoxmeng and @steveburnett for reviewing! |
steveburnett
approved these changes
Jul 3, 2024
Contributor
steveburnett
left a comment
steveburnett
left a comment
There was a problem hiding this comment.
LGTM! (docs)
Pull updated branch, new local docs build, looks good. Thanks!
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
Following the discussion of 0.288 release notes, I'm making these changes to clarify the two memory counters meanings. They are
query-memory-gbandquery-reserved-memory-gb.Impact
Help the user to understand these counters better
Test Plan
Contributor checklist