Skip to content

Docs: clarify MemoryManager usage #2185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
qorexdevs wants to merge 1 commit into from
+8 −0
Closed

Docs: clarify MemoryManager usage #2185

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/user_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1370,6 +1370,14 @@ a report on the number of allocations, bytes used, etc.
This data will then be reported alongside other performance data, currently
only when using JSON output.

The memory manager does not collect allocations by itself. It is meant to
bridge data from an allocator hook or profiler that already tracks memory
activity. Reset that collector in `Start()`, then copy its final counters into
`MemoryManager::Result` in `Stop()`.

Use [Custom Counters](#custom-counters) instead when memory stats need to be
Copy link
Copy Markdown
Member

@dmah42 dmah42 May 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no don't do this. we have the memory manager for exactly this reason. this would encourage users to run memory profiling in their performance sensitive micro benchmarks.

i don't think this PR is very useful.

reported in console or CSV output, or when you need allocator-specific columns.

<a name="profiling" />

## Profiling
Expand Down