EasyLogger 开源日志库教程
项目介绍
EasyLogger 是一款超轻量级(ROM<1.6K, RAM<0.3K)、高性能的 C/C++ 日志库,非常适合对资源敏感的软件项目,例如 IoT 产品、可穿戴设备、智能家居等。相比 log4c、zlog 这些知名的 C/C++ 日志库,EasyLogger 的功能更加简单,提供给用户的接口更少,但上手会很快。更多实用功能支持以插件形式进行动态扩展。
主要特性
- 支持用户自定义输出方式(例如:终端、文件、数据库、串口、485、Flash)
- 日志内容可包含级别、时间戳、线程信息、进程信息等
- 日志输出被设计为线程安全的方式,并支持异步输出及缓冲输出模式
- 支持多种操作系统(RT-Thread、UCOS、Linux、Windows、Nuttx),也支持裸机平台
- 日志支持 RAW 格式,支持 hexdump,支持按标签、级别、关键词进行动态过滤
- 各级别日志支持不同颜色显示,扩展性强,支持以插件形式扩展新功能
项目快速启动
环境准备
确保你已经安装了以下工具和环境:
- Git
- 支持 C/C++ 的编译器(如 GCC)
- 操作系统(如 Linux 或 Windows)
克隆项目
git clone https://github.com/armink/EasyLogger.git
cd EasyLogger
编译和运行
以下是一个简单的示例代码,展示如何使用 EasyLogger:
#include "elog.h"
int main(void)
{
// 初始化 EasyLogger
elog_init();
// 设置日志输出级别
elog_set_fmt(ELOG_LVL_ASSERT, ELOG_FMT_ALL);
elog_set_fmt(ELOG_LVL_ERROR, ELOG_FMT_LVL | ELOG_FMT_TAG | ELOG_FMT_TIME);
elog_set_fmt(ELOG_LVL_WARN, ELOG_FMT_LVL | ELOG_FMT_TAG | ELOG_FMT_TIME);
elog_set_fmt(ELOG_LVL_INFO, ELOG_FMT_LVL | ELOG_FMT_TAG | ELOG_FMT_TIME);
elog_set_fmt(ELOG_LVL_DEBUG, ELOG_FMT_ALL & ~(ELOG_FMT_FUNC | ELOG_FMT_T_INFO));
elog_set_fmt(ELOG_LVL_VERBOSE, ELOG_FMT_ALL & ~(ELOG_FMT_FUNC | ELOG_FMT_T_INFO));
// 启动 EasyLogger
elog_start();
// 输出日志
log_a("This is an assert log.");
log_e("This is an error log.");
log_w("This is a warning log.");
log_i("This is an info log.");
log_d("This is a debug log.");
log_v("This is a verbose log.");
return 0;
}
编译示例
gcc -o example example.c -I./ -L./ -leasylogger
运行示例
./example
应用案例和最佳实践
案例一:智能家居设备
在智能家居设备中,EasyLogger 可以用来记录设备的状态变化、错误信息和调试信息。通过将日志存储在 Flash 中,可以方便地进行历史日志检索和分析。
案例二:IoT 传感器
在 IoT 传感器项目中,EasyLogger 可以用来记录传感器数据、网络通信状态和异常情况。通过将日志输出到终端或文件,可以实时监控传感器的工作状态。
最佳实践
- 合理设置日志级别,避免过多冗余日志影响性能。
- 使用标签对日志进行分类,便于后续过滤和分析。
- 定期清理过期日志,避免日志文件过大。
典型生态项目
EasyFlash
EasyFlash 是一个轻量级的 Flash 操作库,与 Easy