#sys #client #profiler #bindings

sys tracy-client-sys

Low level bindings to the client libraries for the Tracy profiler

9 breaking releases

0.16.0 May 19, 2021
0.14.0 May 14, 2021
0.13.0 Feb 17, 2021
0.11.0 Nov 18, 2020
0.8.0 Jun 24, 2020

#69 in Profiling

Download history 344/week @ 2021-08-11 332/week @ 2021-08-18 309/week @ 2021-08-25 181/week @ 2021-09-01 330/week @ 2021-09-08 508/week @ 2021-09-15 393/week @ 2021-09-22 518/week @ 2021-09-29 653/week @ 2021-10-06 664/week @ 2021-10-13 807/week @ 2021-10-20 470/week @ 2021-10-27 518/week @ 2021-11-03 519/week @ 2021-11-10 604/week @ 2021-11-17 731/week @ 2021-11-24

2,452 downloads per month
Used in 8 crates (via tracy-client)

MIT/Apache

760KB
19K SLoC

C++ 19K SLoC // 0.1% comments Rust 391 SLoC

Tracy profiler clients in Rust

This project contains Rust crates for producing Tracy profiler traces. Tracy features nanosecond precision, ability to profile remotely and a full-featured graphical interface for finding hot spots in profiled programs.

While Tracy's support for Rust is not first-class, it is still a very potent tool. If you have an application instrumented with the tracing crate, Tracy can be used with your program in minutes via the tracing-tracy crate. It can work well as both a profiling and, to a lesser extent, an observability tool.

Important note

Simply depending on crates in this repository is sufficient for tracy to be enabled at program startup, even if none of the APIs provided by this crate are invoked. Tracy will broadcast discovery packets to the local network and expose the data it collects in the background to that same network. Traces collected by Tracy may include source and assembly code as well.

As thus, you may want make sure to only enable the tracing-tracy, tracy-client and tracy-client-sys crates conditionally, via the enable feature flag provided by the crates.

Version support table

This project, unlike Tracy itself, follows semantic versioning. We will publish a breaking version bump for tracy-client-sys whenever there is a potentially breaking protocol change, even if the Tracy project itself does not. An older version of Tracy being unable to communicate with the client of a more recent version is an example of such a breaking change.

tracy-client, tracing-tracy and other crates also follow semantic versioning, but do not consider protocol breaks a breaking change for their purposes. For that reason each future version of tracy-client may be able to support depending on a large number of incompatible tracy-client-sys versions. Users are expected to select the version of Tracy profiler they target and use precise version bounds in Cargo.toml or Cargo.lock to specify the version of tracy-client-sys that they want to use.

The following table lists the version correspondence between the libraries.

Tracy tracy-client-sys tracy-client tracing-tracy
0.7.1 0.9.0 0.8.0 0.2.0
0.7.3 0.10.0 0.9.0 0.3.0
0.7.4 0.11.0 0.10.0 0.4.0
0.7.5 0.12.0 0.11.0 0.5.0
0.7.6 0.13.0, 0.14.0 0.12.* 0.6.*
v0.7.7 0.15.0 0.12.* 0.6.*
v0.7.8 0.16.0 0.12.* 0.6.*

No runtime deps