首页 > 其他 > 详细

C开源日志库EasyLogger移植和封装使用

时间:2020-04-08 21:44:17      阅读:567      评论:0      收藏:0      [点我收藏+]

1、写在最前:

    开源日志库EasyLogger使用c语言编写,及其简便和通用,感谢EasyLogger作者armink的贡献。

2、代码地址:

    github地址:https://github.com/armink/EasyLogger

      gitee地址:  https://gitee.com/armink/EasyLogger

3、许可

    MIT Copyright (c) armink.ztl@gmail.com

4、介绍:

    EasyLogger 是一款超轻量级(ROM<1.6K, RAM<0.3K)、高性能的C日志库,非常适合对资源敏感的软件项目,例如:IoT产品、可穿戴设备、智能家居等等。相比log4c、zlog这些知名的C日志库,EasyLogger的功能更加简单,提供给用户的接口更少,但上手会很快,更多实用功能支持以插件形式进行动态扩展。

5、主要特性

  • 支持用户自定义输出方式(例如:终端、文件、数据库、串口、485、Flash...);

  • 日志内容可包含级别、时间戳、线程信息、进程信息等;

  • 日志输出被设计为线程安全的方式;

  • 支持多种操作系统(RT-Thread、UCOS、Linux、Windows...),也支持裸机平台;

  • 日志支持RAW格式;

  • 支持按标签、级别 、关键词进行动态过滤;

  • 各级别日志支持不同颜色显示;

  • 扩展性强,支持以插件形式扩展新功能。

<注>名词解释:
1、RAW格式:未经过格式化的原始日志。
2、标签:在软件中可以按照文件、模块、功能等方面,对需要打印的日志设定标签,实现日志分类。

6、插件

 

  • 1、Flash:使用EasyFlash库提供的Flash操作接口,可以把日志直接存储在Flash中。

  • 2、File:支持文件转档、软件运行时动态加载配置文件等与文件日志输出相关功能。

 

7、参数配置

 

EasyLogger拥有过滤方式、输出格式、输出开关这些属性。

 

  • 过滤方式支持按照标签、级别、关键词进行过滤;

  • 可以动态的开启/关闭日志的输出;

  • 可设定动态和静态的输出级别(静态:一级开关,通过宏定义;动态:二级开关,通过API接口)

8、输出级别

参考Android Logcat,级别最高为0(Assert),最低为5(Verbose)。

0.[A]:断言(Assert)
1.[E]:错误(Error)
2.[W]:警告(Warn)
3.[I]:信息(Info)
4.[D]:调试(Debug)
5.[V]:详细(Verbose)

8.1 各个级别日志默认颜色效果如下。用户也可以根据自己的喜好,在 elog_cfg.h 对各个级别日志的颜色及字体风格进行单独设置。

技术分享图片

8.2输出过滤

支持按照级别、标签及关键词进行过滤。日志内容较多时,使用过滤功能可以更快定位日志,保证日志的可读性。更多的过滤功能设置方法及细节请阅读\docs\zh\api\kernel.md文档。

8.3 输出格式

输出格式支持:级别、时间、标签、进程信息、线程信息、文件路径、行号、方法名。每种优先级别可以独立设置输出格式。

注:默认为RAW格式,RAW格式日志不支持标签过滤

8.4 输出方式

通过用户的移植,可以支持任何一种输出方式。只不过对于某种输出方式可能引入的新功能,需要通过插件实现,例如:文件转存,检索Flash日志等等。后期会有更多的插件开源出来。下面简单对比下部分输出方式使用场景:

  • 终端:方便用户动态查看,不具有存储功能;

  • 文件与Flash:都具有存储功能,用户可以查看历史日志。但是文件方式需要文件系统的支持,而Flash方式更加适合应用在无文件系统的小型嵌入式设备中。

9、移植

  因为在linux下使用,所以直接进入EasyLogger\EasyLogger\demo\os\linux下测试即可

  • Demo路径:\demo\os\rt-thread\stm32f10x\

  • API文档:\docs\zh\api\kernel.md

  • 移植文档:\docs\zh\port\kernel.md

10、遇到的问题:

  1、文件和控制台的开关问题,可以整体开关,没有单一开关

  2、级别、过滤策略不能动态控制

  解决办法:创建全局flag,写一个配置文件,开一个线程处理,检查文件的状态,读取文件内容,文件中包含问题1和问题2中的参数。

11、接口说明:  

  API:    
            elog_set_filter(uint8_t level, const char *tag, const char *keyword);  //参数1:要过滤的级别,参数2:要过滤的标签,参数3:要过滤的关键字
            elog_set_filter_tag_lvl("test", ELOG_LVL_WARN);    //参数1:要过滤的标签(线程/进程名/模块名)。  参数2:对指定标签过滤,设置显示级别,低于此级别不再显示
            elog_set_filter_tag(const char *tag);               //参数1:要过滤的标签
            elog_set_filter_kw("EasyLogger");                  //参数1:要过滤的关键字,所有log中带有关键字的log才会显示
            elog_set_filter_lvl(ELOG_LVL_WARN);                   //参数1:要过滤的级别,低于此级别的log不显示
            elog_set_output_enabled(true);                       //参数1:开关,控制log是否打印的开关,全局的,包含文件和console

    elog_start();                                    //这里默认启动总开关,默认启动异步输出方式,默认启动缓冲输出方式
            elog_init();                                    //log初始化
            setbuf(stdout, NULL);                            //关闭 printf 缓冲机制
            elog_set_text_color_enabled(true);                //打开颜色选项
            elog_set_fmt(ELOG_LVL_ERROR, ELOG_FMT_LVL | ELOG_FMT_TAG | ELOG_FMT_TIME);    //设置不同级别所显示的格式,这里有一个枚举来控制
            elog_a("tag","Hello hahah");                    //每次需要传入tag
            log_a("hello");                                    //tag通过宏设置在头文件上面
         

  /* all formats index */
typedef enum {
    ELOG_FMT_LVL    = 1 << 0, /**< level */
    ELOG_FMT_TAG    = 1 << 1, /**< tag */
    ELOG_FMT_TIME   = 1 << 2, /**< current time */
    ELOG_FMT_P_INFO = 1 << 3, /**< process info */
    ELOG_FMT_T_INFO = 1 << 4, /**< thread info */
    ELOG_FMT_DIR    = 1 << 5, /**< file directory and name */
    ELOG_FMT_FUNC   = 1 << 6, /**< function name */
    ELOG_FMT_LINE   = 1 << 7, /**< line number */
} ElogFmtIndex;

12、规格,每行输出最长字符,ELOG_LINE_BUF_SIZE=512最大
      过滤标签最大长度,ELOG_FILTER_TAG_MAX_LEN=16
      过滤关键词最大长度,ELOG_FILTER_KW_MAX_LEN=16
      过滤器数目, 暂时仅支持一个

13、demo测试完毕后,移植到工程中封装自己的接口即可使用

C开源日志库EasyLogger移植和封装使用

原文:https://www.cnblogs.com/flying--fish/p/flying--fish.html

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!