Skip to content

Commit

Permalink
docs: how to get jeprof from target dir
Browse files Browse the repository at this point in the history
  • Loading branch information
evenyag committed Nov 14, 2024
1 parent c98db4f commit ce00310
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/how-to/how-to-profile-memory.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ This crate provides an easy approach to dump memory profiling info.

## Prerequisites
### jemalloc
jeprof is already compiled in the target directory of GreptimeDB. You can find the binary and use it.
```
# find jeprof binary
find . -name 'jeprof'
# add executable permission
chmod +x <path_to_jeprof>
```
The path is usually under `./target/${PROFILE}/build/tikv-jemalloc-sys-${HASH}/out/build/bin/jeprof`.

The default version of jemalloc installed from the package manager may not have the `--collapsed` option.
You may need to check the whether the `jeprof` version is >= `5.3.0` if you want to install it from the package manager.
```bash
# for macOS
brew install jemalloc
Expand Down

0 comments on commit ce00310

Please sign in to comment.