docs: document memory profiling startup env#2589
Merged
Merged
Conversation
Add Continuous Profiling guidance that memory profile targets need jemalloc profiling enabled at process startup. Include command-line and Helm values examples for setting the required environment variable. Files: docs/enterprise/console-ui/continuous-profiling.md, versioned_docs/version-1.1/enterprise/console-ui/continuous-profiling.md, i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui/continuous-profiling.md, i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui/continuous-profiling.md Signed-off-by: Lei, HUANG <ratuthomm@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Continuous Profiling documentation to clarify that memory profiling requires jemalloc profiling to be enabled at process startup, and provides examples for setting the required environment variable for CLI and Helm deployments across current and versioned (v1.1) English/Chinese docs.
Changes:
- Add a note that Memory Profile targets must start with jemalloc profiling enabled.
- Add CLI example (
MALLOC_CONF=prof:true) and Helm values example (base.podTemplate.main.env) for enabling profiling. - Apply the same documentation updates to current + v1.1, EN + ZH copies.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/enterprise/console-ui/continuous-profiling.md | Adds jemalloc/MALLOC_CONF startup requirement and CLI/Helm examples for Memory Profiles (current EN). |
| versioned_docs/version-1.1/enterprise/console-ui/continuous-profiling.md | Same as above for v1.1 EN docs. |
| i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui/continuous-profiling.md | Same as above for current ZH docs. |
| i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui/continuous-profiling.md | Same as above for v1.1 ZH docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Deploying greptime-docs with
|
| Latest commit: |
a9898d3
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a552793d.greptime-docs.pages.dev |
| Branch Preview URL: | https://docs-mention-prof-env.greptime-docs.pages.dev |
Replace the external GreptimeDB memory profiling URL in Continuous Profiling docs with the local performance tuning memory profiling link. Signed-off-by: Lei, HUANG <ratuthomm@gmail.com>
evenyag
approved these changes
Jun 29, 2026
Update Continuous Profiling docs to require dashboard v0.2.0-alpha.8. Signed-off-by: Lei, HUANG <ratuthomm@gmail.com>
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
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.
Summary
Test Plan