elph-core 0.0.6

Shared core utilities for Elph applications
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

mod options;
mod rotation;

pub use options::{LogRotation, LoggingOptions};
use tracing_appender::non_blocking::{NonBlockingBuilder, WorkerGuard};
use tracing_subscriber::{EnvFilter, fmt, layer::SubscriberExt, util::SubscriberInitExt};

pub use rotation::build_writer;

/// Bounded queue for the async file writer. Caps memory under sustained log bursts
/// (default upstream limit is 128_000 lines).
const FILE_WRITER_BUFFER_LINES: usize = 16_384;

/// Initializes the global tracing subscriber.
///
/// Returns a [`WorkerGuard`] that must be kept alive for the process lifetime so
/// the non-blocking file writer can flush buffered records.
pub fn init(options: LoggingOptions) -> Option<WorkerGuard> {
    if cfg!(test) {
        return None;
    }

    install_subscriber(&options)
}

fn non_blocking_writer(options: &LoggingOptions) -> (tracing_appender::non_blocking::NonBlocking, WorkerGuard) {
    let writer = build_writer(&options.logs_dir, options.app_name, options.rotation, options.max_files)
        .expect("failed to initialize rolling log writer");
    NonBlockingBuilder::default()
        .buffered_lines_limit(FILE_WRITER_BUFFER_LINES)
        .finish(writer)
}

fn install_subscriber(options: &LoggingOptions) -> Option<WorkerGuard> {
    let env_filter = EnvFilter::new(options.level.clone());

    match (options.file_enabled, options.console_enabled) {
        (true, true) => {
            let (non_blocking, guard) = non_blocking_writer(options);

            tracing_subscriber::registry()
                .with(env_filter)
                .with(
                    fmt::layer()
                        .json()
                        .with_writer(non_blocking)
                        .with_ansi(false)
                        .with_target(true),
                )
                .with(
                    fmt::layer()
                        .with_writer(std::io::stdout)
                        .with_target(true)
                        .with_ansi(true),
                )
                .init();

            Some(guard)
        }
        (true, false) => {
            let (non_blocking, guard) = non_blocking_writer(options);

            tracing_subscriber::registry()
                .with(env_filter)
                .with(
                    fmt::layer()
                        .json()
                        .with_writer(non_blocking)
                        .with_ansi(false)
                        .with_target(true),
                )
                .init();

            Some(guard)
        }
        (false, true) => {
            tracing_subscriber::registry()
                .with(env_filter)
                .with(
                    fmt::layer()
                        .with_writer(std::io::stdout)
                        .with_target(true)
                        .with_ansi(true),
                )
                .init();

            None
        }
        (false, false) => {
            tracing_subscriber::registry().with(env_filter).init();
            None
        }
    }
}