mirror of
https://github.com/armink/EasyLogger.git
synced 2025-01-31 13:32:52 +08:00
1、【更新】说明文档。
Signed-off-by: armink <armink.ztl@gmail.com>
This commit is contained in:
parent
297c9e0190
commit
112adccdb5
23
README.md
23
README.md
@ -4,16 +4,17 @@
|
||||
|
||||
# 1. 介绍
|
||||
|
||||
EasyLogger是一款超轻量级(ROM<1.6K, RAM<0.3k)、高性能的C日志库,非常适合对资源敏感的嵌入式软件。相比log4c、zlog这些知名的C日志库,EasyLogger的功能更加简单,提供给用户的接口更少,但上手会很快,更多实用功能支持以插件形式进行动态扩展,非常适合应用于小型的非嵌入式软件。
|
||||
EasyLogger是一款超轻量级(ROM<1.6K, RAM<0.3k)、高性能的C日志库,非常适合对资源敏感的软件项目,例如:IoT产品、可穿戴设备、智能家居等等。相比log4c、zlog这些知名的C日志库,EasyLogger的功能更加简单,提供给用户的接口更少,但上手会很快,更多实用功能支持以插件形式进行动态扩展。
|
||||
|
||||
## 1.1 主要特性
|
||||
|
||||
- 支持用户自定义输出方式(例如: 终端、文件、串口、485、Flash...);
|
||||
- 日志内容可包含级别、时间戳、线程、进程信息;
|
||||
- 支持用户自定义输出方式(例如:终端、文件、数据库、串口、485、Flash...);
|
||||
- 日志内容可包含级别、时间戳、线程信息、进程信息等;
|
||||
- 日志输出被设计为线程安全的方式;
|
||||
- 支持多种操作系统([RT-Thread](http://www.rt-thread.org/)、UCOS、Linux、Windows...),也支持裸机平台;
|
||||
- 日志支持 **RAW格式** ,可设定按 **标签** 进行过滤;
|
||||
- 扩展性强,支持已插件形式扩展新功能。
|
||||
- 日志支持 **RAW格式** ;
|
||||
- 支持按 **标签** 、 **级别** 、 **关键词** 进行动态过滤;
|
||||
- 扩展性强,支持以插件形式扩展新功能。
|
||||
|
||||
> 名词解释:
|
||||
1、RAW格式:未经过格式化的原始日志。
|
||||
@ -21,7 +22,7 @@ EasyLogger是一款超轻量级(ROM<1.6K, RAM<0.3k)、高性能的C日志库,
|
||||
|
||||
## 1.2 插件
|
||||
|
||||
- 1. Flash Log: 使用[EasyFlash](https://github.com/armink/EasyFlash)库提供的无缝接口,可以把日志直接存储在Flash中。
|
||||
- 1. Flash Log:使用[EasyFlash](https://github.com/armink/EasyFlash)库提供的无缝接口,可以把日志直接存储在Flash中。
|
||||
|
||||
## 1.3 Fork & Start
|
||||
|
||||
@ -76,7 +77,7 @@ EasyLogger拥有过滤方式、输出格式、输出开关这些属性。
|
||||
|
||||
### 2.5 输出方式
|
||||
|
||||
通过用户的移植,可以支持任何一种输出方式。只不过对于某种输出方式可能引入的新功能,目前需要用户自己实现,例如:文件转存,检索Flash日志等等。这些属于日志功能附带小工具,后期会以插件的形式逐步开源出来。下面简单对比下部分输出方式使用场景:
|
||||
通过用户的移植,可以支持任何一种输出方式。只不过对于某种输出方式可能引入的新功能,需要通过插件实现,例如:文件转存,检索Flash日志等等。后期会有更多的插件开源出来。下面简单对比下部分输出方式使用场景:
|
||||
|
||||
- 终端:方便用户动态查看,不具有存储功能;
|
||||
- 文件与Flash:都具有存储功能,用户可以查看历史日志。但是文件方式需要文件系统的支持,而Flash方式更加适合应用在无文件系统的小型嵌入式设备中。
|
||||
@ -100,10 +101,10 @@ EasyLogger拥有过滤方式、输出格式、输出开关这些属性。
|
||||
# 3. 后期
|
||||
|
||||
- 1、~~Flash存储:在[EasyFlash](https://github.com/armink/EasyFlash)中增加日志存储、读取功能,让EasyLogger与其无缝对接。使日志可以更加容易的存储在 **非文件系统** 中,~~并具有历史日检索的功能;
|
||||
- 2、异步输出:目前日志输出与用户代码之间是同步的方式,这种方式虽然软件简单,也不存在日志覆盖的问题。但在输出速度较低的平台下,会由于增加日志功能,而降低软件运行速度。所以后期会增加 **异步输出** 方式,关键字过滤也会放到异步输出中去;
|
||||
- 3、日志助手:开发跨平台的日志助手,兼容Linux、Windows、Mac系统,打开助手即可查看、过滤(支持正则表达式)、排序、保存日志等,计划使用[NW.js](http://www.oschina.net/p/nwjs)框架;
|
||||
- 4、文件转档:文件系统下支持文件按容量转档,按时间区分;
|
||||
- 5、配置文件:文件系统下的配置文件;
|
||||
- 2、文件转档:文件系统下支持文件按容量转档,按时间区分;
|
||||
- 3、异步输出:目前日志输出与用户代码之间是同步的方式,这种方式虽然软件简单,也不存在日志覆盖的问题。但在输出速度较低的平台下,会由于增加日志功能,而降低软件运行速度。所以后期会增加 **异步输出** 方式,关键字过滤也可以放到异步输出中去;
|
||||
- 4、配置文件:文件系统下的配置文件;
|
||||
- 5、日志助手:开发跨平台的日志助手,兼容Linux、Windows、Mac系统,打开助手即可查看、过滤(支持正则表达式)、排序、保存日志等,计划使用[NW.js](http://www.oschina.net/p/nwjs)框架;
|
||||
- 6、Arduino:增加Arduino lib,并提供其Demo;
|
||||
|
||||
# 4. 许可
|
||||
|
Loading…
x
Reference in New Issue
Block a user