feat: add HTTP endpoint to control prof.gdump feature #6999
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
### Add Support for Jemalloc Gdump Flag - **`jemalloc.rs`**: Introduced `PROF_GDUMP` constant and added functions `set_gdump_active` and `is_gdump_active` to manage the gdump flag. - **`error.rs`**: Added error handling for reading and updating the jemalloc gdump flag with `ReadGdump` and `UpdateGdump` errors. - **`lib.rs`**: Exposed `is_gdump_active` and `set_gdump_active` functions for non-Windows platforms. - **`http.rs`**: Added HTTP routes for checking and toggling the jemalloc gdump flag status. - **`mem_prof.rs`**: Implemented handlers `gdump_toggle_handler` and `gdump_status_handler` for managing gdump flag via HTTP requests. Signed-off-by: Lei, HUANG <[email protected]>
github-actions
bot
added
size/S
documentation
docs-not-required
shuiyisong
reviewed
Sep 22, 2025
Co-authored-by: shuiyisong <[email protected]>
fengjiachun
approved these changes
Sep 26, 2025
| use crate::error::DumpProfileDataSnafu; | ||
|
|
||
| let is_active = common_mem_prof::is_gdump_active().context(DumpProfileDataSnafu)?; | ||
| Ok((StatusCode::OK, format!("{{\"active\": {}}}", is_active))) |
There was a problem hiding this comment.
Nit: use serde_json::json! ?
| curl -X POST localhost:4000/debug/prof/mem/deactivate | ||
|
|
||
| # Activate gdump feature that dumps memory profiling data every time virtual memory usage exceeds previous maximum value. | ||
| `curl -X POST localhost:4000/debug/prof/mem/gdump -d 'activate=true'` |
There was a problem hiding this comment.
Suggested change
| `curl -X POST localhost:4000/debug/prof/mem/gdump -d 'activate=true'` | |
| curl -X POST localhost:4000/debug/prof/mem/gdump -d 'activate=true' |
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.
I hereby agree to the terms of the GreptimeDB CLA.
Refer to a related PR or issue link (optional)
What's changed and what's your intention?
prof.gdumpis a convenient features provided by jemalloc that dumps the memory profiling data every time the memory usage exceeds previous maximum value. This PR adds an HTTP endpoint to control the status ofprof.gdump.Add Support for Jemalloc Gdump Flag
jemalloc.rs: IntroducedPROF_GDUMPconstant and added functionsset_gdump_activeandis_gdump_activeto manage the gdump flag.error.rs: Added error handling for reading and updating the jemalloc gdump flag withReadGdumpandUpdateGdumperrors.lib.rs: Exposedis_gdump_activeandset_gdump_activefunctions for non-Windows platforms.http.rs: Added HTTP routes for checking and toggling the jemalloc gdump flag status.mem_prof.rs: Implemented handlersgdump_toggle_handlerandgdump_status_handlerfor managing gdump flag via HTTP requests.PR Checklist
Please convert it to a draft if some of the following conditions are not met.