Rust日志记录库kernlog使用指南

简介

kernlog是一个高效、轻量级的Rust日志记录库，专为系统日志和事件追踪设计。它具有以下特点：

• 极低的性能开销
• 线程安全的日志记录
• 灵活的日志级别控制
• 简洁的API设计
• 支持结构化日志

安装

在Cargo.toml中添加依赖：

[dependencies]
kernlog = "0.4"

基本用法

初始化日志系统

use kernlog::{init, LevelFilter};

fn main() {
    // 初始化日志系统，设置日志级别为Info
    init(LevelFilter::Info).expect("Failed to initialize logger");
    
    // 现在可以开始记录日志了
    log::info!("Application started");
}

记录不同级别的日志

log::trace!("This is a trace message");    // 最详细的日志级别
log::debug!("This is a debug message");    // 调试信息
log::info!("This is an info message");     // 常规信息
log::warn!("This is a warning message");   // 警告
log::error!("This is an error message");   // 错误

高级功能

结构化日志

kernlog支持结构化日志记录：

use log::{info, warn};

fn process_request(user_id: u32, request: &str) {
    info!(
        "Processing request";
        "user_id" => user_id,
        "request" => request,
        "status" => "started"
    );
    
    // 处理请求...
    
    warn!(
        "Request took too long";
        "user_id" => user_id,
        "duration_ms" => 1500,
        "threshold_ms" => 1000
    );
}

自定义日志格式

use kernlog::{init, LevelFilter, LogBuilder};

fn main() {
    LogBuilder::new()
        .set_level_filter(LevelFilter::Debug)
        .set_format(|record| {
            format!(
                "[{}] {} - {}:{} - {}",
                record.level(),
                chrono::Local::now().format("%Y-%m-%d %H:%M:%S"),
                record.file().unwrap_or("unknown"),
                record.line().unwrap_or(0),
                record.args()
            )
        })
        .init()
        .expect("Failed to initialize logger");
    
    log::debug!("Custom format log message");
}

日志级别动态调整

use kernlog::{set_max_level, LevelFilter};

fn adjust_log_level(new_level: LevelFilter) {
    set_max_level(new_level);
    log::info!("Log level changed to {:?}", new_level);
}

性能优化技巧

1. 在生产环境中使用LevelFilter::Info或更高以减少日志量
2. 对于高频日志，考虑使用log::log_enabled!宏先检查级别：

if log::log_enabled!(log::Level::Debug) {
    let data = expensive_computation();
    log::debug!("Computed data: {:?}", data);
}

1. 对于性能关键路径，考虑使用log::max_level()提前返回：

fn process_data(data: &[u8]) {
    if log::max_level() < log::LevelFilter::Debug {
        return;
    }
    
    // 只有当日志级别足够时才执行昂贵的调试操作
    log::debug!("Processing data: {:?}", hex::encode(data));
}

与标准库日志集成

kernlog实现了Rust的标准日志接口，因此可以与任何基于标准日志接口的库配合使用：

use env_logger; // 或其他日志库

fn main() {
    // 可以与其他日志实现共存
    env_logger::init();
    kernlog::init(LevelFilter::Info).unwrap();
    
    // 日志会同时输出到两个系统
    log::info!("This message goes to both loggers");
}

完整示例

下面是一个整合了kernlog主要功能的完整示例：

use kernlog::{init, LevelFilter, LogBuilder, set_max_level};
use log::{info, warn, debug, error, trace};
use chrono::Local;

fn main() {
    // 初始化日志系统
    init(LevelFilter::Debug).expect("Failed to initialize logger");

    // 记录不同级别日志
    trace!("This is a trace message");
    debug!("This is a debug message");
    info!("This is an info message");
    warn!("This is a warning message");
    error!("This is an error message");

    // 结构化日志示例
    process_request(123, "GET /api/data");

    // 动态调整日志级别
    set_max_level(LevelFilter::Info);
    debug!("This debug message won't be shown now");

    // 自定义格式日志
    custom_format_logger();

    // 性能优化示例
    log_performance_data(&[0x01, 0x02, 0x03]);
}

fn process_request(user_id: u32, request: &str) {
    info!(
        "Processing request";
        "user_id" => user_id,
        "request" => request,
        "status" => "started"
    );
    
    // 模拟处理请求
    warn!(
        "Request took too long";
        "user_id" => user_id,
        "duration_ms" => 1500,
        "threshold_ms" => 1000
    );
}

fn custom_format_logger() {
    LogBuilder::new()
        .set_level_filter(LevelFilter::Debug)
        .set_format(|record| {
            format!(
                "[{}] {} - {}:{} - {}",
                record.level(),
                Local::now().format("%Y-%m-%d %H:%M:%S"),
                record.file().unwrap_or("unknown"),
                record.line().unwrap_or(0),
                record.args()
            )
        })
        .init()
        .expect("Failed to initialize custom logger");
    
    debug!("This message has custom format");
}

fn log_performance_data(data: &[u8]) {
    // 性能优化：先检查日志级别
    if log::max_level() < log::LevelFilter::Debug {
        return;
    }
    
    debug!("Processing data: {:?}", hex::encode(data));
    
    // 或者使用 log_enabled! 宏
    if log::log_enabled!(log::Level::Trace) {
        let computed = expensive_computation();
        trace!("Expensive computation result: {}", computed);
    }
}

fn expensive_computation() -> String {
    // 模拟耗时计算
    "result".to_string()
}

这个示例展示了kernlog的主要功能：

1. 基本日志记录
2. 结构化日志
3. 日志级别动态调整
4. 自定义日志格式
5. 性能优化技巧

kernlog是一个轻量但功能强大的日志解决方案，特别适合需要高性能日志记录的系统应用程序。