tree-logger 0.3.2

Simple yet feature-full logging and profile tool
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

use log::Record;
use std::{
    fmt::Display,
    sync::atomic::{AtomicUsize, Ordering},
};

use crate::constants;

static ID: AtomicUsize = AtomicUsize::new(0);

pub fn profile_core<L, F, T>(label: L, location: &'static str, func: F, quiet: bool) -> T
where
    L: Display,
    F: FnOnce() -> T,
{
    profile_core_with_level(label, location, func, log::Level::Info, quiet)
}

pub fn profile_core_with_level<L, F, T>(
    label: L,
    location: &'static str,
    func: F,
    level: log::Level,
    quiet: bool,
) -> T
where
    L: Display,
    F: FnOnce() -> T,
{
    let id = ID.fetch_add(1, Ordering::SeqCst); // TODO: is this correct?
    log::logger().log(
        &Record::builder()
            .key_values(&[(constants::INCREMENT, ())])
            .build(),
    );
    log::logger().log(
        &Record::builder()
            .level(level)
            .key_values(&[
                (constants::ID, id),
                (constants::QUIET, if quiet { 1 } else { 0 }),
            ])
            .target(location)
            .args(format_args!("{label}"))
            .build(),
    );

    let now = std::time::Instant::now();

    log::logger().log(
        &Record::builder()
            .key_values(&[(constants::INCREMENT, ())])
            .build(),
    );
    let rv = func();
    log::logger().log(
        &Record::builder()
            .key_values(&[(constants::DECREMENT, ())])
            .build(),
    );

    let elapsed = now.elapsed().as_millis();
    log::logger().log(
        &Record::builder()
            .key_values(&[
                (constants::SET_TIME, ""),
                (constants::TIME, &elapsed.to_string()),
                (constants::ID, &id.to_string()),
            ])
            .build(),
    );
    log::logger().log(
        &Record::builder()
            .key_values(&[(constants::DECREMENT, ())])
            .build(),
    );
    rv
}

/// Utility macro that profiles code and nests the logging output.
///
/// ```no_run
/// use tree_logger::TreeLogger;
/// TreeLogger::new().with_colors(true).with_threads(true).init().unwrap();
/// log::warn!("This is an example message.");
/// ```
///
#[macro_export]
macro_rules! profile {
    ($label:expr, $func:expr, $level:expr) => {
        tree_logger::profile::profile_core_with_level($label, file!(), $func, $level, false)
    };
    ($label:expr, $func:expr) => {
        tree_logger::profile::profile_core($label, file!(), $func, false)
    };
}

#[macro_export]
macro_rules! profile_quiet {
    ($label:expr, $func:expr, $level:expr) => {
        tree_logger::profile::profile_core_with_level($label, file!(), $func, $level, true)
    };
    ($label:expr, $func:expr) => {
        tree_logger::profile::profile_core($label, file!(), $func, true)
    };
}

#[cfg(test)]
mod test {
    use crate as tree_logger;

    #[test]
    fn logging_compiles() {
        crate::profile!("test", || {});
        crate::profile!("test", || {}, log::Level::Error);
        crate::profile_quiet!("test", || {}, log::Level::Error);
    }
}