structured-logger

A logging implementation for the log crate that logs structured values either synchronous or asynchronous, as JSON, CBOR, or any other format, into a file, stderr, stdout, or any other destination.

It is inspired by std-logger.

Usage

See examples and the [API documentation] for more.

Example

• Log panics example: https://github.com/iorust/structured-logger/blob/main/examples/panic_log.rs
• Async log example: https://github.com/iorust/structured-logger/blob/main/examples/async_log.rs

Simple example: ```rust use serde::Serialize; use std::{fs::File, io::stdout}; use structuredlogger::{json::newwriter, unix_ms, Builder};

fn main() { // Initialize the logger. // Optional: create a file to write logs to. let log_file = File::options() .create(true) .append(true) .open("app.log") .unwrap();

// Builder::with_level("debug")
Builder::new()
    // Optional: set a specific writer (format to JSON, write to stdout) for target "api".
    .with_target_writer("api", new_writer(stdout()))
    // Optional: set a specific writer (format to JSON, write to app.log file) for target "file".
    .with_target_writer("file", new_writer(log_file))
    .init();

let kv = ContextLog {
    uid: "user123".to_string(),
    action: "upate_book".to_string(),
};

log::info!("hello world");
// This log will be written to stderr (default writer):
// {"level":"INFO","message":"hello world","target":"simple","timestamp":1679745592127}

log::info!(target: "api",
    method = "GET",
    path = "/hello",
    status = 200_u16,
    start = unix_ms(),
    elapsed = 10_u64,
    kv = log::as_serde!(kv);
    "",
);
// This log will be written to stdout:
// {"elapsed":10,"kv":{"uid":"user123","action":"upate_book"},"level":"INFO","message":"","method":"GET","path":"/hello","start":1679745592127,"status":200,"target":"api","timestamp":1679745592127}

log::info!(target: "file",
    method = "GET",
    path = "/hello",
    status = 200_u16,
    start = unix_ms(),
    elapsed = 10_u64,
    kv = log::as_serde!(kv);
    "",
);
// This log will be written to file "app.log":
// {"elapsed":10,"kv":{"uid":"user123","action":"upate_book"},"level":"INFO","message":"","method":"GET","path":"/hello","start":1679745592127,"status":200,"target":"file","timestamp":1679745592127}

}

[derive(Serialize)]

struct ContextLog { uid: String, action: String, } ```

License

Copyright © 2023-present IO Rust.

iorust/structured-logger is licensed under either of Apache License, Version 2.0 or MIT license at your option.