Skip to content

xtaens/EasyLogger

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 Log:使用EasyFlash库提供的无缝接口,可以把日志直接存储在Flash中。

1.3 Star & Fork

后续我还会提供更多插件。也非常欢迎大家设计、开发更多实用插件和功能,一起来完善EasyLogger (Github|OSChina|Coding) ,同时把它推广给更多有需要的朋友。

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.3 输出过滤

2.3.1 过滤级别

默认过滤级别为5(详细),用户可以任意设置。在设置高优先级后,低优先级的日志将不会输出。例如:设置当前过滤的优先级为3(警告),则只会输出优先级别为警告、错误、断言的日志。

2.3.2 过滤标签

默认过滤标签为空字符串(""),即不过滤。当前输出日志的标签会与过滤标签做字符串匹配,日志的标签包含过滤标签,则该输出该日志。例如:设置过滤标签为WiFi,则系统中包含WiFi字样标签的(WiFi.BSP、WiFi.Protocol、Setting.WiFi)日志都会被输出。

2.3.3 过滤关键词

默认过滤关键词为空字符串(""),即不过滤。检索当前输出日志中是否包含该关键词,包含则允许输出。

注:对于配置较低的MCU建议不开启关键词过滤(默认为不过滤),增加关键字过滤将会在很大程度上减低日志的输出效率。实际上过滤关键词功能交给上位机做会更轻松,所以后期的跨平台日志助手开发完成后,就无需该功能。

2.4 输出格式

输出格式支持:级别、时间、标签、进程信息、线程信息、文件路径、行号、方法名

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

2.5 输出方式

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

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

2.6 Demo

2.6.1 核心功能

下图为在终端中输入命令来控制日志的输出及过滤器的设置,更加直观的展示了EasyLogger核心功能。

easylogger

注:以上内容对应的API,可以打开思维导图看到更清晰的逻辑。

2.6.2 Flash Log

下图过程为通过控制台输出日志,并将输出的日志存储到Flash中。重启再读取上次保存的日志,最后清空Flash日志。

FlashLog

3. 后期

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

4. 许可

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

About

A super-lightweight(ROM<1.6K, RAM<0.3k), high-performance C log library.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C 89.6%
  • Assembly 5.5%
  • HTML 3.9%
  • C++ 0.7%
  • Python 0.1%
  • Batchfile 0.1%
  • Objective-C 0.1%