雨润年华

电子DIY爱好者的家园

【开源】超轻量级C日志库--EasyLogger

EasyLogger 是一款超轻量级(ROM<1.6K, RAM<0.3K)、高性能的 C/C++ 日志库,非常适合对资源敏感的软件项目,例如: IoT 产品、可穿戴设备、智能家居等等。 EasyLogger 功能简单,上手速度快,更多实用功能支持以插件形式进行动态扩展。
主要特性
支持用户自定义输出方式(例如:终端、文件、数据库、串口、485、Flash...);
日志内容可包含级别、时间戳、线程信息、进程信息等;
日志输出被设计为线程安全的方式,并支持 异步输出 及 缓冲输出 模式;
支持多种操作系统(RT-Thread、UCOS、Linux、Windows...),也支持裸机平台;
日志支持 RAW格式 ;
支持按 标签 、 级别 、 关键词 进行动态过滤;
各级别日志支持不同颜色显示
扩展性强,支持以插件形式扩展新功能。

本次更新版本号 V1.11.13,主要发布以下重要功能:

1、新增彩色日志
所有级别日志可独立设置颜色,错误信息更加明显,日志更加赏心悦目,进一步提升调试效率。详细使用方法,请参照说明文档(点击查看)。Linux Demo 里已经默认开启了此功能,大致效果如下,欢迎试用

点击查看 在 xshell 上显示彩色串口日志的配置方法

2、新增异步输出模式(非阻塞输出模式)
之前的版本默认为阻塞的同步输出模式,即用户线程输出日志时,日志必须完全输出到输出介质(串口、网络、文件等)上,输出过程才会退回。
这样会影响应用软件执行时间及执行效率。开启异步输出模式后,后台有专门的日志线程负责完成日志输出功能,应用程序输出日志时,底层只将日志拷贝至缓冲区后,随即退出日志输出方法。

异步输出默认使用 POSIX pthread 实现,对于 Windows 、Liunx 、RT-Thread 及其他支持 POSIX pthread 的用户,只需开启异步输出相关配置,即可开启此功能。
对于缺少 pthread 支持的平台,例如:ucos ,也可以参考 elog_async.c 中关于异步输出线程的实现方式,自己动手实现。
PS:Linux Demo 中已开启 pthread 异步输出模式,RT-Thread Demo 已使用其线程相关 API 实现异步输出模式。

3、新增缓冲输出模式
开启缓冲输出模式后,如果缓冲区不满,用户线程在进行日志输出时,无需等待日志彻底输出完成,即可直接返回。
但当日志缓冲区满以后,将会占用当前用户线程,自动将缓冲区中的日志全部输出干净。
同时用户也可以在其他非用户线程,通过定时等机制使用 void elog_flush(void) 将缓冲区中的日志输出干净。

EasyLogger

  1. 介绍

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

1.1 主要特性
支持用户自定义输出方式(例如:终端、文件、数据库、串口、485、Flash...);
日志内容可包含级别、时间戳、线程信息、进程信息等;
日志输出被设计为线程安全的方式;
支持多种操作系统(RT-Thread、UCOS、Linux、Windows...),也支持裸机平台;
日志支持 RAW格式 ;
支持按 标签 、 级别 、 关键词 进行动态过滤;
扩展性强,支持以插件形式扩展新功能。

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

1.2 插件
1、Flash:使用EasyFlash库提供的Flash操作接口,可以把日志直接存储在Flash中。
2、File(正在开发):支持文件转档、软件运行时动态加载配置文件等与文件日志输出相关功能。
3、敬请期待……

1.3 Star & Fork
后续我还会提供更多插件。也非常欢迎大家设计、开发更多实用插件和功能,一起来完善EasyLogger(Github|OSChina|Coding) 。如果觉得这个开源项目很赞,可以点击项目主页 右上角的Star,同时把它推荐给更多有需要的朋友。

  1. 使用

2.1 参数配置
EasyLogger拥有过滤方式、输出格式、输出开关这些属性。
过滤方式支持按照标签、级别、关键词进行过滤;
可以动态的开启/关闭日志的输出;
可设定动态和静态的输出级别(静态:一级开关,通过宏定义;动态:二级开关,通过API接口)。

注:目前参数配置及输出方式都是单例模式,即全局只支持一种配置方式。此模式下,软件会较为简单,但是无法支持复杂的输出方式。

2.2 输出级别
参考Android Logcat,级别最高为0(Assert),最小为5(Verbose)。
0.[A]:断言(Assert)
1.[E]:错误(Error)
2.[W]:警告(Warn)
3.[I]:信息(Info)
4.[D]:调试(Debug)
5.[V]:详细(Verbose)
复制代码

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

2.4 输出格式
输出格式支持:级别、时间、标签、进程信息、线程信息、文件路径、行号、方法名。每种优先级别可以独立设置输出格式。
注:默认为 RAW格式,RAW格式日志不支持标签过滤

2.5 输出方式
通过用户的移植,可以支持任何一种输出方式。只不过对于某种输出方式可能引入的新功能,需要通过插件实现,例如:文件转存,检索Flash日志等等。后期会有更多的插件开源出来。下面简单对比下部分输出方式使用场景:
终端:方便用户动态查看,不具有存储功能;
文件与Flash:都具有存储功能,用户可以查看历史日志。但是文件方式需要文件系统的支持,而Flash方式更加适合应用在无文件系统的小型嵌入式设备中。

2.6 Demo

2.6.1 核心功能
下图为在终端中输入命令来控制日志的输出及过滤器的设置,更加直观的展示了EasyLogger核心功能。
Demo路径:demoosrt-threadstm32f10x\
API文档:docszhapikernel.md
移植文档:docszhportkernel.md

2.6.2 Flash Log(将日志保存到Flash中)
下图过程为通过控制台输出日志,并将输出的日志存储到Flash中。重启再读取上次保存的日志,最后清空Flash日志。
Demo路径:demoosrt-threadstm32f10x\
API文档:docszhapiflash.md
移植文档:docszhportflash.md

  1. 文档

具体内容参考docszh下的文件。务必保证在 阅读文档 后再移植使用。

  1. 后期

1、Flash存储(已完成):在EasyFlash中增加日志存储、读取功能,让EasyLogger与其无缝对接。使日志可以更加容易的存储在 非文件系统 中,并具有历史日检索的功能;
2、配置文件:文件系统下的配置文件;
3、文件转档:文件系统下支持文件按容量转档,按时间区分;
4、日志助手:开发跨平台的日志助手,兼容Linux、Windows、Mac系统,打开助手即可查看、过滤(支持正则表达式)、排序、保存日志等。前端:HTML5 + Bootstrap + AngularJS + NW.js,后端:Rust + iron + rust-websocket + serial-rs;
5、异步输出:目前日志输出与用户代码之间是同步的方式,这种方式虽然软件简单,也不存在日志覆盖的问题。但在输出速度较低的平台下,会由于增加日志功能,而降低软件运行速度。所以后期会增加 异步输出 方式,关键字过滤也可以放到异步输出中去;
6、Arduino:增加Arduino lib,并提供其Demo;

  1. 许可

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

  1. 下载

下载方式
最新版请关注 GitHub:https://github.com/armink/EasyLogger

本原创文章未经允许不得转载 | 当前页面:雨润年华 » 【开源】超轻量级C日志库--EasyLogger

评论