目錄log 日誌庫標準簡單示例使用方法庫的開發者應用開發者日誌庫開發者使用 log4rs添加依賴配置文件運行項目參考文章 log 日誌庫標準 log 是 Rust 的日誌門面庫，由官方積極維護可以放心使用。它是Rust的日誌門面，相應的日誌 API 已成為事實上的標準被其它日誌框架所使用，有了日誌門 ...
目錄
log 日誌庫標準
log 是 Rust 的日誌門面庫，由官方積極維護可以放心使用。它是Rust的日誌門面，相應的日誌 API 已成為事實上的標準被其它日誌框架所使用，有了日誌門面開發者可以很方便切換自己的日誌框架。
簡單示例
創建一個名為 log_test 二進位項目：
cargo new log_test
執行以下命令，引入 log 依賴：
cargo add log
修改 main.rs 的代碼如下：
use log::{info, warn,error,trace};
fn main() {
// 記錄日誌
info!("This is an info message");
warn!("This is a warning message");
error!("This is an error message");
trace!("This is an trace message");
}
運行上面的示例，實際上看不到任何輸出。因為 log 僅僅是日誌門面庫，它並不具備完整的日誌庫功能！
使用方法
因為 log 僅僅是日誌門面庫，對於庫和應用的開發者來說使用方法是有區別的，這也是 log 包這麼設計的優勢所在。
庫的開發者
作為庫的開發者，你只要在庫中使用門面庫即可，將具體的日誌庫交給用戶去選擇和綁定：
use log::{info, trace, warn};
pub fn deal_with_something() {
// 開始處理
// 記錄一些日誌
trace!("a trace log");
info!("a info long: {}", "abc");
warn!("a warning log: {}, retrying", err);
// 結束處理
}
應用開發者
如果是應用開發者，就需要去選擇一個具體的日誌庫了。
目前已經有了不少日誌庫實現，官方在 github 上也推薦了一些 ，主要分為以下幾類：
- 簡單的最小記錄器，如 env_logger 等
- 複雜的可配置框架，如 log4rs 等
- 其他設施的適配器，如 syslog、db_logger 等
- 對於 WebAssembly 二進位文件：console_log
- 對於動態庫：需要在日誌上構造一個 FFI 安全包裝器，以便在庫中進行初始化。
- 實用程式，如 alterable_logger 等
log 還提供了 set_logger 函數用於設置日誌庫，set_max_level 用於設置最大日誌級別。但是選用的具體日誌庫往往會提供更高級的 API，無需手動調用這兩個函數。
日誌庫開發者
對於日誌庫開發者而言，自然要實現自己的 Log 特征:
use log::{Record, Level, Metadata};
struct SimpleLogger;
impl log::Log for SimpleLogger {
fn enabled(&self, metadata: &Metadata) -> bool {
metadata.level() <= Level::Info
}
fn log(&self, record: &Record) {
if self.enabled(record.metadata()) {
println!("{} - {}", record.level(), record.args());
}
}
fn flush(&self) {}
}
除此之外，還需要包裝下 set_logger 和 set_max_level:
use log::{SetLoggerError, LevelFilter};
static LOGGER: SimpleLogger = SimpleLogger;
pub fn init() -> Result<(), SetLoggerError> {
log::set_logger(&LOGGER)
.map(|()| log::set_max_level(LevelFilter::Info))
}
然後再main函數裡面設置全局記錄器：
use log::{info, warn,error,trace};
fn main() {
//設置日誌
init();
// 記錄日誌
info!("This is an info message");
warn!("This is a warning message");
error!("This is an error message");
trace!("This is an trace message");
}
運行後終端輸出如下，因為設置日誌等級為Info，所以沒有輸出Trace等級日誌：
INFO - This is an info message
WARN - This is a warning message
ERROR - This is an error message
使用 log4rs
log4rs 是一個高度可配置的日誌框架，以 Java 的 Logback 和 log4j 庫為模型。
添加依賴
為項目添加 log4rs 依賴：
cargo add log4rs
配置文件
在項目根目錄下，創建一個 log4rs.yaml 配置文件，並添加以下內容：
refresh_rate: 30 seconds
appenders:
stdout:
kind: console
encoder:
pattern: "{d(%Y-%m-%d %H:%M:%S.%f)} [{l}] {t} - {m}{n}"
rolling_file:
kind: rolling_file
path: logs/test.log
append: true
encoder:
pattern: "{d(%Y-%m-%d %H:%M:%S.%f)} [{l}] {t} - {m}{n}"
policy:
kind: compound
trigger:
kind: size
limit: 10 mb
roller:
kind: fixed_window
pattern: logs/test.{}.log
base: 1
count: 5
root:
level: info
appenders:
- stdout
- rolling_file
上面配置文件設定日誌輸出到控制台、文件，文件按10 mb大小滾動，只保留最近五個文件。各個配置欄位的具體含義可以參考配置：
- refresh_rate：用於確定 log4rs 掃描配置文件以查找更改的頻率，如果發現更改，記錄器將自動重新配置
- appender： 負責將日誌收集到文件、控制台或系統日誌, 可配置多個
- stdout、rolling_file：追加器的唯一標識字元串，自己隨便定義，它的 kind 欄位只支持console、file、rolling_file 三種實現
- encoder： 負責將 log 信息轉換為合適的格式, 如固定格式的平文本或json
- pattern：編碼模板，格式可配置，具體格式詳見pattern
- policy：策略欄位，策略必須具有 kind 欄位，預設（且僅受支持）策略為 kind: compound
- trigger：觸發器欄位用於指示何時滾動日誌文件，支持 size 和 time 兩種類型，這裡使用的是按大小
運行項目
修改main.rs內容如下：
use log::*;
use log4rs;
fn main() {
log4rs::init_file("log4rs.yaml", Default::default()).unwrap();
for i in 1..=1000 {
info!("This is loop iteration {}", i);
}
}
運行結果：
2024-04-01 15:43:28.596832500 [INFO] hello_world - This is loop iteration 1
