1![Tracing — Structured, application-level diagnostics][splash] 2 3[splash]: https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/splash.svg 4 5# tracing-futures 6 7Utilities for instrumenting futures-based code with [`tracing`]. 8 9[![Crates.io][crates-badge]][crates-url] 10[![Documentation][docs-badge]][docs-url] 11[![Documentation (master)][docs-master-badge]][docs-master-url] 12[![MIT licensed][mit-badge]][mit-url] 13[![Build Status][actions-badge]][actions-url] 14[![Discord chat][discord-badge]][discord-url] 15![maintenance status][maint-badge] 16 17[Documentation][docs-url] | [Chat][discord-url] 18 19[crates-badge]: https://img.shields.io/crates/v/tracing-futures.svg 20[crates-url]: https://crates.io/crates/tracing-futures/0.2.5 21[docs-badge]: https://docs.rs/tracing-futures/badge.svg 22[docs-url]: https://docs.rs/tracing-futures/0.2.5/tracing_futures 23[docs-master-badge]: https://img.shields.io/badge/docs-master-blue 24[docs-master-url]: https://tracing-rs.netlify.com/tracing_futures 25[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg 26[mit-url]: LICENSE 27[actions-badge]: https://github.com/tokio-rs/tracing/workflows/CI/badge.svg 28[actions-url]:https://github.com/tokio-rs/tracing/actions?query=workflow%3ACI 29[discord-badge]: https://img.shields.io/discord/500028886025895936?logo=discord&label=discord&logoColor=white 30[discord-url]: https://discord.gg/EeF3cQw 31[maint-badge]: https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg 32 33## Overview 34 35[`tracing`] is a framework for instrumenting Rust programs to collect 36structured, event-based diagnostic information. This crate provides utilities 37for using `tracing` to instrument asynchronous code written using futures and 38async/await. 39 40The crate provides the following traits: 41 42* [`Instrument`] allows a `tracing` [span] to be attached to a future, sink, 43 stream, or executor. 44 45* [`WithSubscriber`] allows a `tracing` [`Subscriber`] to be attached to a 46 future, sink, stream, or executor. 47 48[`Instrument`]: https://docs.rs/tracing-futures/0.2.5/tracing_futures/trait.Instrument.html 49[`WithSubscriber`]: https://docs.rs/tracing-futures/0.2.5/tracing_futures/trait.WithSubscriber.html 50[span]: https://docs.rs/tracing/latest/tracing/span/index.html 51[`Subscriber`]: https://docs.rs/tracing/latest/tracing/subscriber/index.html 52[`tracing`]: https://crates.io/crates/tracing 53 54*Compiler support: [requires `rustc` 1.49+][msrv]* 55 56[msrv]: #supported-rust-versions 57 58## Supported Rust Versions 59 60Tracing is built against the latest stable release. The minimum supported 61version is 1.49. The current Tracing version is not guaranteed to build on Rust 62versions earlier than the minimum supported version. 63 64Tracing follows the same compiler support policies as the rest of the Tokio 65project. The current stable Rust compiler and the three most recent minor 66versions before it will always be supported. For example, if the current stable 67compiler version is 1.45, the minimum supported version will not be increased 68past 1.42, three minor versions prior. Increasing the minimum supported compiler 69version is not considered a semver breaking change as long as doing so complies 70with this policy. 71 72## License 73 74This project is licensed under the [MIT license](LICENSE). 75 76### Contribution 77 78Unless you explicitly state otherwise, any contribution intentionally submitted 79for inclusion in Tracing by you, shall be licensed as MIT, without any additional 80terms or conditions. 81
