@@ -6,9 +6,9 @@ the tracked process at the time when its memory usage was at its peak.
6
6
7
7
.. image :: _static/images/tree_example.png
8
8
9
- The tree reporter shows some statistics followed by a tree representation of
10
- the allocated memory. Several aspects are important when interpreting the tree
11
- representation:
9
+ The tree reporter shows an interactive terminal applocation displaying a tree
10
+ representation of the allocated memory. Several aspects are important when
11
+ interpreting the tree representation:
12
12
13
13
* Only the 10 source locations responsible for the most allocated bytes are
14
14
displayed. This is configurable with the ``--biggest-allocs `` command line
@@ -17,17 +17,24 @@ representation:
17
17
calculated based only on the allocations that are shown. Since any allocation
18
18
not big enough to be shown will not be included there, the reported total
19
19
memory of the root node is normally less than the process's peak memory size.
20
- * Call chains of one node are collapsed for better readability. This means that
21
- branches in the tree where each node has only one child are collapsed and a
22
- special node is shown to reflect this. The hidden frames **never ** correspond
23
- to frames that contained one of the source locations with the biggest
24
- allocations. The hidden frames are always callers of functions where the reported
25
- allocation happened.
26
20
* The "📂" icon represents a frame that is a **caller ** of a function where an
27
21
allocation happened while the "📄" icon represents a frame that allocated
28
22
memory.
29
23
* Frames are colored based on their reported memory usage percentage, from red
30
24
(most bytes allocated) to green (fewest).
25
+ * You can interact with the application using the following keys:
26
+
27
+ * You can navigate the tree using the arrow keys. Pressing the up arrow key
28
+ will move up one level in the tree, while pressing the down arrow key will
29
+ move down one level. When a selected node is changed, the panel on the right
30
+ will be updated to show the source code of the selected frame and some metadata
31
+ about the allocations assigned to that frame.
32
+ * Pressing the 'e' key will expand nodes and their children recursively until a node with
33
+ more than one child is found. This can be used to quickly expand the tree.
34
+ * Pressing the 'i' key will hide all nodes that belong to the import system and their
35
+ children.
36
+ * Presing the 'u' key will show all nodes that are marked as "uninteresting".
37
+
31
38
32
39
Basic Usage
33
40
-----------
0 commit comments