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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
// Copyright 2016-2019 Cryptape Technologies LLC.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0>.
// This file may not be copied, modified, or distributed
// except according to those terms

pub use log::{debug, error, info, log, log_enabled, trace, warn};

use chrono::Local;
use crossbeam_channel::{bounded, Receiver};
use libc::c_int;
use log::LevelFilter;
use log4rs::append::console::ConsoleAppender;
use log4rs::append::file::FileAppender;
use log4rs::config::{Appender, Config, Logger, Root};
use log4rs::encode::pattern::PatternEncoder;
use std::env;
use std::fs;
use std::io::Error;
use std::str::FromStr;
use std::sync::{Once, ONCE_INIT};
use std::thread;
use std::vec::Vec;

pub enum LogFavour<'a> {
    Stdout(&'a str),
    File(&'a str),
}

#[derive(Debug, Clone)]
struct Directive {
    // Module name
    name: String,
    // Log level
    level: LevelFilter,
}

static INIT_LOG: Once = ONCE_INIT;

fn notify(signals: &[c_int]) -> Result<Receiver<c_int>, Error> {
    let (s, r) = bounded(100);
    let signals = signal_hook::iterator::Signals::new(signals)?;
    thread::spawn(move || {
        for signal in signals.forever() {
            s.send(signal);
        }
    });
    Ok(r)
}

pub fn init_config(favour: &LogFavour) {
    INIT_LOG.call_once(|| {
        // Parse RUST_LOG
        let directives: Vec<Directive> = match env::var("RUST_LOG") {
            Ok(s) => parse_env(&s),
            Err(_) => Vec::new(),
        };

        match favour {
            LogFavour::Stdout(service_name) => {
                let config = config_console_appender(service_name, directives);
                log4rs::init_config(config).unwrap();
            }
            LogFavour::File(service_name) => {
                // The config of log4rs
                let log_name = format!("logs/{}.log", service_name);
                let directives_clone = directives.clone();
                let config = config_file_appender(&log_name, directives_clone);
                let handle = log4rs::init_config(config).unwrap();

                // Log rotate via signal(USR1)
                let signal = notify(&[signal_hook::SIGUSR1]).unwrap();

                // Any and all threads spawned must come after the first call to notify (or notify_on).
                // This is so all spawned threads inherit the blocked status of signals.
                // If a thread starts before notify is called, it will not have the correct signal mask.
                // When a signal is delivered, the result is indeterminate.
                let service_name_clone = service_name.to_string();
                thread::spawn(move || {
                    loop {
                        // Blocks until this process is sent an USR1 signal.
                        signal.recv().unwrap();

                        // Rotate current log file
                        let time_stamp = Local::now().format("_%Y-%m-%d_%H-%M-%S");
                        let log_rotate_name =
                            format!("logs/{}{}.log", &service_name_clone, time_stamp);
                        if let Err(e) = fs::rename(&log_name, log_rotate_name) {
                            warn!("logrotate failed because of {:?}", e.kind());
                            continue;
                        }

                        // Reconfig
                        let directives_clone = directives.clone();
                        let new_config = config_file_appender(&log_name, directives_clone);
                        handle.set_config(new_config);
                    }
                });
            }
        }
    });
}

// Used in tests
pub fn init() {
    init_config(&LogFavour::Stdout(""));
}

// Used in unit case
pub fn silent() {
    INIT_LOG.call_once(|| {
        let config = Config::builder()
            .build(Root::builder().build(LevelFilter::Off))
            .unwrap();
        log4rs::init_config(config).unwrap();
    });
}

// Simple parse env (e.g: crate1,crate2::mod=debug,crate3::mod=trace)
fn parse_env(env: &str) -> Vec<Directive> {
    let mut directives = Vec::new();

    for s in env.split(',') {
        if s.is_empty() {
            continue;
        }
        let mut parts = s.split('=');
        let (log_level, name) = match (parts.next(), parts.next().map(str::trim), parts.next()) {
            (Some(part0), None, None) => match LevelFilter::from_str(part0) {
                Ok(num) => {
                    println!(
                        "warning: log level '{}' need explicit crate or module name.",
                        num
                    );
                    continue;
                }
                Err(_) => (LevelFilter::Info, part0),
            },
            (Some(part0), Some(""), None) => (LevelFilter::Info, part0),
            (Some(part0), Some(part1), None) => match LevelFilter::from_str(part1) {
                Ok(num) => (num, part0),
                _ => {
                    println!(
                        "warning: invalid logging spec '{}', \
                         ignoring it",
                        part1
                    );
                    continue;
                }
            },
            _ => {
                println!(
                    "warning: invalid logging spec '{}', \
                     ignoring it",
                    s
                );
                continue;
            }
        };

        if !name.is_empty() {
            directives.push(Directive {
                name: name.to_string(),
                level: log_level,
            });
        }
    }

    directives
}

fn create_loggers(directives: Vec<Directive>, appender: &str) -> Vec<Logger> {
    let mut loggers = Vec::new();

    if directives.is_empty() {
        return loggers;
    }

    // Create loggers via module/crate and log level
    for directive in directives {
        let appender_clone = appender.to_string();
        let logger = Logger::builder()
            .appender(appender_clone)
            .additive(false)
            .build(directive.name, directive.level);
        loggers.push(logger);
    }

    loggers
}

// FileAppender config
fn config_file_appender(file_path: &str, directives: Vec<Directive>) -> Config {
    let requests = FileAppender::builder()
        .encoder(Box::new(PatternEncoder::new(
            "{d(%Y-%m-%d - %H:%M:%S)} | {t:20.20} - {L:5} | {l:5} - {m}{n}",
        )))
        .build(file_path)
        .unwrap();

    let mut config_builder =
        Config::builder().appender(Appender::builder().build("requests", Box::new(requests)));

    let loggers = create_loggers(directives, "requests");

    // Config crate or module log level
    if !loggers.is_empty() {
        config_builder = config_builder.loggers(loggers.into_iter());
    }

    // Config global log level
    config_builder
        .build(
            Root::builder()
                .appender("requests")
                .build(LevelFilter::Info),
        )
        .unwrap()
}

// ConsoleAppender config
fn config_console_appender(service_name: &str, directives: Vec<Directive>) -> Config {
    let pattern = format!("[{}]: ", service_name) + "{d} - {l} - {m}{n}";
    let stdout = ConsoleAppender::builder()
        .encoder(Box::new(PatternEncoder::new(&pattern)))
        .build();

    let mut config_builder =
        Config::builder().appender(Appender::builder().build("stdout", Box::new(stdout)));

    let loggers = create_loggers(directives, "stdout");

    // Config crate or module log level
    if !loggers.is_empty() {
        config_builder = config_builder.loggers(loggers.into_iter());
    }

    // Config global log level
    config_builder
        .build(Root::builder().appender("stdout").build(LevelFilter::Info))
        .unwrap()
}

#[cfg(test)]
mod tests {

    use super::parse_env;
    use log::LevelFilter;

    #[test]
    fn parse_env_valid() {
        let directives = parse_env("crate1::mod1,crate1::mod2=debug,crate2=trace");
        assert_eq!(directives.len(), 3);
        assert_eq!(directives[0].name, "crate1::mod1".to_string());
        assert_eq!(directives[0].level, LevelFilter::Info);

        assert_eq!(directives[1].name, "crate1::mod2".to_string());
        assert_eq!(directives[1].level, LevelFilter::Debug);

        assert_eq!(directives[2].name, "crate2".to_string());
        assert_eq!(directives[2].level, LevelFilter::Trace);
    }

    #[test]
    fn parse_env_invalid_crate() {
        let directives = parse_env("crate1::mod=warn=info,crate2=warn");
        assert_eq!(directives.len(), 1);
        assert_eq!(directives[0].name, "crate2".to_string());
        assert_eq!(directives[0].level, LevelFilter::Warn);
    }

    #[test]
    fn parse_env_invalid_level() {
        let directives = parse_env("crate1::mod=wrong,crate2=error");
        assert_eq!(directives.len(), 1);
        assert_eq!(directives[0].name, "crate2".to_string());
        assert_eq!(directives[0].level, LevelFilter::Error);
    }

    #[test]
    fn parse_env_empty() {
        let directives = parse_env("crate1::mod=,=trace");
        assert_eq!(directives.len(), 1);
        assert_eq!(directives[0].name, "crate1::mod".to_string());
        assert_eq!(directives[0].level, LevelFilter::Info);
    }
}