OpenParable
Skip to content
← Back to skills

Mz Profile

Testing & Quality
mz-profile

Mz Profile is an Agent Skill for testing & quality published in the MaterializeInc/materialize repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Trigger: "profile Materialize", "check memory usage", "analyze binary size", "debug performance", or mentions profiling, samply, heaptrack, flame graphs, memory checking, binary size, slow queries, high CPU/memory in Materialize. Also "slow" or "using too much memory" without explicit profile mention.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/MaterializeInc/materialize/blob/HEAD/.agents/skills/mz-profile/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/mz-profile, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Profiling Materialize

CPU profiling

Prefer profiling with samply, which produces Firefox Profiler-compatible flame graphs.

  • Attach to a running process: samply record -p PID
  • Record environmentd from startup: bin/environmentd --wrapper "samply record"
  • Record clusterd processes from startup: bin/environmentd -- --orchestrator-process-wrapper "samply record"

Samply opens a browser tab with an interactive flame graph when recording finishes.

On macOS, enable codesigning for Instruments support: bin/environmentd --enable-mac-codesigning

Memory profiling

Valgrind doesn't work on Materialize as it's too slow to yield results. Heaptrack works, but is slow.

Run heaptrack on environmentd processes: bin/environmentd --reset --no-default-features --wrapper "heaptrack --raw" Run heaptrack on clusterd processes: bin/environmentd --reset --no-default-features -- --orchestrator-process-wrapper "heaptrack --raw" Use heaptrack --interpret on the .raw.zst file to analyze.

Set MALLOC_CHECK_=3 MALLOC_PERTURB_=123 (and compile with --no-default-features on Linux to use the system allocator instead of jemalloc) to detect some memory corruption issues.

Analyze the size of binary functions

nm --demangle=rust --print-size --size-sort --radix=d BINARY to determine the binary size of symbols in BINARY. Produces a potentially large output, which should be redirected and analyzed separately. Filter with cut -d' ' -f2- | sort | sort -k3 | uniq to just learn about the size of symbols.