tracing-subscriber-init 0.2.6

A trait and some functions to make tracing subscriber initialization a bit easier
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

// Copyright (c) 2023 tracing-subscriber-init developers
//
// Licensed under the Apache License, Version 2.0
// <LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0> or the MIT
// license <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
// option. All files in the project carrying such notice may not be copied,
// modified, or distributed except according to those terms.

use tracing::{Subscriber, metadata::LevelFilter};
use tracing_subscriber::{
    Layer,
    filter::Filtered,
    fmt::{
        self,
        format::{DefaultFields, Format, Full},
    },
};

use crate::{TracingConfig, utils::get_effective_level};

/// Create a [`Full`](tracing_subscriber::fmt::format::Full) format layer configured from the given [`TracingConfig`].
///
/// # Example
/// ```rust
/// # use anyhow::Result;
/// # use tracing::info;
/// # use tracing_subscriber::Layer;
/// # use tracing_subscriber_init::{full, set_default, TestAll, TracingConfig};
/// #
/// # pub fn main() -> Result<()> {
/// let config = TestAll;
/// let (layer, level_filter) = full(&config);
/// let layer = layer.with_filter(level_filter);
/// let _unused = set_default(vec![layer.boxed()]);
/// info!("info level");
/// #   Ok(())
/// # }
/// ```
pub fn full<C, S>(config: &C) -> (fmt::Layer<S, DefaultFields, Format<Full>>, LevelFilter)
where
    C: TracingConfig,
    S: Subscriber,
    for<'a> S: tracing_subscriber::registry::LookupSpan<'a>,
{
    let layer = fmt::layer()
        .with_ansi(config.with_ansi())
        .with_file(config.with_file())
        .with_level(config.with_level())
        .with_target(config.with_target())
        .with_thread_ids(config.with_thread_ids())
        .with_thread_names(config.with_thread_names())
        .with_line_number(config.with_line_number());
    let layer = if let Some(fmt_span) = config.with_span_events() {
        layer.with_span_events(fmt_span)
    } else {
        layer
    };
    let level = get_effective_level(config.quiet(), config.verbose());
    let level_filter = LevelFilter::from(level);
    (layer, level_filter)
}

/// Create a [`Full`](tracing_subscriber::fmt::format::Full) format filtered layer configured from the given [`TracingConfig`].
///
/// # Example
/// ```rust
/// # use anyhow::Result;
/// # use tracing::info;
/// # use tracing_subscriber::Layer;
/// # use tracing_subscriber_init::{full_filtered, set_default, TestAll, TracingConfig};
/// #
/// # pub fn main() -> Result<()> {
/// let config = TestAll;
/// let layer = full_filtered(&config);
/// let _unused = set_default(vec![layer.boxed()]);
/// info!("info level");
/// #   Ok(())
/// # }
/// ```
pub fn filtered<C, S>(
    config: &C,
) -> Filtered<fmt::Layer<S, DefaultFields, Format<Full>>, LevelFilter, S>
where
    C: TracingConfig,
    S: Subscriber,
    for<'a> S: tracing_subscriber::registry::LookupSpan<'a>,
{
    let (layer, level_filter) = full(config);
    layer.with_filter(level_filter)
}

#[cfg(test)]
mod test {
    use tracing::{Level, debug, error, info, span, trace, warn};
    use tracing_subscriber::Layer;

    use super::filtered as full_filtered;

    use crate::{TestAll, set_default, utils::test::TestConfig};

    #[test]
    fn full_filtered_works() {
        let config = TestConfig;
        let layer = full_filtered(&config);
        let _unused = set_default(vec![layer.boxed()]);
        let span = span!(Level::INFO, "full_filtered_works");
        let _enter = span.enter();
        error!("error level");
        warn!("warn level");
        info!("info level");
        debug!("debug level");
        trace!("trace level");
    }

    #[test]
    fn full_filtered_all_works() {
        let config = TestAll;
        let layer = full_filtered(&config);
        let _unused = set_default(vec![layer.boxed()]);
        let span = span!(Level::TRACE, "full_filtered_all_works");
        let _enter = span.enter();
        error!("error level");
        warn!("warn level");
        info!("info level");
        debug!("debug level");
        trace!("trace level");
    }

    #[cfg(feature = "tstime")]
    #[test]
    fn full_utc_works() {
        use super::full;
        use time::format_description::well_known::Iso8601;
        use tracing_subscriber::fmt::time::UtcTime;

        let config = TestConfig;
        let (layer, level_filter) = full(&config);
        let filtered_layer = layer
            .with_timer(UtcTime::new(Iso8601::DEFAULT))
            .with_filter(level_filter);
        let _unused = set_default(vec![filtered_layer.boxed()]);
        let span = span!(Level::INFO, "full_utc_works");
        let _enter = span.enter();
        error!("error level");
        warn!("warn level");
        info!("info level");
        debug!("debug level");
        trace!("trace level");
    }
}