probe: 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 probe

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.5"

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. There is also a probe_lazy! variant that tries to avoid evaluating the argument expressions when probes aren't in use, if the platform-specific implementation allows that to be determined.

License

probe is distributed under the terms of both the MIT license and the Apache License (Version 2.0). See LICENSE-APACHE and LICENSE-MIT for details. Opening a pull request is assumed to signal agreement with these licensing terms.