tracing-subscriber-init 0.2.1

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
151
152
153
154
155
156
157
158
159
160
161
162
163
164

// 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::Level;
use tracing_subscriber::fmt::format::FmtSpan;

use crate::TracingConfig;

/// Determine the effective logging level based on quiet and verbosity settings.
#[cfg(debug_assertions)]
#[must_use]
pub fn get_effective_level(quiet: u8, verbosity: u8) -> Level {
    if verbosity > 0 {
        match verbosity {
            1 => Level::DEBUG,
            _ => Level::TRACE,
        }
    } else if quiet > 0 {
        match quiet {
            1 => Level::WARN,
            _ => Level::ERROR,
        }
    } else {
        Level::INFO
    }
}

/// Determine the effective logging level based on quiet and verbosity settings.
#[cfg(not(debug_assertions))]
#[must_use]
pub(crate) fn get_effective_level(_quiet: u8, verbosity: u8) -> Level {
    match verbosity {
        0 => Level::ERROR,
        1 => Level::WARN,
        2 => Level::INFO,
        3 => Level::DEBUG,
        4 | _ => Level::TRACE,
    }
}

#[doc(hidden)]
#[derive(Clone, Copy, Debug)]
pub struct TestAll;

impl TracingConfig for TestAll {
    fn quiet(&self) -> u8 {
        0
    }

    fn verbose(&self) -> u8 {
        3
    }

    #[cfg(feature = "json")]
    fn with_current_span(&self) -> bool {
        true
    }

    fn with_file(&self) -> bool {
        true
    }

    fn with_line_number(&self) -> bool {
        true
    }

    fn with_span_events(&self) -> Option<FmtSpan> {
        Some(FmtSpan::FULL)
    }

    #[cfg(feature = "json")]
    fn with_span_list(&self) -> bool {
        true
    }

    fn with_target(&self) -> bool {
        true
    }

    fn with_thread_ids(&self) -> bool {
        true
    }

    fn with_thread_names(&self) -> bool {
        true
    }
}

#[cfg(test)]
pub(crate) mod test {
    use super::get_effective_level;
    use crate::TracingConfig;
    use tracing::Level;

    #[cfg(debug_assertions)]
    #[test]
    fn get_effective_level_works() {
        assert_eq!(Level::INFO, get_effective_level(0, 0));
        assert_eq!(Level::DEBUG, get_effective_level(0, 1));
        assert_eq!(Level::TRACE, get_effective_level(0, 2));
        assert_eq!(Level::TRACE, get_effective_level(0, 3));
        assert_eq!(Level::WARN, get_effective_level(1, 0));
        assert_eq!(Level::DEBUG, get_effective_level(1, 1));
        assert_eq!(Level::TRACE, get_effective_level(1, 2));
        assert_eq!(Level::TRACE, get_effective_level(1, 3));
        assert_eq!(Level::ERROR, get_effective_level(2, 0));
        assert_eq!(Level::DEBUG, get_effective_level(2, 1));
        assert_eq!(Level::TRACE, get_effective_level(2, 2));
        assert_eq!(Level::TRACE, get_effective_level(2, 3));
    }

    #[cfg(not(debug_assertions))]
    #[test]
    fn get_effective_level_works() {
        assert_eq!(Level::ERROR, get_effective_level(0, 0));
        assert_eq!(Level::WARN, get_effective_level(0, 1));
        assert_eq!(Level::INFO, get_effective_level(0, 2));
        assert_eq!(Level::DEBUG, get_effective_level(0, 3));
        assert_eq!(Level::TRACE, get_effective_level(0, 4));
        assert_eq!(Level::TRACE, get_effective_level(0, 5));
    }

    #[derive(Clone, Debug)]
    pub(crate) struct TestConfig;

    impl TracingConfig for TestConfig {
        fn quiet(&self) -> u8 {
            0
        }

        fn verbose(&self) -> u8 {
            1
        }
    }

    #[derive(Clone, Debug)]
    #[allow(dead_code)]
    pub(crate) struct TestJson;

    impl TracingConfig for TestJson {
        fn quiet(&self) -> u8 {
            0
        }

        fn verbose(&self) -> u8 {
            1
        }

        #[cfg(feature = "json")]
        fn with_current_span(&self) -> bool {
            true
        }

        #[cfg(feature = "json")]
        fn with_span_list(&self) -> bool {
            true
        }
    }
}