Add a note about zones crossing multiple on-demand connections.

This commit is contained in:
Bartosz Taudul
2026-08-19 20:29:48 +02:00
parent 275fef576a
commit e2c05210e7
2 changed files with 5 additions and 1 deletions

View File

@@ -11,7 +11,7 @@ The user manual
**Bartosz Taudul** [\<wolf@nereid.pl\>](mailto:wolf@nereid.pl)
2026-08-18 <https://github.com/wolfpld/tracy>
2026-08-19 <https://github.com/wolfpld/tracy>
# Quick overview {#quick-overview .unnumbered}
@@ -478,6 +478,8 @@ You should note that if on-demand profiling is *disabled* (which is the default)
[^12]: This memory is never released, but the profiler reuses it for collection of other events.
In on-demand mode, each connection to the server is a separate capture. A zone is included in a capture only if both its begin and end events occur during that connection: if the connection is lost and re-established while a zone is open, the end event is dropped and the zone remains unclosed in the previous capture. Zones that begin and end during a later connection, even while an older zone is still open, appear in the new capture as top-level zones.
> [!CAUTION]
> **Caveats**
>

View File

@@ -617,6 +617,8 @@ By default, Tracy will begin profiling even before the program enters the \textt
You should note that if on-demand profiling is \emph{disabled} (which is the default), then the recorded events will be stored in the system memory until a server connection is made and the data can be uploaded\footnote{This memory is never released, but the profiler reuses it for collection of other events.}. Depending on the amount of the things profiled, the requirements for event storage can quickly grow up to a couple of gigabytes. Furthermore, since this data is no longer available after the initial connection, you won't be able to perform a second connection to a client unless the on-demand mode is used.
In on-demand mode, each connection to the server is a separate capture. A zone is included in a capture only if both its begin and end events occur during that connection: if the connection is lost and re-established while a zone is open, the end event is dropped and the zone remains unclosed in the previous capture. Zones that begin and end during a later connection, even while an older zone is still open, appear in the new capture as top-level zones.
\begin{bclogo}[
noborder=true,
couleur=black!5,