Summary Reporter#

The summary reporter provides a quick overview of allocated memory at the time when the tracked process’s memory usage was at its peak. It displays a table showing how much of that peak memory each function directly allocated (“own memory”), how much was cumulatively allocated by that function and everything it called (“total memory”), and the cumulative count of not yet freed allocations performed by that function and everything it called (“allocation count”). Allocations for different threads are aggregated together and shown in the same table.

_images/summary_example.png

Basic Usage#

The general form of the summary subcommand is:

memray summary [options] <results>

The only argument the summary subcommand requires is the capture file previously generated using the run subcommand.

The output will be printed directly to standard output. If standard output is a terminal, the output will be colorized.

CLI Reference#

usage: memray summary [-h] [-s SORT_COLUMN] [-r MAX_ROWS] results

Positional Arguments#

results

Results of the tracker run

options#

-s, --sort-column

Column number to sort on

Default: 1

-r, --max-rows

Maximum number of rows to display

Please submit feedback, ideas, and bug reports by filing a new issue at https://github.com/bloomberg/memray/issues