archive/mumble-voip_mumble
0
0
Fork 0
mirror of https://github.com/mumble-voip/mumble.git synced 2024-11-21 15:17:56 +00:00
Code Issues Projects Releases Wiki Activity
master
mumble-voip_mumble/docs/dev/Profiling.md
Robert Adam dd56e174f2 FEAT(server): Add support for the tracy profiler 
Tracy (https://github.com/wolfpld/tracy) is a profiler that is aimed at
having a very low impact on the runtime performance and is thus suitable
to be used in production systems to figure out what is going on and how
the code is performing.

For the time being, this commit instruments only the server code.
Furthermore, the instrumentation is performed in a rather minimalistic
way that should suffice to start profiling audio and control message
processing but is definitely far from being complete. Further
instrumentation will be added on-demand.
2021-12-29 18:01:28 +01:00

2.1 KiB
Raw Permalink Blame History

Profiling

Mumble comes with built-in support for the Tracy profiler. In order to activate the baked-in instrumentation, use -Dtracy=ON when compiling Mumble. When using that option, you should see a line in the cmake output that says TRACY_ENABLE: ON.

Instrumented parts

Currently only the Mumble server is instrumented (can be profiled using Tracy).

Instructions

Once you have built Mumble with -Dtracy=ON, Mumble will act as a Tracy client (in Tracy terms) which means that you can connect any Tracy server to it. Most commonly, you'll want to use either the profiler or the capture. Both of these programs live in the tracy submodule (3rdparty/tracy/) and can be built from there. For build instructions, see the Tracy Manual.

The profiler is an interactive GUI that can be attached to a currently running Mumble instance to see the profiling data (more or less) in realtime or you can open a previously recorded trace for analysis. Note that it is also possible to connect to a Mumble instance on a remote machine using this tool. All that is required is that it is able to establish a TCP connection to the target machine.

The capture tool has to be run on the same machine as the Mumble instance that shall be profiled. It is a command-line tool that will attach to a running Tracy client as soon as it is started. It will dump the captured data directly into a file, that can later on be opened in profiler for further analysis. This tool is recommended when you want to profile over a longer period of time or you don't want to add the burden of sending all profiling data out through the network, while Mumble is running.

Notes

  • Profiling should generally be done in Release mode in order to obtain reasonable data
  • If you are having issues connecting your Tracy server to the Mumble server, you should not let it fork. The default behavior in release mode is to fork, but you can change that by using the -fg parameter when starting the server.