loggest 0.2.2

A high performance logging facility for Rust's log crate
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

//! `loggest` provides a high performance logging facility for Rust's [log](https://docs.rs/log) crate.
//!
//! Instead of writing logs to a file, `loggest` writes them to a pipe. The other end of the pipe is
//! opened by a daemon which is responsible for writing the logs (and possibly compressing them).

//! # Multithreading
//!
//! Each thread maintains its connection to the log daemon to avoid locking for each log line.

mod ignore;
mod output;
mod session;

use derive_more::From;
use log::{set_logger, set_max_level, LevelFilter, Log, Metadata, Record};
use std::ffi::OsString;
use std::io;
use thiserror::Error;

pub use output::flush;

static LOGGER: Loggest = Loggest;
static mut CONFIG: Option<Config> = None;

struct Loggest;

struct Config {
    level: LevelFilter,
    base_filename: OsString,
}

/// Error initializing `loggest`
#[derive(Debug, Error, From)]
pub enum LoggestError {
    #[error("I/O error: `{0}`")]
    IoError(#[source] io::Error),

    #[error("Set logger error: `{0}`")]
    SetLoggerError(#[source] log::SetLoggerError),

    #[error("File name must be a valid utf-8")]
    BadFileName,
}

/// Initialize `loggest`. Must only be called once.
///
/// The `base_filename` argument is used as the name for the main thread. Other threads append `.<thread_id>`.
///
/// # Example
/// ```no_run
/// loggest::init(log::LevelFilter::max(), env!("CARGO_PKG_NAME")).unwrap();
/// ```
pub fn init<P>(level: LevelFilter, base_filename: P) -> Result<FlushGuard, LoggestError>
where
    P: Into<OsString>,
{
    let base_filename: OsString = base_filename.into();

    set_logger(&LOGGER)?;
    set_max_level(level);
    unsafe {
        debug_assert!(CONFIG.is_none());
        CONFIG = Some(Config { level, base_filename });
    }

    Ok(FlushGuard)
}

impl Log for Loggest {
    fn enabled(&self, metadata: &Metadata) -> bool {
        metadata.level() <= unsafe { CONFIG.as_ref().unwrap().level }
    }

    fn log(&self, record: &Record) {
        if !self.enabled(record.metadata()) {
            return;
        }

        output::log(record);
    }

    fn flush(&self) {}
}

pub struct FlushGuard;

impl Drop for FlushGuard {
    fn drop(&mut self) {
        flush();
    }
}