Logkit

Super fast, structured, scalable logging library for Rust

Hello World

#[macro_use] extern crate logkit;

fn main() {
    // logging with the default logger
    trace!("hello, this is a trace log");
    debug!("hello, this is a debug log");
    info!(version = "0.1.0", commit = "3291cc60"; "this is a log with two string fields");
    warn!(address = "127.0.0.1", port = 3000; "this is a log with a string and a numeric field");
    error!("this is a log with a 'println' style string {}:{}", "127.0.0.1", 3000.0);

    // set default logger's log level
    logkit::default_logger().write().level = logkit::LEVEL_INFO;

    debug!("you can't see this log because the level is below 'info'");
    info!("only logs with a level equal to or higher than 'info' can be seen");
    error!("you can see this error log with stack trace");

    // remove logger's stack plugin
    logkit::default_logger().write().unmount("stack");

    error!("stack trace printing feature has been disabled");

    // create our own pid plugin
    pub struct PidPlugin { pub pid: u32 }

    impl logkit::Plugin for PidPlugin {
        fn post(&self, record: &mut logkit::Record) -> bool {
            record.append("pid", self.pid);
            true
        }
    }

    logkit::default_logger().write().mount("pid", Box::new(PidPlugin {pid: std::process::id()}));

    info!("you will see this log with a process id");
}

Output sample:

{"level":"trace","time":"2024-01-24T15:53:44.332+08:00","msg":"hello, this is a trace log"}
{"level":"debug","time":"2024-01-24T15:53:44.333+08:00","msg":"hello, this is a debug log"}
{"level":"info","time":"2024-01-24T15:53:44.333+08:00","msg":"this is a log with two string fields","version":"0.1.0","commit":"3291cc60"}
{"level":"warn","time":"2024-01-24T15:53:44.333+08:00","msg":"this is a log with a string and a numeric field","address":"127.0.0.1","port":3000}
{"level":"error","time":"2024-01-24T15:53:44.333+08:00","msg":"this is a log with a 'println' style string 127.0.0.1:3000","stack":[{"funcname":"hello_world::main::h95297a3226de826e","filename":"/logkit/examples/hello_world.rs","lineno":9}]}
{"level":"info","time":"2024-01-24T15:53:44.388+08:00","msg":"only logs with a level equal to or higher than 'info' can be seen"}
{"level":"error","time":"2024-01-24T15:53:44.388+08:00","msg":"you can see this error log with stack trace","stack":[{"funcname":"hello_world::main::h95297a3226de826e","filename":"/logkit/examples/hello_world.rs","lineno":16}]}
{"level":"error","time":"2024-01-24T15:53:44.388+08:00","msg":"stack trace printing feature has been disabled"}
{"level":"info","time":"2024-01-24T15:53:44.388+08:00","msg":"you will see this log with a process id","pid":53864}

Documentation

The documentation is available here.

License

This software is released under the MIT License.