README.md
1![Tracing — Structured, application-level diagnostics][splash]
2
3[splash]: https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/splash.svg
4
5# tracing-subscriber
6
7Utilities for implementing and composing [`tracing`][tracing] subscribers.
8
9[`tracing`] is a framework for instrumenting Rust programs to collect
10scoped, structured, and async-aware diagnostics. The `Subscriber` trait
11represents the functionality necessary to collect this trace data. This
12crate contains tools for composing subscribers out of smaller units of
13behaviour, and batteries-included implementations of common subscriber
14functionality.
15
16`tracing-subscriber` is intended for use by both `Subscriber` authors and
17application authors using `tracing` to instrument their applications.
18
19[![Crates.io][crates-badge]][crates-url]
20[![Documentation][docs-badge]][docs-url]
21[![Documentation (master)][docs-master-badge]][docs-master-url]
22[![MIT licensed][mit-badge]][mit-url]
23[![Build Status][actions-badge]][actions-url]
24[![Discord chat][discord-badge]][discord-url]
25![maintenance status][maint-badge]
26
27[Documentation][docs-url] | [Chat][discord-url]
28
29[tracing]: https://github.com/tokio-rs/tracing/tree/master/tracing
30[tracing-fmt]: https://github.com/tokio-rs/tracing/tree/master/tracing-subscriber
31[crates-badge]: https://img.shields.io/crates/v/tracing-subscriber.svg
32[crates-url]: https://crates.io/crates/tracing-subscriber
33[docs-badge]: https://docs.rs/tracing-subscriber/badge.svg
34[docs-url]: https://docs.rs/tracing-subscriber/latest
35[docs-master-badge]: https://img.shields.io/badge/docs-master-blue
36[docs-master-url]: https://tracing-rs.netlify.com/tracing_subscriber
37[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
38[mit-url]: LICENSE
39[actions-badge]: https://github.com/tokio-rs/tracing/workflows/CI/badge.svg
40[actions-url]:https://github.com/tokio-rs/tracing/actions?query=workflow%3ACI
41[discord-badge]: https://img.shields.io/discord/500028886025895936?logo=discord&label=discord&logoColor=white
42[discord-url]: https://discord.gg/EeF3cQw
43[maint-badge]: https://img.shields.io/badge/maintenance-experimental-blue.svg
44
45*Compiler support: [requires `rustc` 1.63+][msrv]*
46
47[msrv]: #supported-rust-versions
48
49## Supported Rust Versions
50
51Tracing is built against the latest stable release. The minimum supported
52version is 1.63. The current Tracing version is not guaranteed to build on Rust
53versions earlier than the minimum supported version.
54
55Tracing follows the same compiler support policies as the rest of the Tokio
56project. The current stable Rust compiler and the three most recent minor
57versions before it will always be supported. For example, if the current stable
58compiler version is 1.69, the minimum supported version will not be increased
59past 1.66, three minor versions prior. Increasing the minimum supported compiler
60version is not considered a semver breaking change as long as doing so complies
61with this policy.
62
63## License
64
65This project is licensed under the [MIT license](LICENSE).
66
67### Contribution
68
69Unless you explicitly state otherwise, any contribution intentionally submitted
70for inclusion in Tracing by you, shall be licensed as MIT, without any additional
71terms or conditions.
72
