Rust性能分析工具logging_timer的使用：高效代码计时与日志记录库

logging_timer是一个简单易用的Rust库，用于测量代码块的执行时间并自动记录日志。它特别适合性能分析和优化工作。

安装

在Cargo.toml中添加依赖：

[dependencies]
logging_timer = "1.0"

基本用法

1. 最简单的计时器

use logging_timer::time;

fn my_function() {
    // 自动记录"my_function"的执行时间
    let _t = time!("my_function");
    
    // 你的代码逻辑...
    std::thread::sleep(std::time::Duration::from_millis(100));
}

2. 带自定义消息的计时器

use logging_timer::time;

fn process_data(data: &str) {
    let _t = time!("process_data"; "Processing data: {}", data);
    
    // 处理数据的代码...
    std::thread::sleep(std::time::Duration::from_millis(50));
}

3. 嵌套计时器

use logging_timer::time;

fn complex_operation() {
    let _t1 = time!("complex_operation");
    
    {
        let _t2 = time!("sub_operation_1");
        std::thread::sleep(std::time::Duration::from_millis(30));
    }
    
    {
        let _t3 = time!("sub_operation_2");
        std::thread::sleep(std::time::Duration::from_millis(20));
    }
}

高级功能

1. 自定义日志级别

use logging_timer::{time, Level};
use log::LevelFilter;

fn important_function() {
    // 使用WARN级别记录耗时
    let _t = time!(Level::Warn, "important_function");
    
    // 关键业务代码...
    std::thread::sleep(std::time::Duration::from_millis(200));
}

2. 条件编译

use logging_timer::stime;

fn release_mode_function() {
    // 只在debug构建时计时
    let _t = stime!("release_mode_function");
    
    // 生产环境代码...
    std::thread::sleep(std::time::Duration::from_millis(150));
}

3. 获取计时结果

use logging_timer::Timer;

fn get_elapsed_time() -> u128 {
    let timer = Timer::new("get_elapsed_time");
    
    // 执行一些操作...
    std::thread::sleep(std::time::Duration::from_millis(75));
    
    // 手动获取耗时(毫秒)
    timer.elapsed().as_millis()
}

配置选项

你可以在项目初始化时配置全局选项：

use logging_timer::Builder;

fn main() {
    Builder::new()
        .with_level(log::Level::Info)  // 默认日志级别
        .with_prefix("[TIMER] ")      // 自定义前缀
        .init();
    
    // 你的应用代码...
}

完整示例代码

下面是一个完整的示例，展示如何使用logging_timer来分析一个简单的Web请求处理流程：

use logging_timer::{time, stime, Level, Builder};
use log::{info, LevelFilter};
use env_logger::Builder as EnvBuilder;

// 初始化日志系统
fn init_logger() {
    EnvBuilder::new()
        .filter_level(LevelFilter::Info)
        .init();
    
    Builder::new()
        .with_level(log::Level::Info)
        .with_prefix("[PERF] ")
        .init();
}

// 模拟从数据库获取用户数据
fn fetch_user_from_db(user_id: u64) -> String {
    let _t = time!("fetch_user_from_db");
    // 模拟数据库查询延迟
    std::thread::sleep(std::time::Duration::from_millis(80));
    format!("User data for {}", user_id)
}

// 处理用户数据
fn process_user_data(data: &str) -> String {
    let _t = time!("process_user_data");
    // 模拟数据处理延迟
    std::thread::sleep(std::time::Duration::from_millis(120));
    data.to_uppercase()
}

// 只在debug构建中计时的辅助函数
fn debug_helper() {
    let _t = stime!("debug_helper");
    // 只在debug模式下计时的代码
    std::thread::sleep(std::time::Duration::from_millis(30));
}

// 关键业务函数 - 使用高级别日志
fn critical_business_logic() {
    let _t = time!(Level::Warn, "critical_business_logic");
    // 模拟关键业务处理
    std::thread::sleep(std::time::Duration::from_millis(150));
}

// 主请求处理函数
fn handle_request(user_id: u64) -> String {
    let _t = time!("handle_request"; "User ID: {}", user_id);
    
    debug_helper();
    
    let user_data = fetch_user_from_db(user_id);
    let processed_data = process_user_data(&user_data);
    
    critical_business_logic();
    
    processed_data
}

fn main() {
    init_logger();
    
    info!("Application started");
    
    let result = handle_request(42);
    info!("Request processed: {}", result);
}

日志输出示例

运行上述代码后，你可能会看到类似这样的日志输出：

[INFO] Application started
[INFO] [PERF] Starting 'handle_request' (User ID: 42)
[INFO] [PERF] Starting 'fetch_user_from_db'
[INFO] [PERF] 'fetch_user_from_db' took 82.456ms
[INFO] [PERF] Starting 'process_user_data'
[INFO] [PERF] 'process_user_data' took 122.123ms
[WARN] [PERF] Starting 'critical_business_logic'
[WARN] [PERF] 'critical_business_logic' took 152.789ms
[INFO] [PERF] 'handle_request' took 357.368ms
[INFO] Request processed: USER DATA FOR 42

注意事项

1. 确保你的项目已经初始化了日志系统（如env_logger）
2. 计时器变量（如_t）必须保持作用域直到代码块结束
3. 对于生产环境，考虑使用stime!宏来避免发布构建中的性能开销

logging_timer是一个轻量级但功能强大的工具，可以帮助你快速识别性能瓶颈，是Rust性能优化的好帮手。