1 unstable release
0.1.0 | Nov 20, 2019 |
---|
#325 in Profiling
80KB
1.5K
SLoC
Contains (ELF exe/lib, 4KB) src/bin/stap_probes.o
tracers - Rust instrumentation library
Summary
tracers
is intended to be an easy to use and cross-platform Rust crate which makes it easy to add high-performance
low-overhead probes to Rust programs. Underneath it will use each platform's native probing mechanism, like System Tap
on Linux, DTrace on BSD, and ETW on Windows. Those platforms without a supported probing mechanism will fall back to
a no-op implementation.
A key goal of this crate is to be able to drop it in to any Rust project, create and fire probes wherever it makes sense, and leave those probes in place all the time. When probes are disabled at compile time, there should be zero runtime impact, and when probes are compiled in but not enabled at runtime the probe impact should be no more than one or two CPU instructions.
Status
IMPORTANT: tracers
is still in the early experimental stages. The author hereby guarantees it will not work on
your system, may cause data loss, and definitely contributes to premature hair loss. Do not use it.
License
Except where otherwise indicated, this project is licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
However, the following -sys
crates have the license
corresponding to the third-party code which they wrap:
tracers-libelf-sys
- Wrapselfutils
libraries and thus is licensed LGPLv3tracers-libstapsdt-sys
- Wrapslibstapsdt
and thus is licensed MIT
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in tracers
by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
Releasing
This section applies to maintainers only.
To release a new version, dependent crates must be released first. The bin/publish.sh
script helps to automate the
process but it's still quite manual.
Release process:
-
Update the
version
property of all crates and of all crates' dependencies on othertracers
crates to the new target version. -
Ensure all dependencies have both a path dependency for local development, and a version dependency for publishing. These must be consistent with the new version being published.
-
Update the
documentation
link to reflect the current version.
Crates must be published in this order:
tracers-core
tracers-libelf-sys
tracers-libstapsdt-sys
tracers-codegen
tracers-macros-hack
tracers-macros
tracers-dyn-stap
tracers-dyn-noop
tracers-build
tracers
Dependencies
~5–16MB
~234K SLoC