compio-log：Rust异步I/O日志库使用指南

介绍

compio-log是一个专为Rust异步I/O环境设计的高效日志记录库，它深度集成了compio运行时，提供了零成本抽象的高性能日志解决方案。该库特别适合需要高吞吐量日志记录的应用场景，如网络服务、实时数据处理等。

主要特性

• 无缝集成compio异步运行时
• 极低开销的日志记录机制
• 多日志级别支持
• 可定制的日志格式
• 异步友好的输出处理

使用方法

基础配置

首先在Cargo.toml中添加依赖：

[dependencies]
compio-log = "0.1"
log = "0.4"

初始化示例

use compio_log::CompioLogger;
use log::LevelFilter;

fn main() {
    // 初始化compio-log日志系统
    CompioLogger::builder()
        .with_max_level(LevelFilter::Info)
        .init()
        .unwrap();
    
    log::info!("compio-log initialized successfully!");
}

高级配置

use compio_log::CompioLogger;
use log::LevelFilter;

fn main() {
    CompioLogger::builder()
        .with_max_level(LevelFilter::Debug)
        .with_target(true)  // 显示日志目标
        .with_thread_ids(true)  // 显示线程ID
        .with_ansi(true)  // 启用ANSI颜色
        .init()
        .unwrap();
    
    log::debug!("Debug message with thread ID");
    log::warn!("Warning message with colors");
}

异步日志记录示例

use compio::runtime::Runtime;
use compio_log::CompioLogger;
use log::{info, error};

async fn async_task() {
    info!("This log is recorded asynchronously");
    if let Err(e) = some_async_operation().await {
        error!("Async operation failed: {}", e);
    }
}

#[compio::main]
async fn main() {
    CompioLogger::builder().init().unwrap();
    
    let task = async_task();
    task.await;
}

自定义日志格式

use compio_log::{CompioLogger, FormatFn};
use log::LevelFilter;
use time::OffsetDateTime;

fn custom_format(
    buf: &mut env_logger::fmt::Formatter,
    record: &log::Record,
) -> std::io::Result<()> {
    let time = OffsetDateTime::now_utc();
    writeln!(
        buf,
        "[{} {:<5} {}] {}",
        time.format("%Y-%m-%d %H:%M:%S.%f"),
        record.level(),
        record.target(),
        record.args()
    )
}

fn main() {
    CompioLogger::builder()
        .with_format(custom_format as FormatFn)
        .init()
        .unwrap();
    
    log::info!("Custom formatted log message");
}

完整示例demo

以下是一个完整的compio-log使用示例，展示了从初始化到多种日志级别的使用：

use compio::runtime::Runtime;
use compio_log::{CompioLogger, FormatFn};
use log::{debug, error, info, warn};
use time::OffsetDateTime;

// 自定义日志格式函数
fn custom_format(
    buf: &mut env_logger::fmt::Formatter,
    record: &log::Record,
) -> std::io::Result<()> {
    let time = OffsetDateTime::now_utc();
    writeln!(
        buf,
        "[{} {:<5} {}:{}] {}",
        time.format("%Y-%m-%d %H:%M:%S"),
        record.level(),
        record.file().unwrap_or("unknown"),
        record.line().unwrap_or(0),
        record.args()
    )
}

// 异步任务示例
async fn perform_async_work() {
    info!("开始执行异步任务");
    debug!("准备数据...");
    
    // 模拟异步操作
    compio::time::sleep(std::time::Duration::from_secs(1)).await;
    
    // 模拟错误情况
    if rand::random::<bool>() {
        warn!("遇到非致命警告");
    } else {
        error!("模拟异步操作失败");
    }
}

#[compio::main]
async fn main() {
    // 初始化日志系统
    CompioLogger::builder()
        .with_max_level(log::LevelFilter::Debug)
        .with_target(true)
        .with_thread_ids(true)
        .with_format(custom_format as FormatFn)
        .init()
        .unwrap();
    
    info!("应用程序启动");
    debug!("调试信息: 系统初始化完成");
    
    // 创建多个并发任务
    let mut tasks = vec![];
    for i in 0..5 {
        tasks.push(async move {
            info!("启动任务 #{}", i);
            perform_async_work().await;
            info!("完成任务 #{}", i);
        });
    }
    
    // 并行执行所有任务
    futures::future::join_all(tasks).await;
    
    info!("应用程序退出");
}

性能建议

1. 在生产环境中，考虑使用LevelFilter::Info或更高以减少调试日志开销
2. 对于极高吞吐量场景，可以使用CompioLogger::builder().without_time()移除时间戳
3. 批量日志操作可以利用compio的缓冲机制提高性能

compio-log通过深度集成异步I/O栈，为Rust异步应用提供了无阻塞的高性能日志解决方案，特别适合需要处理大量并发日志记录的场景。