json环境记录器

Rust的一个简单JSON结构化日志记录器。 这个crate是原始json_env_logger的重命名和重新发布。作者已放弃它。

安装

将以下内容添加到您的 Cargo.toml 文件中

[dependencies]
json_env_logger2 = "0.2"

使用方法

tl;dr

当您运行

$ RUST_LOG=trace cargo -q run \
  --example default \
  --features iso-timestamps

您将得到

{"level":"TRACE","ts":"2020-07-06T03:41:57.831Z","msg":"I am a trace","task_id":567,"thread_id":"12"}
{"level":"DEBUG","ts":"2020-07-06T03:41:57.832Z","msg":"I am a debug","foo":1}
{"level":"INFO","ts":"2020-07-06T03:41:57.832Z","msg":"I am an info"}
{"level":"WARN","ts":"2020-07-06T03:41:57.832Z","msg":"I am a warning"}
{"level":"ERROR","ts":"2020-07-06T03:41:57.832Z","msg":"I am an error"}

基本使用

类似于 env_logger，在启动日志记录引擎之前调用 init。

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

    log::info!("👋")
}

使用 RUST_LOG=info your/bin 运行您的程序

添加更多结构

《log》crate正在努力为其宏中的结构化字段添加一等接口。而不是重新发明这个功能，这个crate采用了它。《json_env_logger》将在存在时序列化这些键值对。遗憾的是，《log》crate尚未公开这些宏接口。 ...但是《kv-log-macro》做到了！

[dependencies]
json_env_logger = "0.1"
kv-log-macro = "1.0"

// the macros exported in this crate are
// log compatible and will one day be merged 
// so save your future self the toil of find and replace
use kv_log_macro as log;

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

    log::info!("👋", { size: "medium", age: 42 })
}

⭐ 这些结构化字段目前仅限于以下类型的值：u64，i64，f64，bool，char 或 str

使用 RUST_LOG=info your/bin 运行您的程序

ISO时间戳

默认情况下，json_env_logger使用Unix纪元时间作为时间戳。您可能更喜欢ISO-8601时间戳。您可以通过启用iso-timestamps功能来替换实现。

[dependencies]
json_env_logger = { version = "0.1", features = ["iso-timestamps"] }

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

    log::info!("👋")
}

使用 RUST_LOG=info your/bin 运行您的程序

恐慌可见性

当不可避免地发生恐慌时，您可以使用恐慌钩子将恐慌序列化为JSON，然后在记录时使用error!将其记录下来。

fn main() {
    json_env_logger::init();
    json_env_logger::panic_hook();

    panic!("whoooops!")
}

使用 RUST_LOG=info your/bin 运行您的程序

⭐ 您还可以通过启用backtrace cargo功能来序列化回溯

常见问题解答

#[macro_use]
extern crate slog;
extern crate slog_json;

use slog::Drain;
use std::sync::Mutex;

fn main() {
    let root = slog::Logger::root(
        Mutex::new(slog_json::Json::default(std::io::stderr())).map(slog::Fuse),
        o!("version" => env!("CARGO_PKG_VERSION"))
    );
}

fn main() {
    json_env_logger::init();
}

zdannar 2022