isgasho / rust-libprobe

libprobe: Static probes for Rust

libprobe: Static probes for Rust

With the probe! macro, programmers can place static instrumentation points in their code to mark events of interest. These are compiled into platform-specific implementations, e.g. SystemTap SDT on Linux. Probes are designed to have negligible overhead during normal operation, so they can be present in all builds, and only activated using those external tools.

Documentation

Using libprobe

probe! is available on crates.io. The recommended way to use it is to add a line into your Cargo.toml such as:

[dependencies]
probe = "0.3"

Then use probe::probe; in your code and insert macro calls wherever you want to mark something, probe!(provider, name, args...). The provider and name are identifiers of your choice, and any additional arguments are runtime expressions that will be cast as isize for the probe consumer to read.

Rust integration

I hope that this library can eventually be a standard part of the Rust distribution -- see the rust pull request and original enhancement issue. It works fine as a standalone library, but if it were incorporated, then even Rust's own libraries could define probe points.

License

libprobe follows the same license choices as The Rust Project itself, in order to ease a future merge.

See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.