matrixfurry.com
The open source OpenXR runtime
doc: Improve tracing docs
authored by
Ryan Pavlik
and committed by
Jakob Bornecrantz
d0423bf4
0c8d78fe
+14
-11
+9
-6
doc/tracing-perfetto.md
+9
-6
doc/tracing-perfetto.md
···
1
1
# Tracing with Perfetto {#tracing-perfetto}
2
2
3
3
<!--
4
-
Copyright 2021-2022, Collabora, Ltd. and the Monado contributors
4
+
Copyright 2021-2023, Collabora, Ltd. and the Monado contributors
5
5
SPDX-License-Identifier: BSL-1.0
6
6
-->
7
7
8
8
## Requirements
9
9
10
-
Monado uses the [Perfetto][]/[Percetto][] framework for tracining support, you
10
+
Monado uses the [Perfetto][]/[Percetto][] framework for tracing support. You
11
11
need to first build and install [Percetto][] in a place where CMake can find it.
12
-
Build [Perfetto][] (you will have gotten the source at least as part of build
12
+
Build [Perfetto][] (you will have gotten the source at least as part of build
13
13
[Percetto][]). It is a good idea to familiarise yourself with Perfetto before
14
-
proceeding. You then need to build Monado with CMake and give make sure
14
+
proceeding. You then need to build Monado with CMake and make sure
15
15
`XRT_FEATURE_TRACING` is enabled.
16
16
17
-
* Build and install [Percetto][].
17
+
* Build and install [Percetto][] - **note** Depending on the version of Percetto
18
+
you are using you might need to have a release version of Perfetto available
19
+
or use the one that is included in percetto. A release version of Perfetto is
20
+
needed due to the `sdk/` directory and amalgamated files is only made there.
18
21
* Build and get [Perfetto][] running.
19
22
* Build Monado with CMake and with `XRT_FEATURE_TRACING` being `ON`.
20
23
···
24
27
Please refer to [Perfetto][] documentation about the format and options of this
25
28
config file, but the most important bits is the `tracker_event` section.
26
29
27
-
```c
30
+
```none
28
31
flush_period_ms: 30000
29
32
30
33
incremental_state_config {
+5
-5
doc/tracing-tracy.md
+5
-5
doc/tracing-tracy.md
···
1
1
# Tracing with Tracy {#tracing-tracy}
2
2
3
3
<!--
4
-
Copyright 2022, Collabora, Ltd. and the Monado contributors
4
+
Copyright 2022-2023, Collabora, Ltd. and the Monado contributors
5
5
SPDX-License-Identifier: BSL-1.0
6
6
-->
7
7
···
21
21
22
22
Start the [Tracy][] profiler, either try to connect directly to the host you
23
23
want to run Monado on, or wait for it to show up in the first initial UI. Then
24
-
run Monado like you normally would, for example like below.
24
+
run Monado like you normally would, for example as follows.
25
25
26
26
```bash
27
27
monado-serivce
···
30
30
## Notes
31
31
32
32
Unlike @ref tracing-perfetto Tracy supports Windows, it also supports live
33
-
viewing of the data stream. But Tracy can only trace on application at a time
34
-
where as Perfetto can do multiple processes at the same time and whole system
35
-
tracing giving a higher level overview of the whole system.
33
+
viewing of the data stream. But Tracy can only trace one application at a time,
34
+
whereas Perfetto can do multiple processes at the same time and whole system
35
+
tracing, giving a higher level overview of the whole system.
36
36
37
37
[Tracy]: https://github.com/wolfpld/tracy