常用Rust日志处理工具教程

在本文中，我想讨论Rust中的日志。通过一些背景信息，我将带您了解两个日志库：env_logger和log4rs。最后，我将分享我的建议和github的片段。

Rust log介绍

log包是Rust中日志API的事实标准，共有五个日志级别：error（最高优先级）、warn、info、debug和trace（最低优先级）。要记录一条消息，可以使用相应的日志marcos: error！warn!等。这些宏的行为就像println！一样并支持format!语法。也就是说，{}调用display, {:？}调用debug，{:#？}输出格式化debug信息。（稍后我们将看到一些示例。）

一个重要的注意事项是，log包只提供API，而不提供实现。你必须选择一个具体实现日志库。那么，Rust中最常用的日志库是什么呢？

env_logger

到目前为止，Rust中最常用的日志库是env_logger 包。在crates.io，env_logger的总下载量惊人。通过一行配置代码env_logger::init()，这个简单的库将所有日志写入stderr（可配置为stdout）。顾名思义，env_logger使用一个环境变量RUST_LOG来配置其日志级别。

例如，RUST_LOG=debug cargo run 记录调试或更高级别发出的所有内容，即除了trace之外的所有内容。

下面是一个简单的完整示例：

首先增加依赖：

-- cargo add log env_logger

[dependencies]
log = "0.4.22"
env_logger = "0.11.5"

示例代码：

use log::debug;
use log::error;
use log::info;
use log::warn;
fn main() {
    env_logger::init();
    debug!("Mary has a little lamb");
    error!("{}", "Its fleece was white as snow");
    info!("{:?}", "And every where that Mary went");
    warn!("{:#?}", "The lamb was sure to go");
}

运行命令：RUST_LOG=debug cargo run , 输出结果：

[2024-11-22T12:43:27Z DEBUG foo1] Mary has a little lamb
[2024-11-22T12:43:27Z ERROR foo1] Its fleece was white as snow
[2024-11-22T12:43:27Z INFO  foo1] "And every where that Mary went"
[2024-11-22T12:43:27Z WARN  foo1] "The lamb was sure to go"

此外，还有一些其他库构建在env_logger之上。例如，pretty_env_logger和json_env_logger包。你可能会发现它们很有用，如果你想日志或消息记录为json而不是文本。

log4rs

log4rs是 Rust 语言中一个功能强大且灵活的日志框架。它提供了高度可定制的日志记录功能，允许开发者根据不同的需求配置日志的输出级别、格式、目标（如输出到控制台、文件等）。与env_logger相比，log4rs具有更复杂和精细的配置选项，能够满足复杂项目中对日志管理的严格要求。

log4rs 包是按照Java的log4j库模仿的。要开始记录日志，必须创建一个appender，它确定日志的记录位置：控制台、文件或syslog。在生产系统中，你几乎总是希望使用滚动文件追加方式。滚动文件追加方式根据时间（比如每小时）生成一个新的日志文件。这自然地按时间组织日志文件，并支持跳过任何不感兴趣的时间段，例如，当你只想查看4月15日晚上7点发生的事情时。

然后，你需要配置希望在系统中保留多少日志文件，通常按存储大小（保留300GB）或保留时间（保留30天）进行配置。

核心概念

• 配置（Configuration）：log4rs的配置文件（通常是 YAML 或 JSON 格式）是其核心部分。通过配置文件，可以定义日志记录器（Logger）、日志级别、输出目标（Appender）和日志格式（Encoder）等关键元素。
• 日志记录器（Logger）：用于记录日志信息，它可以关联一个或多个输出目标。可以为不同的模块或功能创建不同的日志记录器，并且可以为每个记录器设置不同的日志级别。
• 输出目标（Appender）：决定日志信息的输出位置，常见的输出目标包括控制台（stdout）和文件。可以配置多个输出目标，并且每个输出目标可以有自己的日志格式。
• 日志格式（Encoder）：用于定义日志信息的格式，如时间戳、日志级别、日志消息等部分的排列和格式。

示例

首先增加依赖：

[dependencies]
log = "0.4.22"
log4rs = "1.0.0"

下面rust示例程序将上面知识整合在一起：

• 配置文件

log4rs配置文件（以 YAML 格式为例）log4rs.yml

refresh_rate: 30 seconds
appenders:
  console:
    kind: console
    encoder:
      pattern: "{d} - {l} - {m}{n}"
  file:
    kind: file
    path: "application.log"
    encoder:
      pattern: "{d} - {l} - {m}{n}"
loggers:
  my_app:
    level: info
    appenders:
      - console
      - file
root:
  level: error
  appenders:
    - console

解释说明：

• refresh_rate：表示配置文件的刷新频率，这里是每 30 秒刷新一次配置。
• appenders：定义了日志的输出目标。
  1. console：将日志输出到控制台。kind: console表示输出目标是控制台，encoder部分定义了日志格式，{d}表示日期时间，{l}表示日志级别，{m}表示日志消息，{n}表示换行符。
  2. file：将日志输出到文件。kind: file指定了输出目标为文件，path: "application.log"定义了日志文件的名称，其日志格式与控制台相同。
• loggers：定义了名为my_app的日志记录器，日志级别为info，关联了console和file两个输出目标。
• root：定义了根日志记录器，日志级别为error，只关联了console输出目标。在log4rs配置中，root logger 是日志系统的根记录器。它的主要作用是为整个应用程序提供一个兜底的日志级别和输出目标设置。当一个日志事件没有被其他更具体的logger处理时，就会由root logger 来处理。例如，如果在应用程序中有一些代码模块没有明确关联到其他自定义的logger，那么这些模块产生的日志就会遵循root logger 的配置。

下面是示例代码：

use log4rs::init_config;
use log::{error, info};
fn main() {
    // 初始化log4rs配置
    init_config("log4rs.yml").unwrap();
    info!("This is an info log");
    error!("This is an error log");
}

首先通过init_config("log4rs.yml")来初始化log4rs，传入的参数是配置文件的名称。如果配置文件加载成功，就可以使用log crate 提供的日志宏（如info!和error!）来记录日志。根据配置文件，info级别的日志会输出到控制台和文件，error级别的日志也会输出到控制台和文件（因为error级别高于info，根日志记录器也会处理）。

log4rs还支持许多其他高级功能，如动态配置更新、自定义日志级别等，可以根据具体项目的需求进行更深入的配置和使用。

总结

我的建议是从简单的env_logger开始。如果你需要更好监控你的项目，请切换到log4rs以获得更好的故障排除功能。