EasyLogger

超轻量级、高性能 C/C++ 日志库
授权协议 MIT
开发语言 C/C++
所属分类 程序开发、 日志工具(Logging)
软件类型 开源软件
地区 国产
投 递 者 西门京
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

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(正在开发):支持文件转档、软件运行时动态加载配置文件等与文件日志输出相关功能。

  • 敬请期待……

1.3 Star & Fork

后续我还会提供更多插件。也非常欢迎大家设计、开发更多实用插件和功能,一起来完善EasyLogger (Github|OSChina) 。如果觉得这个开源项目很赞,可以点击项目主页右上角的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 对各个级别日志的颜色及字体风格进行单独设置。

TextColor

2.3 输出过滤

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

2.4 输出格式

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

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

2.5 输出方式

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

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

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

2.6 Demo

2.6.1 核心功能

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

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

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

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

 

2.6.2 Flash Log(将日志保存到Flash中)

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

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

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

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

更多WindowsLinux等平台的Demo,都位于\demo文件夹下。

3、文档

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

4、后期

  • 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;

5、许可

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

  • 开源嵌入式代码分析——EasyLogger 本文不提供移植使用说明,只进行代码分析 简介 EasyLogger是对智能<1.6K, RAM<0.3K等级别(ROM<1.6K, RAM<0.3K)、资源库的C/C++日志,非常适合敏感的软件项目,例如:IoT产品、可穿戴设备、家居相比 log4c、zlog 知名的 C/C++ 库,EasyLogger 的功能简单,提供给用户的插件接口更多的接口,但以

  • 1. 超轻量级、高性能C日志库--EasyLogger  2. EasyLogger/kernel.md at master · armink/EasyLogger (github.com) 3. EasyLogger/kernel.md at master · armink/EasyLogger (github.com)。 4. elog_cfg.h 应该是项目的配置文件 5. 【开源解读】一款

  • easy_port.c 修改 void elog_port_output(const char *log, size_t size) { /* output to terminal */ usart1_printf("%.*s", size, log);//加入代码 //TODO output to flash } //usart1 代码实现 #include "strin

  • int main(void) { /* close printf buffer */ setbuf(stdout, NULL); /* initialize EasyLogger */ elog_init(); /* set EasyLogger log format */ elog_set_fmt(ELOG_LVL_ASSERT, ELOG_FMT

 相关资料
  • 属性是类、结构体和接口的命名成员。类或结构体中的成员变量或方法称为域。属性是域的扩展,且可使用相同的语法来访问。它们使用访问器让私有域的值可被读写或操作。 属性不会确定存储位置。相反,它们具有可读写或计算它们值的访问器。 例如,有一个名为 Student 的类,带有 age、name 和 code 的私有域。我们不能在类的范围以外直接访问这些域,但是我们可以拥有访问这些私有域的属性。 访问器 属性

  • 特性(Attribute)是用于在运行时传递程序中各种元素(比如类、方法、结构、枚举、组件等)的行为信息的声明性标签。您可以通过使用特性向程序添加声明性信息。一个声明性标签是通过放置在它所应用的元素前面的方括号([ ])来描述的。 特性(Attribute)用于添加元数据,如编译器指令和注释、描述、方法、类等其他信息。.Net 框架提供了两种类型的特性:预定义特性和自定义特性。 列举特性 列举特性

  • 特性 反射 属性 索引器 委托 事件 集合 泛型 匿名方法 不安全代码 多线程

  • 我正在尝试锁定Mifare超轻C标签。我想将 NDEF 页面0x04设置为只读0x27。我认为这可以通过来实现。 此外,我想将页面0x29设置为密码保护(用于读取和写入),以便它们只能在身份验证成功后访问。我很难理解需要在锁定字节中设置哪些字节(第0x28页,字节0,1),以及是否需要设置扇区0x2A和0x2B。

  • 我写了一段C代码来展示关于优化和分支预测的讨论中的一个观点。然后我注意到比我预期的更多样化的结果。我的目标是用C和C之间的通用子集编写它,这两种语言都符合标准,并且相当可移植。它在不同的Windows PC上进行了测试: 用VS2010编制/英特尔酷睿2、WinXP的O2优化结果: 编辑:编译器的完整开关: /Zi/no logo/W3/WX-/O2/Oi/Oy-/GL/D " WIN32 "/D

  • 泛型允许推迟类或方法中编程元素的数据类型规范的编写,直到实际在程序中使用它的时候再编写。换句话说,泛型允许编写一个可以与任何数据类型协作的类或方法。 你可以通过数据类型的替代参数来编写类或方法的规范。当编译器遇到类的构造函数或方法的函数调用时,它会生成代码来处理指定的数据类型。下面这个简单的示例将有助于理解这个概念: using System; using System.Collections.G

  • 集合类专门用于数据存储和数据检索,并提供堆栈、队列、列表和哈希表的支持。目前,大多数集合类都实现了相同的接口。 集合类服务于不同的目的,如为元素动态分配内存,基于索引访问列表项等等,这些类所创建的是 Object 类的对象的集合。在 C# 中,Object 类是所有数据类型的基类。 各种集合类及其用法 下表为一些常用的以 System.Collection 为命名空间的集合类,点击相应链接,可查看

  • 事件指一个用户操作,如按键、点击、移动鼠标等,也可以是系统生成的通知。当事件发生时,应用需要对其作出相应的反应,如中断。另外,事件也用于内部进程通信。 通过事件使用委托 事件生成于类的声明中,通过使用同一个类或其他类中的委托与事件处理程序关联。包含事件的类用于发布事件,称为发布器类。其他接受该事件的类称为订阅器类。事件使用的是发布-订阅(publisher-subscriber)模型。 发布器是一