C/CPP的日志工具也很多,在之前的项目中用过的有以下几个:zlog、spdlog、log4cpp等。
zlog之前也介绍过,这个日志工具我在使用的时候遇到过2个问题:
1.多线程输出比较频繁的时候,切换文件时程序会挂掉;
2.有的平台下面,切换文件时,程序挂掉再无法启动,只能手动删除日志文件,或者不让日志输出到文件;
zlog使用是挺方便,也很快,就是有上面两个问题,所以后来考虑换掉。
spdlog之前也介绍过。这个也挺好用,只需要包含头文件即可,只是这个日志依赖于c++11,有些编译器比较老,不支持,c语言也无法使用。
今天要介绍的这个日志是easylogger,这个是c语言的版本,所以c/c++都可以用,这个日志官方提供的demo和文档比较全,我就不再多说了。
log4cpp的输出方式不太喜欢……
主要是对其源文件的使用做个调整。将对其源码引用的操作单独做了一个Makefile,这样使用的时候只需要在项目代码的Makefile里引用一下它的
Makefile即可:demo 的结构如下:
.
├── easylogger
│ ├── easylogger ---- 移植修改文件
│ │ ├── inc
│ │ └── port
│ └── source_code ----- 源码目录
│ ├── inc
│ ├── obj
│ ├── plugins
│ │ ├── file
│ │ └── flash
│ ├── port
│ └── src
├── main.c-bak --- 测试主函数代码
├── main.cpp --- 同main.c-bake
├── Makefile --- 测试代码Makefile(这个也是一个通用的Makefile)
├── Makefile.log --- 源码配置Makefile
└── out
这里将日志的相关文件与头文件路径在Makefile.log里封装好了,该目录下的Makefile为新增的Makefile,在这个Makefile里调用日志源码的Makefile.log,并添加目标文件,这样使用起来比较简单:
include ./Makefile.log #包含源码文件的makefile
OBJS+=$(LOG_OBJ) #添加目标文件
执行make:
g++ -I./easylogger/easylogger/inc -I./easylogger/source_code/inc -I./easylogger/source_code/plugins/file -O0 -g3 -Wall -Wall -I. -c main.cpp -o out/main.o
main.cpp: In function ‘void test_elog()’:
main.cpp:80:19: warning: comparison between signed and unsigned integer expressions [-Wsign-compare]
for (i = 0; i < sizeof(buf); i++)
^
gcc -I./easylogger/easylogger/inc -I./easylogger/source_code/inc -I./easylogger/source_code/plugins/file -O0 -g3 -Wall -Wall -I. -c -o easylogger/source_code/src/elog_utils.o easylogger/source_code/src/elog_utils.c
gcc -I./easylogger/easylogger/inc -I./easylogger/source_code/inc -I./easylogger/source_code/plugins/file -O0 -g3 -Wall -Wall -I. -c -o easylogger/source_code/src/elog.o easylogger/source_code/src/elog.c
gcc -I./easylogger/easylogger/inc -I./easylogger/source_code/inc -I./easylogger/source_code/plugins/file -O0 -g3 -Wall -Wall -I. -c -o easylogger/source_code/src/elog_buf.o easylogger/source_code/src/elog_buf.c
gcc -I./easylogger/easylogger/inc -I./easylogger/source_code/inc -I./easylogger/source_code/plugins/file -O0 -g3 -Wall -Wall -I. -c -o easylogger/source_code/src/elog_async.o easylogger/source_code/src/elog_async.c
gcc -I./easylogger/easylogger/inc -I./easylogger/source_code/inc -I./easylogger/source_code/plugins/file -O0 -g3 -Wall -Wall -I. -c -o easylogger/source_code/plugins/file/elog_file.o easylogger/source_code/plugins/file/elog_file.c
gcc -I./easylogger/easylogger/inc -I./easylogger/source_code/inc -I./easylogger/source_code/plugins/file -O0 -g3 -Wall -Wall -I. -c -o easylogger/easylogger/port/elog_file_port.o easylogger/easylogger/port/elog_file_port.c
gcc -I./easylogger/easylogger/inc -I./easylogger/source_code/inc -I./easylogger/source_code/plugins/file -O0 -g3 -Wall -Wall -I. -c -o easylogger/easylogger/port/elog_port.o easylogger/easylogger/port/elog_port.c
g++ ./out/main.o ./easylogger/source_code/src/elog_utils.o ./easylogger/source_code/src/elog.o ./easylogger/source_code/src/elog_buf.o ./easylogger/source_code/src/elog_async.o ./easylogger/source_code/plugins/file/elog_file.o ./easylogger/easylogger/port/elog_file_port.o ./easylogger/easylogger/port/elog_port.o -o test -I./easylogger/easylogger/inc -I./easylogger/source_code/inc -I./easylogger/source_code/plugins/file -O0 -g3 -Wall -Wall -I. -lpthread
strip test
可执行文件名称为test:
日志的输出效果还是挺好的,对于数组可以直接用十六进制的形式输出出来,调试也很方便。
EasyLogger 是一款超轻量级(ROM<1.6K, RAM<0.3K)、高性能的 C/C++ 日志库,非常适合对资源敏感的软件项目,例如:IoT 产品、可穿戴设备、智能家居等等。相比 log4c、zlog 这些知名的 C/C++ 日志库, EasyLogger 的功能更加简单,提供给用户的接口更少,但上手会很快,更多实用功能支持以插件形式进行动态扩展。
名词解释:
后续我还会提供更多插件。也非常欢迎大家设计、开发更多实用插件和功能,一起来完善 EasyLogger (Github|OSChina|Coding) 。如果觉得这个开源项目很赞,可以点击项目主页 右上角的 Star ,同时把它推荐给更多有需要的朋友。
EasyLogger 拥有过滤方式、输出格式、输出开关这些属性。
注:目前参数配置及输出方式都是单例模式,即全局只支持一种配置方式。此模式下,软件会较为简单,但是无法支持复杂的输出方式。
参考 Android Logcat ,级别最高为 0(Assert) ,最低为 5(Verbose) 。
0.[A]:断言(Assert)
1.[E]:错误(Error)
2.[W]:警告(Warn)
3.[I]:信息(Info)
4.[D]:调试(Debug)
5.[V]:详细(Verbose)
各个级别日志默认颜色效果如下。用户也可以根据自己的喜好,在 elog_cfg.h
对各个级别日志的颜色及字体风格进行单独设置。
支持按照 级别、标签及关键词 进行过滤。日志内容较多时,使用过滤功能可以更快定位日志,保证日志的可读性。更多的过滤功能设置方法及细节请阅读\docs\zh\api\kernel.md
文档
注:RAW格式、hexdump 格式日志不支持标签、关键词过滤
输出格式支持:级别、时间、标签、进程信息、线程信息、文件路径、行号、方法名。每种优先级别可以独立设置输出格式。
通过用户的移植,可以支持任何一种输出方式。只不过对于某种输出方式可能引入的新功能,需要通过插件实现,例如:文件转存,检索Flash日志等等。后期会有更多的插件开源出来。下面简单对比下部分输出方式使用场景:
下图为在终端中输入命令来控制日志的输出及过滤器的设置,更加直观的展示了 EasyLogger 核心功能。
\demo\os\rt-thread\stm32f10x\
\docs\zh\api\kernel.md
\docs\zh\port\kernel.md
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-9Dfqk5E0-1614481257126)(https://raw.githubusercontent.com/armink/EasyLogger/master/docs/zh/images/EasyLoggerDemo.gif)]
下图过程为通过控制台输出日志,并将输出的日志存储到 Flash 中。重启再读取上次保存的日志,最后清空 Flash 日志。
\demo\os\rt-thread\stm32f10x\
\docs\zh\api\flash.md
\docs\zh\port\flash.md
通过 FIle 插件,可以将日志自动保存至文件中。每个文件可以设定大小,超过规定大小后,自动新建新的文件来存储日志。
具体内容参考\docs\zh\
下的文件。务必保证在 阅读文档 后再移植使用。
MIT Copyright (c) armink.ztl@gmail.com
这个源码是我调整后的: https://gitee.com/fensnote/EasyLogger.