0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

基于Rust的Log日志库介绍

科技绿洲 来源:TinyZ 作者:TinyZ 2023-09-19 14:49 次阅读

Rust是一门系统级编程语言,因其安全性、高性能和并发性而备受欢迎。在Rust应用程序中,日志记录是一项非常重要的任务,因为它可以帮助开发人员了解应用程序的运行情况并解决问题。Rust的Log库提供了一种简单的方法来实现日志记录,本文将介绍如何使用Rust的Log库作为日志门面,并结合env_logger和log4rs两个日志库的实战用例进行深入探讨。

Rust的Log库

Rust的Log库是一个轻量级的日志记录框架,它提供了一个简单的API,可以方便地记录日志。Log库允许您将日志消息发送到控制台、文件或任何其他自定义目标。Log库还提供了一些有用的功能,如日志级别、日志过滤器和日志格式化。

类似于Java语言中的Slf4j日志库,可以零开销的帮助开发者切换底层依赖的日志库实现。

引入Log库依赖

在本系列教程的Cargo篇,我们提到了管理依赖,我们就引入过log库,这里回顾一下。在Cargo.toml文件中添加以下依赖项, 引入Rust的Log库依赖,具体配置如下:

[dependencies]
log = "0.4.0"
##    引入env_logger库
env_logger = "0.9.0"

使用Log库

在使用Rust的Log库之前,您需要初始化日志记录系统。这可以通过调用 log::set_logger() 函数来完成,该函数将日志记录器注册到全局日志记录器中。 下面是通过简单的示例:

use log::{info, LevelFilter};
use std::io::Write;

fn main() {
    //    使用env_logger日志库,详细的时候后续会深入讲解
    env_logger::init();

    log::set_logger(&LOGGER).unwrap();
    log::set_max_level(LevelFilter::Info);

    info!("Hello, world!");
}

在这个示例中,我们使用了 env_logger 库来初始化日志记录系统。 env_logger 库是一个流行的Rust日志记录库,它提供了一个简单的方法来配置日志记录器。在这个示例中,我们将日志记录器注册到全局日志记录器中,并设置日志级别为 info 。最后,我们使用 info!() 宏来记录日志消息。

日志级别

Rust的Log库提供了五个日志级别,从最高到最低分别是:

  • Error
  • Warn
  • Info
  • Debug
  • Trace

默认情况下,Log库将记录所有级别的日志消息。您可以通过调用 log::set_max_level() 函数来设置日志级别的阈值。例如,如果您只想记录 warn 级别及以上的日志消息,可以使用以下代码:

log::set_max_level(LevelFilter::Warn);

日志过滤器

Rust的Log库还提供了一种过滤器机制,可以根据日志记录器的名称和日志级别来过滤日志消息。过滤器可以通过调用 log::set_logger() 函数时传递给日志记录器。例如,如果您只想记录名为 myapp::database 的记录器的 info 级别及以上的日志消息,可以使用以下代码:

use log::{info, LevelFilter};
use std::io::Write;

fn main() {
    env_logger::init();

    let filter = log::FilterBuilder::new()
        .target("myapp::database")
        .level(LevelFilter::Info)
        .build();

    log::set_logger(&LOGGER).unwrap();
    log::set_max_level(LevelFilter::Info);

    info!("Hello, world!");
}

在这个示例中,我们使用了 log::FilterBuilder 来创建一个过滤器,该过滤器将仅记录名为 myapp::database 的记录器的 info 级别及以上的日志消息。

日志格式化

Rust的Log库允许您自定义日志消息的格式。默认情况下,Log库将使用 {level} {message} 格式化日志消息。您可以通过调用 log::set_logger() 函数时传递一个自定义的格式字符串来自定义日志消息的格式。例如,以下代码将使用自定义的格式字符串来格式化日志消息:

use log::{info, LevelFilter};
use std::io::Write;

fn main() {
    env_logger::init();

    let format = log::FormatBuilder::new()
        .format(|buf, record| {
            writeln!(buf, "{} [{}] - {}", chrono::Local::now().format("%Y-%m-%d %H:%M:%S"), record.level(), record.args())
        })
        .build();

    log::set_logger(&LOGGER).unwrap();
    log::set_max_level(LevelFilter::Info);

    info!("Hello, world!");
}

在这个示例中,我们使用了 log::FormatBuilder 来创建一个自定义的格式化程序,该程序将在日志消息中包含时间戳。我们将自定义的格式化程序传递给 log::set_logger() 函数,以便在记录日志消息时使用它。

log4rs库

log4rs是一个强大的日志记录库,它提供了许多高级功能,如多个日志记录器、多个输出目标和灵活的日志过滤器。log4rs库是基于Rust的Log库构建的,因此您可以使用Rust的Log库的所有功能以及log4rs库的高级功能。

ps:假如你曾经接触过log4j, 那么你会发现log4rs很多概念和设计都和log4j相似。

引入log4rs依赖

要使用log4rs库,您需要在Cargo.toml文件中添加以下依赖项:

[dependencies]
log4rs = "1.2.0"

配置yaml

log4rs库使用YAML或JSON格式的配置文件来配置日志记录器。以下是一个简单的log4rs配置文件示例:

refresh_rate: 30 seconds

appenders:
  stdout:
    kind: console
    encoder:
      pattern: "{d} [{l}] - {m}n"
  file:
    kind: file
    path: "logs/myapp.log"
    encoder:
      pattern: "{d} [{l}] - {m}n"

root:
  level: info
  appenders:
    - stdout
    - file

loggers:
  myapp::database:
    level: info
    appenders:
      - file

在这个示例中,我们定义了两个输出目标:一个是控制台,另一个是文件。我们还定义了一个名为 myapp::database 的记录器,它将日志消息发送到文件输出目标。最后,我们将根记录器配置为将日志消息发送到控制台和文件输出目标。

使用log4rs库

要使用log4rs库,您需要在应用程序中初始化日志记录器。以下是一个简单的示例:

use log::{info, LevelFilter};
use log4rs::config::{Config, ConfigHandle};

fn main() {
    let config: Config = log4rs::load_config_file("log4rs.yaml", Default::default()).unwrap();
    let handle: ConfigHandle = log4rs::init_config(config).unwrap();

    info!("Hello, world!");
}

在这个示例中,我们使用 log4rs::load_config_file() 函数从文件中加载配置文件。然后,我们使用 log4rs::init_config() 函数初始化日志记录器。最后,我们使用 info!() 宏来记录日志消息。

log4rs日志过滤器

log4rs库提供了灵活的过滤器机制,可以根据记录器的名称、级别和其他属性来过滤日志消息。以下是一个示例配置文件,其中定义了一个过滤器,该过滤器将仅记录名为 myapp::database 的记录器的 info 级别及以上的日志消息:

appenders:
  stdout:
    kind: console
    encoder:
      pattern: "{d} [{l}] - {m}n"
  file:
    kind: file
    path: "logs/myapp.log"
    encoder:
      pattern: "{d} [{l}] - {m}n"

root:
  level: info
  appenders:
    - stdout
    - file

loggers:
  myapp::database:
    level: info
    appenders:
      - file
    filters:
      - kind: threshold
        level: info

在这个示例中,我们定义了一个过滤器,该过滤器将仅记录名为 myapp::database 的记录器的 info 级别及以上的日志消息。

log4rs日志格式化

log4rs库允许您自定义日志消息的格式。您可以通过在配置文件中设置输出目标的 encoder.pattern 属性来自定义日志消息的格式。例如,以下配置将使用自定义的格式字符串来格式化日志消息:

appenders:
  stdout:
    kind: console
    encoder:
      pattern: "{d} [{l}] - {m}n"
  file:
    kind: file
    path: "logs/myapp.log"
    encoder:
      pattern: "{d} [{l}] - {m}n"

在这个示例中,我们在输出目标的 encoder.pattern 属性中使用了自定义的格式字符串。

扩展阅读 - tracing

一般来说,env_logger和log4rs已经能够满足绝大部门开发者的日志需求。但是在分布式应用,异步编程领域,log4rs输出的日志由于没有上下文环境信息,异步错落的日志输出,让我们排查问题变得很痛苦,这种情况下,log4rs就显得不太够专业了,而tracing恰恰就有了用武之地。

不过鉴于tracing日志库是一个非常庞杂的日志库,要讲透整个知识点需要先掌握分布式日志,链路追踪等等一些列的基础知识,所以博主先在这里提一句,挖个坑,后续针对tracing专门开一篇教程讲解。

总结

Rust的Log库和log4rs库都是非常有用的日志记录库,它们提供了许多功能,可以帮助开发人员了解应用程序的运行情况并解决问题。Rust的Log库是一个轻量级的日志记录框架,它提供了一个简单的API,可以方便地记录日志。Log库允许您将日志消息发送到控制台、文件或任何其他自定义目标。Log库还提供了一些有用的功能,如日志级别、日志过滤器和日志格式化。log4rs库是一个强大的日志记录库,它提供了许多高级功能,如多个日志记录器、多个输出目标和灵活的日志过滤器。log4rs库是基于Rust的Log库构建的,因此您可以使用Rust的Log库的所有功能以及log4rs库的高级功能。

使用Rust的Log库和log4rs库可以帮助您更好地了解应用程序的运行情况,更快地解决问题,并提高应用程序的可靠性和可维护性。

声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • 编程语言
    +关注

    关注

    10

    文章

    1938

    浏览量

    34593
  • 应用程序
    +关注

    关注

    37

    文章

    3240

    浏览量

    57596
  • 日志
    +关注

    关注

    0

    文章

    138

    浏览量

    10632
  • Rust
    +关注

    关注

    1

    文章

    228

    浏览量

    6570
收藏 人收藏

    评论

    相关推荐

    如何使用Rust的标准和structopt来处理控制台参数

    Rust是一种安全、高效的系统编程语言,其标准以及外部提供了很多处理控制台参数的方式。在本篇文章中,我们将分别介绍如何使用Rust的标准
    的头像 发表于 09-20 11:13 1260次阅读

    logcat如何查看Andriod log系统日志

    logcat会输出系统哪些信息呢?如何学习logcat命令?logcat如何查看Andriod log系统日志?如何查看Andriod log系统日志
    发表于 03-03 06:15

    Rust代码中加载静态时,出现错误 ` rust-lld: error: undefined symbol: malloc `怎么解决?

    “ [i]malloc ”、“ [i]exit ”。我验证了使用 ` [i]nm ` 命令。 问题是我打算使用 ffi 在 rust 中使用这个静态。当我尝试在我的 Rust 代码中加载静态
    发表于 06-09 08:44

    推荐3个非常不错的开源日志

    除了常用的log4c,log4cpp,下面给大家推荐3个非常不错的开源日志,比较适合用在单片机的项目中。从开始的轻量,到后面的功能丰富,最后一个很强大,所以请耐心看到最后。
    的头像 发表于 05-12 14:51 5050次阅读

    详解MySQL三大日志的作用

    MySQL日志 主要包括错误日志、查询日志、慢查询日志、事务日志、二进制日志几大类。其中,比较重
    的头像 发表于 07-22 14:44 1307次阅读

    log4j日志框架分析

    og4j是Apache下的一款开源的日志框架,能够满足我们在项目中对于日志记录的需求。log4j提供了简单的API调用,强大的日志格式定义以及灵活的扩展性。使用者可以自己定义Appen
    的头像 发表于 02-28 14:32 1086次阅读
    <b class='flag-5'>log</b>4j<b class='flag-5'>日志</b>框架分析

    针对大量log日志快速定位错误地方

    用 grep 拿到的日志很少,我们需要查看附近的日志。我是这样做的,首先: cat -n test.log | grep “关键词” 得到关键日志的行号
    的头像 发表于 04-21 09:22 677次阅读

    C#上位机开发(十三)之使用Log4net添加日志记录功能

    一、Log4net 官方网站: 。 下载二进制dll:包中提供了针对各个版本的dll: 二、使用日志 1. 添加
    发表于 05-29 16:25 1次下载
    C#上位机开发(十三)之使用<b class='flag-5'>Log</b>4net添加<b class='flag-5'>日志</b>记录功能

    服务器log日志大,掌握这些可正确快速定位错误!

    针对大量log日志快速定位错误地方
    的头像 发表于 06-05 18:14 609次阅读

    MySQL三种日志讲解

    MySQL 日志包含了错误日志、查询日志、慢查询日志、事务日志、二进制日志等,如果存储引擎使用的
    的头像 发表于 07-25 11:15 716次阅读
    MySQL三种<b class='flag-5'>日志</b>讲解

    Log4cpp优势及优点

    1、log4cpp概述 Log4cpp是一个开源的C++类,它提供了C++程序中使用日志和跟踪调试的功能,它的优点如下: 提供应用程序运行上下文,方便跟踪调试; 可扩展的、多种方式记
    的头像 发表于 11-09 14:27 673次阅读
    <b class='flag-5'>Log</b>4cpp优势及优点

    Android开发中的日志接口介绍

    1、日志接口 日志接口内容,共分为java层、native层、kernel层等。下面就对每个层级的内容分别进行介绍。 1.1 java层调用接口 日志级别分别为VERBOSE、DEBU
    的头像 发表于 11-23 16:27 1047次阅读
    Android开发中的<b class='flag-5'>日志</b>接口<b class='flag-5'>介绍</b>

    聊聊日志即数据

    《数据故障恢复机制的前世今生》[1]一文中介绍过,由于磁盘的的顺序访问性能远好于随机访问,数据设计中通常都会采用WAL的方式,将随机访问的数据请求转换为顺序的
    的头像 发表于 12-06 09:30 674次阅读
    聊聊<b class='flag-5'>日志</b>即数据<b class='flag-5'>库</b>

    oracle数据alert日志作用

    Oracle数据的alert日志是数据引擎和实例的核心组件之一,它记录着数据的运行状况和事件。该日志对于数据
    的头像 发表于 12-06 10:08 1194次阅读

    nginx日志配置方法

    access_log用来定义日志级别,日志位置。
    的头像 发表于 10-24 17:43 194次阅读