【 声明:版权全部,欢迎转载。请勿用于商业用途。
联系信箱:armink.ztl@gmail.com】
EasyLogger
1. 介绍
EasyLogger 是一款超轻量级(ROM<1.6K, RAM<0.3K)、高性能的 C/C++ 日志库,非常适合对资源敏感的软件项目,比如: IoT 产品、可穿戴设备、智能家居等等。相比 log4c、zlog 这些知名的 C/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 ,同一时候把它推荐给很多其它有须要的朋友。
2. 使用
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.2.1 输出缤纷多彩的日志
各个级别日志默认颜色效果例如以下。用户也能够依据自己的喜好。在 elog_cfg.h
对各个级别日志的颜色及字体风格进行单独设置。
2.3 输出过滤
支持依照 级别、标签及关键词 进行过滤。
日志内容较多时,使用过滤功能能够更快定位日志。保证日志的可读性。
很多其它的过滤功能设置方法及细节请阅读docszhapikernel.md
文档
2.4 输出格式
输出格式支持:级别、时间、标签、进程信息、线程信息、文件路径、行号、方法名。
每种优先级别能够独立设置输出格式。
注:默觉得 RAW格式,RAW格式日志不支持标签过滤
2.5 输出方式
通过用户的移植,能够支持不论什么一种输出方式。仅仅只是对于某种输出方式可能引入的新功能。须要通过插件实现,比如:文件转存。检索Flash日志等等。
后期会有很多其它的插件开源出来。以下简单对照下部分输出方式使用场景:
- 终端:方便用户动态查看。不具有存储功能。
- 文件与Flash:都具有存储功能,用户能够查看历史日志。
可是文件方式须要文件系统的支持。而Flash方式更加适合应用在无文件系统的小型嵌入式设备中。
2.6 Demo
2.6.1 核心功能
下图为在终端中输入命令来控制日志的输出及过滤器的设置,更加直观的展示了 EasyLogger 核心功能。
- Demo 路径:
demoos t-threadstm32f10x
- API 文档:
docszhapikernel.md
- 移植文档:
docszhportkernel.md
2.6.2 Flash Log(将日志保存到 Flash 中)
下图过程为通过控制台输出日志。并将输出的日志存储到 Flash 中。重新启动再读取上次保存的日志,最后清空 Flash 日志。
- Demo 路径:
demoos t-threadstm32f10x
- API 文档:
docszhapiflash.md
- 移植文档:
docszhportflash.md
3. 文档
具体内容參考docszh
下的文件。务必保证在 阅读文档 后再移植使用。
4. 后期
- 1、
Flash存储:在EasyFlash中添加日志存储、读取功能。让EasyLogger与其无缝对接。使日志能够更加容易的存储在 非文件系统 中,并具有历史日检索的功能。 - 2、配置文件:文件系统下的配置文件;
- 3、文件转档:文件系统下支持文件按容量转档,按时间区分。
- 4、日志助手:开发跨平台的日志助手。兼容Linux、Windows、Mac系统。打开助手就可以查看、过滤(支持正則表達式)、排序、保存日志等。前端:HTML5 + Bootstrap + AngularJS + NW.js,后端:Rust + iron + rust-websocket + serial-rs。
- 5、
异步输出:眼下日志输出与用户代码之间是同步的方式,这样的方式尽管软件简单,也不存在日志覆盖的问题。但在输出速度较低的平台下,会因为添加日志功能,而减少软件执行速度。所以后期会添加 异步输出 方式,keyword过滤也能够放到异步输出中去。
- 6、Arduino:添加Arduino lib。并提供其Demo;
5. 许可
MIT Copyright (c) armink.ztl@gmail.com