mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2024-12-28 02:26:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Improve tracing docs

Browse source
This commit is contained in:
Ryan Pavlik 2021-05-14 15:26:06 -05:00 committed by Jakob Bornecrantz
parent 0c8d78fe49
commit d0423bf405
2 changed files with 14 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/tracing-perfetto.md
View file

@ -1,20 +1,23 @@
# Tracing with Perfetto {#tracing-perfetto} # Tracing with Perfetto {#tracing-perfetto}
<!-- <!--
Copyright 2021-2022, Collabora, Ltd. and the Monado contributors Copyright 2021-2023, Collabora, Ltd. and the Monado contributors
SPDX-License-Identifier: BSL-1.0 SPDX-License-Identifier: BSL-1.0
--> -->
## Requirements ## Requirements
Monado uses the [Perfetto][]/[Percetto][] framework for tracining support, you Monado uses the [Perfetto][]/[Percetto][] framework for tracing support. You
need to first build and install [Percetto][] in a place where CMake can find it. need to first build and install [Percetto][] in a place where CMake can find it.
Build [Perfetto][] (you will have gotten the source at least as part of build Build [Perfetto][] (you will have gotten the source at least as part of build
[Percetto][]). It is a good idea to familiarise yourself with Perfetto before [Percetto][]). It is a good idea to familiarise yourself with Perfetto before
proceeding. You then need to build Monado with CMake and give make sure proceeding. You then need to build Monado with CMake and make sure
`XRT_FEATURE_TRACING` is enabled. `XRT_FEATURE_TRACING` is enabled.
* Build and install [Percetto][]. * Build and install [Percetto][] - **note** Depending on the version of Percetto
you are using you might need to have a release version of Perfetto available
or use the one that is included in percetto. A release version of Perfetto is
needed due to the `sdk/` directory and amalgamated files is only made there.
* Build and get [Perfetto][] running. * Build and get [Perfetto][] running.
* Build Monado with CMake and with `XRT_FEATURE_TRACING` being `ON`. * Build Monado with CMake and with `XRT_FEATURE_TRACING` being `ON`.
@ -24,7 +27,7 @@ Save the following file to `data_events.cfg`, next to your perfetto folder.
Please refer to [Perfetto][] documentation about the format and options of this Please refer to [Perfetto][] documentation about the format and options of this
config file, but the most important bits is the `tracker_event` section. config file, but the most important bits is the `tracker_event` section.
```c ```none
flush_period_ms: 30000 flush_period_ms: 30000
incremental_state_config { incremental_state_config {

8
doc/tracing-tracy.md
View file

@ -1,7 +1,7 @@
# Tracing with Tracy {#tracing-tracy} # Tracing with Tracy {#tracing-tracy}
<!-- <!--
Copyright 2022, Collabora, Ltd. and the Monado contributors Copyright 2022-2023, Collabora, Ltd. and the Monado contributors
SPDX-License-Identifier: BSL-1.0 SPDX-License-Identifier: BSL-1.0
--> -->
@ -21,7 +21,7 @@ is also required, but the order doesn't matter.
Start the [Tracy][] profiler, either try to connect directly to the host you Start the [Tracy][] profiler, either try to connect directly to the host you
want to run Monado on, or wait for it to show up in the first initial UI. Then want to run Monado on, or wait for it to show up in the first initial UI. Then
run Monado like you normally would, for example like below. run Monado like you normally would, for example as follows.
```bash ```bash
monado-serivce monado-serivce
@ -30,8 +30,8 @@ monado-serivce
## Notes ## Notes
Unlike @ref tracing-perfetto Tracy supports Windows, it also supports live Unlike @ref tracing-perfetto Tracy supports Windows, it also supports live
viewing of the data stream. But Tracy can only trace on application at a time viewing of the data stream. But Tracy can only trace one application at a time,
whereas Perfetto can do multiple processes at the same time and whole system whereas Perfetto can do multiple processes at the same time and whole system
tracing giving a higher level overview of the whole system. tracing, giving a higher level overview of the whole system.
[Tracy]: https://github.com/wolfpld/tracy [Tracy]: https://github.com/wolfpld/tracy