8bd4d90e78
## Motivation `tracing` currently consists of a large number of crates. The number of crates has the potential to be quite intimidating to users. ## Solution This branch makes the following changes: - Delete `tracing-fmt`. This crate's functionality has already been moved into `tracing-subscriber`, and a final version has been published to deprecate the crate & link to the code's new home. - Delete `tracing-tower-http`, as this functionality is now subsumed by `tracing-tower`. Since the crate was never published, we do not need to deprecate it. - Delete `tracing-slog`. This crate was never implemented, so we can just remove it from the repository. It can be re-created if we ever implement `slog` integration. - Move `tracing-env-logger` into a `tracing-log` module, and feature flag it. I updated some of the APIs as well. - Remove deleted crates from documentation. This makes most of the changes discussed in #308. Closes #308 Signed-off-by: Eliza Weisman <eliza@buoyant.io>
tracing
Application-level tracing for Rust.
Website | Chat | Documentation (master branch)
Overview
tracing is a framework for instrumenting Rust programs to collect
structured, event-based diagnostic information. tracing is maintained by the
Tokio project, but does not require the tokio runtime to be used.
Getting Help
First, see if the answer to your question can be found in the API documentation. If the answer is not there, there is an active community in the Tracing Gitter channel. We would be happy to try to answer your question. Last, if that doesn't work, try opening an issue with the question.
Contributing
🎈 Thanks for your help improving the project! We are so happy to have you! We have a contributing guide to help you get involved in the Tracing project.
Project layout
The tracing crate contains the primary instrumentation API, used for
instrumenting libraries and applications to emit trace data. The tracing-core
crate contains the core API primitives on which the rest of tracing is
instrumented. Authors of trace subscribers may depend on tracing-core, which
guarantees a higher level of stability.
Additionally, this repository contains several compatibility and utility
libraries built on top of tracing. Some of these crates are in a pre-release
state, and are less stable than the tracing and tracing-core crates.
The crates included as part of Tracing are:
-
tracing-futures: Utilities for instrumentingfutures. (crates.io|docs) -
tracing-macros: Experimental macros for emitting trace events (unstable). -
tracing-attributes: Procedural macro attributes for automatically instrumenting functions. (crates.io|docs) -
tracing-log: Compatibility with thelogcrate (unstable). -
tracing-serde: A compatibility layer for serializing trace data withserde(unstable). -
tracing-subscriber: Subscriber implementations, and utilities for implementing and composingSubscribers. (crates.io|docs) -
tracing-tower: Compatibility with thetowerecosystem (unstable).
External Resources
This is a list of links to blog posts, conference talks, and tutorials about Tracing.
Blog Posts
- Diagnostics with Tracing on the Tokio blog, August 2019
Talks
- Bay Area Rust Meetup talk and Q&A, March 2018
Help us expand this list! If you've written or spoken about Tracing, or know of resources that aren't listed, please open a pull request adding them.
License
This project is licensed under the MIT license.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Tracing by you, shall be licensed as MIT, without any additional terms or conditions.