Scarfski/tracy
1
0
Fork 0
mirror of https://github.com/wolfpld/tracy.git synced 2026-10-02 06:55:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update manual.

Browse Source
This commit is contained in:
Bartosz Taudul
2025-07-22 20:40:58 +02:00
parent 3c1c444a15
commit 840a74172e
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
manual/tracy.tex
View File

@@ -2886,7 +2886,7 @@ You can capture a trace using a command line utility contained in the \texttt{ca
If no client is running at the given address, the server will wait until it can make a connection. During the capture, the utility will display the following information:
\begin{verbatim}
% ./capture -a 127.0.0.1 -o trace
% ./tracy-capture -a 127.0.0.1 -o trace
Connecting to 127.0.0.1:8086...
Timer resolution: 3 ns
1.33 Mbps / 40.4% = 3.29 Mbps | Net: 64.42 MB | Mem: 283.03 MB | Time: 10.6 s
@@ -2899,7 +2899,7 @@ You can disconnect from the client and save the captured trace by pressing \keys
\subsection{Interactive profiling}
\label{interactiveprofiling}
If you want to look at the profile data in real-time (or load a saved trace file), you can use the data analysis utility contained in the \texttt{profiler} directory. After starting the application, you will be greeted with a welcome dialog (figure~\ref{welcomedialog}), presenting a bunch of useful links (\faBook{}~\emph{User manual}, \faGlobeAmericas{}~\emph{Web}, \faComment~\emph{Join chat} and \faHeart{}~\emph{Sponsor}). The \faGlobeAmericas{}~\emph{Web} button opens a drop-down list with links to the profiler's \emph{\faHome{}~Home page} and a bunch of \emph{\faVideo{}~Feature videos}.
If you want to look at the profile data in real-time (or load a saved trace file), you can use the data analysis utility \texttt{tracy-profiler} contained in the \texttt{profiler} directory. After starting the application, you will be greeted with a welcome dialog (figure~\ref{welcomedialog}), presenting a bunch of useful links (\faBook{}~\emph{User manual}, \faGlobeAmericas{}~\emph{Web}, \faComment~\emph{Join chat} and \faHeart{}~\emph{Sponsor}). The \faGlobeAmericas{}~\emph{Web} button opens a drop-down list with links to the profiler's \emph{\faHome{}~Home page} and a bunch of \emph{\faVideo{}~Feature videos}.
The \emph{\faWrench{}~Wrench} button opens the about dialog, which also contains a number of global settings you may want to tweak (section~\ref{aboutwindow}).
@@ -3016,7 +3016,7 @@ Each new release of Tracy changes the internal format of trace files. While ther
To use it, you will need to provide the input file and the output file. The program will print a short summary when it finishes, with information about trace file versions, their respective sizes and the output trace file compression ratio:
\begin{verbatim}
% ./update old.tracy new.tracy
% ./tracy-update old.tracy new.tracy
old.tracy (0.3.0) {916.4 MB} -> new.tracy (0.4.0) {349.4 MB, 31.53%} 9.7 s, 38.13% change
\end{verbatim}
@@ -4808,7 +4808,7 @@ Clicking on the~\emph{\faUser{}~User} role icon removes the chat content up to t
\section{Exporting zone statistics to CSV}
\label{csvexport}
You can use a command-line utility in the \texttt{csvexport} directory to export primary zone statistics from a saved trace into a CSV format.
You can use the command-line utility \texttt{tracy-csvexport} from the \texttt{csvexport} directory to export primary zone statistics from a saved trace into a CSV format.
The tool requires a single .tracy file as an argument and prints the result into the standard output (stdout), from where you can redirect it into a file or use it as an input into another tool.
By default, the utility will list all zones with the following columns:
@@ -4842,23 +4842,23 @@ You can customize the output with the following command line options:
Tracy can import data generated by other profilers. This external data cannot be directly loaded but must be converted first.
Currently, there's support for the following formats:
\begin{itemize}
\item chrome:tracing data through the \texttt{import-chrome} utility. The trace files
\item chrome:tracing data through the \texttt{tracy-import-chrome} utility. The trace files
typically have a \texttt{.json} or \texttt{.json.zst} extension.
To use this tool to process a file named \texttt{mytracefile.json}, assuming it's compiled, run:
\begin{lstlisting}[language=sh]
$ import-chrome mytracefile.json mytracefile.tracy
$ tracy mytracefile.tracy
$ tracy-import-chrome mytracefile.json mytracefile.tracy
$ tracy-profiler mytracefile.tracy
\end{lstlisting}
\item Fuchsia's tracing format\footnote{\url{https://fuchsia.dev/fuchsia-src/reference/tracing/trace-format}}
data through the \texttt{import-fuchsia} utility.
data through the \texttt{tracy-import-fuchsia} utility.
This format has many commonalities with the chrome:tracing format, but it uses a
compact and efficient binary encoding that can help lower tracing overhead.
The file extension is \texttt{.fxt} or \texttt{.fxt.zst}.
To this this tool, assuming it's compiled, run:
\begin{lstlisting}[language=sh]
$ import-fuchsia mytracefile.fxt mytracefile.tracy
$ tracy mytracefile.tracy
$ tracy-import-fuchsia mytracefile.fxt mytracefile.tracy
$ tracy-profiler mytracefile.tracy
\end{lstlisting}
\end{itemize}
@@ -4876,8 +4876,8 @@ noborder=true,
couleur=black!5,
logo=\bclampe
]{Source locations}
Chrome tracing format doesn't document a way to provide source location data.
The \texttt{import-chrome} and \texttt{import-fuchsia} utilities will however recognize a custom \texttt{loc} tag in the root of zone begin events. You should be formatting this data in the usual \texttt{filename:line} style, for example: \texttt{hello.c:42}. Providing the line number (including a colon) is optional but highly recommended.
Chrome tracing format doesn't provide a well-defined way to provide source location data.
The \texttt{tracy-import-chrome} and \texttt{tracy-import-fuchsia} utilities will however recognize a custom \texttt{loc} tag in the root of zone begin events. You should be formatting this data in the usual \texttt{filename:line} style, for example: \texttt{hello.c:42}. Providing the line number (including a colon) is optional but highly recommended.
\end{bclogo}
\begin{bclogo}[