#log #terminal #file #benchmark

cli-log

a simple logging and timing facility configured with an env variable

5 releases (stable)

2.0.0 May 21, 2021
1.2.0 Mar 4, 2021
1.1.0 Feb 23, 2021
1.0.0 Feb 19, 2021
0.1.0 Dec 31, 2020

#22 in Profiling

Download history 499/week @ 2021-02-21 568/week @ 2021-02-28 593/week @ 2021-03-07 364/week @ 2021-03-14 356/week @ 2021-03-21 214/week @ 2021-03-28 198/week @ 2021-04-04 240/week @ 2021-04-11 269/week @ 2021-04-18 514/week @ 2021-04-25 257/week @ 2021-05-02 363/week @ 2021-05-09 328/week @ 2021-05-16 402/week @ 2021-05-23 688/week @ 2021-05-30 357/week @ 2021-06-06

1,570 downloads per month
Used in 7 crates (6 directly)

MIT license

14KB
200 lines

MIT Latest Version docs Chat on Miaou

cli-log

The boilerplate to have some file logging with a level given by an environment variable, and a facility to log execution durations according to the relevant log level.

It's especially convenient for terminal applications because you don't want to mix log with stdout or stderr.

The use of an env variable makes it possible to distribute the application and have users generate some logs without recompilation or configuration.

The names of the log file and the env variable are computed from the name of the application.

So log initialization is just

use cli_log::*; // also import logging macros
init_cli_log!();

If you prefer not having to declare cli_log import for all the log and cli-log logging macros, you may use the old #[macro_use] import in your main.rs file:

#[macro_use] extern crate cli_log;
init_cli_log!();

With the "mem" feature (enabled by default), when the OS is compatible (unix like), you may dump the current and peak memory usage with the log_mem function.

Here's a complete application using cli-log (it can be found in examples):

use cli_log::*;

#[derive(Debug)]
struct AppData {
    count: usize,
}
impl AppData {
    fn compute(&mut self) {
        self.count += 7;
    }
}

fn main() {
    init_cli_log!();
    let mut app_data = AppData { count: 35 };
    time!(Debug, app_data.compute());
    info!("count is {}", app_data.count);
    debug!("data: {:#?}", &app_data);
    warn!("this application does nothing");
    log_mem(Level::Info);
    info!("bye");
}

If you don't set any SMALL_APP_LOG env variable, there won't be any log.

A convenient way to set the env variable is to launch the app as

SMALL_APP_LOG=debug small_app

or, during development,

SMALL_APP_LOG=debug cargo run

This creates a small_app.log file containing information like the level, app version, and of course the log operations you did with time precise to the ms and the logging module (target):

21:03:24.081 [INFO] cli_log::init: Starting small-app v1.0.1 with log level DEBUG
21:03:24.081 [DEBUG] small_app: app_data.compute() took 312ns
21:03:24.081 [INFO] small_app: count is 42
21:03:24.081 [DEBUG] small_app: data: AppData {
    count: 42,
}
21:03:24.081 [WARN] small_app: this application does nothing
21:03:24.081 [INFO] cli_log::mem: Physical mem usage: current=938K, peak=3.3M
21:03:24.082 [INFO] small_app: bye

Dependencies

~0.7–1MB
~17K SLoC