Skip to content

Commit e0819b7

Browse files
committed
docs: document pause and threshold.
1 parent d1d0987 commit e0819b7

File tree

1 file changed

+30
-14
lines changed

1 file changed

+30
-14
lines changed

README.md

+30-14
Original file line numberDiff line numberDiff line change
@@ -75,16 +75,17 @@ TUI Way to Resourceful Text-based User Interfaces].
7575
Austin TUI can be installed directly from PyPI with
7676

7777
~~~ bash
78-
pip install austin-tui --upgrade
78+
pipx install austin-tui
7979
~~~
8080

81-
> **NOTE** In order for the TUI to work, the Austin 2 binary needs to be on the
82-
> ``PATH`` environment variable. Have a look at [Austin installation]
83-
> instructions to see how you can easily install Austin on your platform.
81+
> **NOTE** In order for the TUI to work, the Austin 3 binary needs to be
82+
> discoverable in the ways documented by the [austin-python] library. Have a
83+
> look at [Austin installation] instructions to see how you can easily install
84+
> Austin on your platform.
8485
8586
# Usage
8687

87-
Once [Austin] and Austin TUI are installed, you can start using them
88+
Once [Austin] 3 and Austin TUI are installed, you can start using them
8889
straight-away. If you want to launch and profile a Python script, say
8990
`myscript.py`, you can do
9091

@@ -95,12 +96,12 @@ austin-tui python3 myscript.py
9596
or, if `myscript.py` is an executable script,
9697

9798
~~~ bash
98-
austin-tui myscript.py
99+
austin-tui ./myscript.py
99100
~~~
100101

101-
Like [Austin], the TUI can also attach to a running Python application. To analyse
102-
the frame stacks of all the processes of a running WSGI server, for example, get
103-
hold of the PID of the parent process and do
102+
Like [Austin], the TUI can also attach to a running Python application. To
103+
analyse the frame stacks of all the processes of a running WSGI server, for
104+
example, get hold of the PID of the parent process and do
104105

105106
~~~ bash
106107
sudo austin-tui -Cp <pid>
@@ -130,22 +131,29 @@ similar to what top does with all the running processes on your system.
130131
</p>
131132

132133
If you want to see all the collected statistics, with the frame stacks
133-
represented as a rooted tree, you can press `F` to enter the _Full_ mode. The
134-
last seen stack will be highlighted so that you also have that information
135-
available while in this mode.
134+
represented as a rooted tree, you can press <kbd>F</kbd> to enter the _Full_
135+
mode. The last seen stack will be highlighted so that you also have that
136+
information available while in this mode.
136137

137138
<p align="center">
138139
<img src="art/austin-tui-full-mode.png"
139140
style="box-shadow: #111 0px 0px 16px;"
140141
alt="Austin TUI - Full mode" />
141142
</p>
142143

144+
The information that gets displayed is very dynamic and could become tricky to
145+
inspect. The current view can be paused by pressing <kbd>P</kbd>. To resume
146+
refreshing the view, press <kbd>P</kbd> again. While the view is paused,
147+
profiling data is still being captured and processed in the background, so that
148+
when the view is resumed, the latest figures are shown.
149+
150+
143151
## Save statistics
144152

145153
Peeking at a running Python application is nice but in many cases you would want
146154
to save the collected data for further offline analysis (for example, you might
147155
want to represent it as a flame graph). At any point, whenever you want to dump
148-
the collected data to a file, you can press the `S` key and a file with all the
156+
the collected data to a file, you can press <kbd>S</kbd> and a file with all the
149157
samples will be generated for you in the working directory, prefixed with
150158
`austin_` and followed by a timestamp. The TUI will notify of the successful
151159
operation on the bottom-right corner.
@@ -156,9 +164,16 @@ operation on the bottom-right corner.
156164
alt="Austin TUI - Save notification" />
157165
</p>
158166

167+
168+
## Threshold
169+
170+
The statistics reported by the TUI might be overwhelming, especially in full
171+
mode. To reduce the amout of data that gets displayed, the keys <kbd>+</kbd> and
172+
<kbd>-</kbd> can be used to increase or lower the `%TOTAL` threshold
173+
159174
# Compatibility
160175

161-
Austin TUI has been tested with Python 3.6-3.9 and is known to work on
176+
Austin TUI has been tested with Python 3.6-3.10 and is known to work on
162177
**Linux**, **macOS** and **Windows**.
163178

164179
Since Austin TUI uses [Austin] to collect samples, the same note applies here:
@@ -201,5 +216,6 @@ on BMC or by chipping in a few pennies on
201216

202217

203218
[Austin]: https://github.com/P403n1x87/austin
219+
[austin-python]: https://github.com/P403n1x87/austin-python#installation
204220
[Austin installation]: https://github.com/P403n1x87/austin#installation
205221
[The Austin TUI Way to Resourceful Text-based User Interfaces]: https://p403n1x87.github.io/the-austin-tui-way-to-resourceful-text-based-user-interfaces.html

0 commit comments

Comments
 (0)