Files
greptimedb/src/common/mem-prof/README.md
Lei, HUANG a4c01f4a3a feat: memory profiling (#1124)
* feat: use jemalloc as default allocator

* feat: add feature for mem-prof

* feat: add errors

* make common-mem-prof optional dep

* fix: toml format

* doc: add profile doc

* fix: typo
2023-03-07 17:12:51 +08:00

1.0 KiB

Profile memory usage of GreptimeDB

This crate provides an easy approach to dump memory profiling info.

Prerequisites

jemalloc

# for macOS
brew install jemalloc

# for Ubuntu
sudo apt install libjemalloc-dev

flamegraph

curl https://raw.githubusercontent.com/brendangregg/FlameGraph/master/flamegraph.pl > ./flamegraph.pl 

Build GreptimeDB with mem-prof feature.

cargo build --features=mem-prof

Profiling

Start GreptimeDB instance with environment variables:

MALLOC_CONF=prof:true,lg_prof_interval:28 ./target/debug/greptime standalone start

Dump memory profiling data through HTTP API:

curl localhost:4000/v1/prof/mem > greptime.hprof

You can periodically dump profiling data and compare them to find the delta memory usage.

Analyze profiling data with flamegraph

To create flamegraph according to dumped profiling data:

jeprof --svg <path_to_greptimedb_binary> --base=<baseline_prof> <profile_data> > output.svg