Writers for logging events and spans
tracing is a framework for instrumenting Rust programs to
collect structured, event-based diagnostic information.
allows events and spans to be recorded in a non-blocking manner through a
dedicated logging thread. It also provides a
that can be used with or without the non-blocking writer.
Compiler support: requires
Add the following to your
This crate can be used in a few ways to record spans/events:
- Using a
RollingFileAppenderto write to a log file. This is a blocking operation.
- Using any type implementing
std::io::Writein a non-blocking fashion.
RollingFileAppendertogether to write to log files in a non-blocking fashion.
Rolling File Appender
This creates an hourly rotating file appender that writes to
Rotation::NEVER] are the other available options.
The rolling module's documentation provides more detail on how to use this file appender.
The example below demonstrates the construction of a
with an implementation of
use Error; ;
_guard is a
WorkerGuard which is returned by
tracing_appender::non_blocking to ensure buffered logs are flushed to
their output in the case of abrupt terminations of a process. See
WorkerGuard module for more details.
The non_blocking module's documentation provides more detail on how to
Non-Blocking Rolling File Appender
Supported Rust Versions
tracing-appender is built against the latest stable release. The minimum supported
version is 1.53. The current
tracing-appender version is not guaranteed to build on
Rust versions earlier than the minimum supported version.
Tracing follows the same compiler support policies as the rest of the Tokio project. The current stable Rust compiler and the three most recent minor versions before it will always be supported. For example, if the current stable compiler version is 1.45, the minimum supported version will not be increased past 1.42, three minor versions prior. Increasing the minimum supported compiler version is not considered a semver breaking change as long as doing so complies with this policy.
This project is licensed under the MIT license.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Tokio by you, shall be licensed as MIT, without any additional terms or conditions.