/rust-fil-logger

A logging library used by Filecoin

Primary LanguageRustApache License 2.0Apache-2.0

A logging library used by Filecoin

This crate is used to make sure that all Filecoin related crates log in the same format.

By default the fil_logger doesn't log anything. You can change this by setting the RUST_LOG environment variable to another level. This will show log output on stderr. Example:

$ RUST_LOG=info cargo run --example simple
    Finished dev [unoptimized + debuginfo] target(s) in 0.02s
     Running `target/debug/examples/simple`
2019-11-11T20:26:09.448 INFO simple > logging on into level
2019-11-11T20:26:09.448 WARN simple > logging on warn level
2019-11-11T20:26:09.448 ERROR simple > logging on error level

It is also possible to ouput the log as JSON. Simply set the GOLOG_LOG_FMT environment variable to json. It is a bit more verbose and also contains the line file and line number of the log call:

$ GOLOG_LOG_FMT=json RUST_LOG=info cargo run --example simple
    Finished dev [unoptimized + debuginfo] target(s) in 0.03s
     Running `target/debug/examples/simple`
{"level":"info","ts":"2019-11-11T20:59:31.168+01:00","logger":"simple","caller":"examples/simple.rs:30","msg":"logging on into level"}"
{"level":"warn","ts":"2019-11-11T20:59:31.168+01:00","logger":"simple","caller":"examples/simple.rs:31","msg":"logging on warn level"}"
{"level":"error","ts":"2019-11-11T20:59:31.168+01:00","logger":"simple","caller":"examples/simple.rs:32","msg":"logging on error level"}"

Example

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

fn main() {
    fil_logger::init();

    trace!("logging on trace level");
    debug!("logging on debug level");
    info!("logging on into level");
    warn!("logging on warn level");
    error!("logging on error level");
}

License

The Filecoin Project is dual-licensed under Apache 2.0 and MIT terms: