在开发程序的时候,经常会需要使用「Log」或是「Console」等类别输出某些文字消息来告诉系统管理员程序运行的状况。当程序作为背景服务来运行的时候,通常会将这些 Log 消息写进文件系统内,方便日后查阅。然而,保存在文件系统中的每则文字消息虽然可能只是短短的几行字,但累积久了也是会占用不少硬盘空间,如果没有定期整理的话,可能哪天系统的可用空间就被历史纪录塞满,而导致当机。为了避免程序输出的消息塞满硬盘空间,除了可以使用先前介绍过的 Pipe Logger 外,还可以直接引入 Pipe Logger 的函数库,直接在同一支程序内处理 Log 消息。
Pipe Logger Lib
「Pipe Logger Lib」是笔者开发的套件,即 Pipe Logger 所使用的函数库,可以限制 Log 消息的保存量,也可以自动对保存下来的 Log 档进行轮替(rotate)和压缩封存的动作。
Crates.io
Cargo.toml
使用方法
pipe_logger_lib 这个 crate 下提供了 PipeLoggerBuilder 结构体,可以用来创建特定功能的 PipeLogger 结构实体。
举例来说,以下程序可以创建出一个 PipeLogger 结构实体,它能将 Log 消息输出到标准输出(stdout)和 mylog.txt 文件内,当文件大小超过 30 个字节的时候就会进行「轮替」,被轮替的 Log 档会使用 XZ 来压缩封存,且这些 Log 文件的数量不超过 10 个。
use pipe_logger_lib::*;
let log_file = Path::new("mylog.txt");
let mut builder = PipeLoggerBuilder::new(log_file);
builder
.set_tee(Some(Tee::Stdout))
.set_rotate(Some(RotateMethod::FileSize(30))) // bytes
.set_count(Some(10))
.set_compress(true);
let mut logger = builder.build().unwrap();
PipeLogger 结构实体提供了 write 和 write_line 方法,可以对 Log 档进行写入的动作,同时也可以将 Log 消息输出至标准输出或是标准错误(stderr)中。
logger.write_line("Hello world!").unwrap();
logger.write_line("Other logs...").unwrap();
logger.write("End").unwrap();
