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-journald
6
7Support for logging [`tracing`] events natively to [journald],
8preserving structured information.
9
10[![Crates.io][crates-badge]][crates-url]
11[![Documentation (master)][docs-master-badge]][docs-master-url]
12[![MIT licensed][mit-badge]][mit-url]
13![maintenance status][maint-badge]
14
15[crates-badge]: https://img.shields.io/crates/v/tracing-journald.svg
16[crates-url]: https://crates.io/crates/tracing-journald
17[docs-master-badge]: https://img.shields.io/badge/docs-master-blue
18[docs-master-url]: https://tracing-rs.netlify.com/tracing_journald
19[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
20[mit-url]: LICENSE
21[maint-badge]: https://img.shields.io/badge/maintenance-experimental-blue.svg
22
23## Overview
24
25[`tracing`] is a framework for instrumenting Rust programs to collect
26scoped, structured, and async-aware diagnostics. `tracing-journald` provides a
27[`tracing-subscriber::Layer`][layer] implementation for logging `tracing` spans
28and events to [`systemd-journald`][journald], on Linux distributions that use
29`systemd`.
30
31*Compiler support: [requires `rustc` 1.49+][msrv]*
32
33[msrv]: #supported-rust-versions
34[`tracing`]: https://crates.io/crates/tracing
35[layer]: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/layer/trait.Layer.html
36[journald]: https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html
37
38## Supported Rust Versions
39
40Tracing is built against the latest stable release. The minimum supported
41version is 1.49. The current Tracing version is not guaranteed to build on Rust
42versions earlier than the minimum supported version.
43
44Tracing follows the same compiler support policies as the rest of the Tokio
45project. The current stable Rust compiler and the three most recent minor
46versions before it will always be supported. For example, if the current stable
47compiler version is 1.45, the minimum supported version will not be increased
48past 1.42, three minor versions prior. Increasing the minimum supported compiler
49version is not considered a semver breaking change as long as doing so complies
50with this policy.
51
52## License
53
54This project is licensed under the [MIT license](LICENSE).
55
56### Contribution
57
58Unless you explicitly state otherwise, any contribution intentionally submitted
59for inclusion in Tracing by you, shall be licensed as MIT, without any additional
60terms or conditions.
61
