The open source OpenXR runtime
doc: Add metrics documentation
authored by
Jakob Bornecrantz
and committed by
Moses Turner
25bb8e47
37da46b7
+28
+28
doc/metrics.md
+28
doc/metrics.md
···
1
+
# Metrics collecting {#metrics}
2
+
3
+
<!--
4
+
Copyright 2022, Collabora, Ltd. and the Monado contributors
5
+
SPDX-License-Identifier: BSL-1.0
6
+
-->
7
+
8
+
## Requirements
9
+
10
+
Monado comes with it's own metrics collection and is built by default. No action
11
+
is needed by the developer to build the Monado sides of things. You will need to
12
+
checkout the [metrics repo][] to get the tools to analyse the resulting output
13
+
from Monado.
14
+
15
+
## Running
16
+
17
+
Launch the service with the env variable `XRT_METRICS_FILE` set.
18
+
19
+
```bash
20
+
XRT_METRICS_FILE=/path/to/file.protobuf monado-service
21
+
```
22
+
23
+
After Monado has finished running run the tool in the [metrics repo][], follow
24
+
the instructions in the [README.md][] file inside of that repo, there are more
25
+
instructions there.
26
+
27
+
[metrics repo]: https://gitlab.freedesktop.org/monado/utilities/metrics
28
+
[README.md]: https://gitlab.freedesktop.org/monado/utilities/metrics/-/blob/main/README.md