zlog日志函数库使用方法简介

╰半夏微凉° 2023-02-26 05:28 16阅读 0赞

# 0x00 前言 #

文章中的文字可能存在语法错误以及标点错误，请谅解；

如果在文章中发现代码错误或其它问题请告知，感谢！

运行环境内核版本（`#cat /proc/version`）：  
Linux version 3.13.0-32-generic (buildd@kissel) (gcc version 4.8.2 (Ubuntu 4.8.2-19ubuntu1) ) \#57-Ubuntu SMP Tue Jul 15 03:51:08 UTC 2014

运行环境Linux版本（`#lsb_release -a`）：  
No LSB modules are available.  
Distributor ID: Ubuntu  
Description: Ubuntu 14.04.1 LTS  
Release: 14.04  
Codename: trusty

# 0x01zlog简介 #

根据官方文件，zlog是一个高性能、线程安全、灵活、概念清晰的纯C日志函数库。  
使用zlog来记录程序运行时产生的log日志的优势是**可以通过改变配置文件从而改变该log日志的格式或输出文件**，也就是我们可以根据需要，来决定日志的格式以及分类匹配，而不必通过改动程序代码。并且日志记录可以精确到微秒、不依赖其他任何库、每秒可以记录日志条数可达万条以上以及在程序运行时输出zlog自己的日志和配置状态等优点。  
但是zlog的编写的目标是成为“简而精的日志函数库”，所以对日志数据进行过滤以及网络输出或写入数据库方面支持不完善，可以看成记专门记录log日志功能的函数库。

# 0x02zlog实例演示 #

1.下载 ：[https://github.com/HardySimpson/zlog/releases][https_github.com_HardySimpson_zlog_releases]  
2.解压以及安装（以zlog-1.2.15为例）：

#tar -zxvf zlog-1.2.15.tar.gz
    #cd zlog-1.2.15/
    #make
    #make install

安装之后在zlog-1.2.15/src/下，会看到编译好的lib文件：libzlog.so、libzlog.so.1、libzlog.so.1.2：  
![在这里插入图片描述][20200714162117269.png]

3.代码及配置文件  
新建一个测试文件夹zlog\_test，新建zlogtest.c文件，将 libzlog.so、 libzlog.so.1 、libzlog.so.1.2、 zlog.h复制到该文件夹内，并新建zlog.conf 配置文件，对相应的文件赋予可执行权限：  
![在这里插入图片描述][20200714162517776.png]  
在zlogtest.c文件中输入代码：

#include <stdio.h>#include "zlog.h"
    
    int main(int argc, char** argv){ 
    	int rc;
    	zlog_category_t *zc;
    	char hex_buf[32];
    
    	rc = zlog_init("zlog.conf");	//指定配置文件路径，若当前文件夹直接写名字
    	if (rc) { 
    	printf("EEROR: zlog init failed\n");
    	return -1;
    	}
    
    	zc = zlog_get_category("my_cat");
    	if (!zc) { 
    	printf("EEROR: zlog get cat fail\n");
    	zlog_fini();
    	return -2;
    	}
    
    	zlog_debug(zc, "hello, zlog - debug");
    	zlog_info(zc, "hello, zlog - info");
    	zlog_notice(zc, "hello, zlog - notice");
    	zlog_warn(zc, "hello, zlog - warn");
    	zlog_error(zc, "hello, zlog - error");
    	zlog_fatal(zc, "hello, zlog - fatal");
    
    	for (int i = 0; i < sizeof(hex_buf); i++){ 
    		hex_buf[i] = i;
    	}
    	hzlog_debug(zc, hex_buf, sizeof(hex_buf));
    	
    	zlog_fini();
    	
    	return 0;
    }

zlog.conf配置文件：

[levels]
    
    
    [formats]
    time = "%d(%F %T).%ms [%-6V] %m%n"
    file = "%d(%F %T).%ms [%-6V] (%c:%F:%L) %m%n"
    
    [rules]
    my_cat.WARN >stdout;file
    my_cat.=NOTICE >stdout;time
    my_cat.=INFO >stdout;time
    my_cat.=DEBUG >stdout;time

4.编译运行  
/lib和/usr/lib/是动态链接库的默认搜索路径，若将libzlog.so、libzlog.so.1、libzlog.so.1.2移动到/usr/lib/下可以不指定搜索路径。若 zlog.h与so库文件存放在其他位置则在编译时需要指定文件路径或在命令行添加搜索路径，例如指定文件路径编译：`#gcc -o test zlogtest.c -I/usr/local/include -L/usr/local/lib -lzlog`。  
本例中将动态链接库放在了/home/dlri/Desktop/zlog\_test文件夹内，需要在命令行添加搜索路径：`#export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/home/dlri/Desktop/zlog_test`，另外 zlog.h头文件也放在当前文件夹内，所以直接输入编译指令`#gcc -o test zlogtest.c -lzlog`进行编译。

在命令行输入`#./test`执行程序：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdxaW5nY2h1YW45Mg_size_16_color_FFFFFF_t_70]  
zlog有6个默认的级别：“DEBUG”、“INFO”、“NOTICE”、“WARN”、“ERROR”和“FATAL”。所以配置文件中，my\_cat.WARN意味着任何大于等于WARN级别的日志会被输出，所以会看到ERROR以及FATAL输出，另外，配置文件中的级别是大小写不敏感的。若不想输出大于该级别的log日志则将my\_cat.WARN改为my\_cat.=WARN。

以上。

参考文档：  
1.[http://hardysimpson.github.io/zlog/UsersGuide-CN.html\#htoc1][http_hardysimpson.github.io_zlog_UsersGuide-CN.html_htoc1]  
2.[https://www.jianshu.com/p/e0c0a1279e2d][https_www.jianshu.com_p_e0c0a1279e2d]  
3.[https://www.jianshu.com/p/f3dc55702bfd][https_www.jianshu.com_p_f3dc55702bfd]  
4.GettingStart-CN

[https_github.com_HardySimpson_zlog_releases]: https://github.com/HardySimpson/zlog/releases
[20200714162117269.png]: /images/20230209/e5501a3d7b714c628e8d4dff12c6f888.png
[20200714162517776.png]: /images/20230209/f24dba04647f47a4b7740686c8e52ac5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdxaW5nY2h1YW45Mg_size_16_color_FFFFFF_t_70]: /images/20230209/72f7304f310e4f2fb1b6d737b9cd8003.png
[http_hardysimpson.github.io_zlog_UsersGuide-CN.html_htoc1]: http://hardysimpson.github.io/zlog/UsersGuide-CN.html#htoc1
[https_www.jianshu.com_p_e0c0a1279e2d]: https://www.jianshu.com/p/e0c0a1279e2d
[https_www.jianshu.com_p_f3dc55702bfd]: https://www.jianshu.com/p/f3dc55702bfd