1、寫在最前:
開源日志庫EasyLogger使用c語言編寫,及其簡便和通用,感謝EasyLogger作者armink的貢獻。
2、代碼地址:
github地址:https://github.com/armink/EasyLogger
gitee地址: https://gitee.com/armink/EasyLogger
3、許可
MIT Copyright (c) armink.ztl@gmail.com
4、介紹:
EasyLogger 是一款超輕量級(ROM<1.6K, RAM<0.3K)、高性能的C日志庫,非常適合對資源敏感的軟件項目,例如:IoT產品、可穿戴設備、智能家居等等。相比log4c、zlog這些知名的C日志庫,EasyLogger的功能更加簡單,提供給用戶的接口更少,但上手會很快,更多實用功能支持以插件形式進行動態擴展。
5、主要特性
-
支持用戶自定義輸出方式(例如:終端、文件、數據庫、串口、485、Flash...);
-
日志內容可包含級別、時間戳、線程信息、進程信息等;
-
日志輸出被設計為線程安全的方式;
-
支持多種操作系統(RT-Thread、UCOS、Linux、Windows...),也支持裸機平台;
-
日志支持RAW格式;
-
支持按標簽、級別 、關鍵詞進行動態過濾;
-
各級別日志支持不同顏色顯示;
-
擴展性強,支持以插件形式擴展新功能。
<注>名詞解釋:
1、RAW格式:未經過格式化的原始日志。
2、標簽:在軟件中可以按照文件、模塊、功能等方面,對需要打印的日志設定標簽,實現日志分類。
6、插件
-
1、Flash:使用EasyFlash庫提供的Flash操作接口,可以把日志直接存儲在Flash中。
-
2、File:支持文件轉檔、軟件運行時動態加載配置文件等與文件日志輸出相關功能。
7、參數配置
EasyLogger擁有過濾方式、輸出格式、輸出開關這些屬性。
-
過濾方式支持按照標簽、級別、關鍵詞進行過濾;
-
可以動態的開啟/關閉日志的輸出;
-
可設定動態和靜態的輸出級別(靜態:一級開關,通過宏定義;動態:二級開關,通過API接口)
8、輸出級別
參考Android Logcat,級別最高為0(Assert),最低為5(Verbose)。
0.[A]:斷言(Assert) 1.[E]:錯誤(Error) 2.[W]:警告(Warn) 3.[I]:信息(Info) 4.[D]:調試(Debug) 5.[V]:詳細(Verbose)
8.1 各個級別日志默認顏色效果如下。用戶也可以根據自己的喜好,在 elog_cfg.h
對各個級別日志的顏色及字體風格進行單獨設置。
8.2輸出過濾
支持按照級別、標簽及關鍵詞進行過濾。日志內容較多時,使用過濾功能可以更快定位日志,保證日志的可讀性。更多的過濾功能設置方法及細節請閱讀\docs\zh\api\kernel.md文檔。
8.3 輸出格式
輸出格式支持:級別、時間、標簽、進程信息、線程信息、文件路徑、行號、方法名。每種優先級別可以獨立設置輸出格式。
注:默認為RAW格式,RAW格式日志不支持標簽過濾
8.4 輸出方式
通過用戶的移植,可以支持任何一種輸出方式。只不過對於某種輸出方式可能引入的新功能,需要通過插件實現,例如:文件轉存,檢索Flash日志等等。后期會有更多的插件開源出來。下面簡單對比下部分輸出方式使用場景:
-
終端:方便用戶動態查看,不具有存儲功能;
-
文件與Flash:都具有存儲功能,用戶可以查看歷史日志。但是文件方式需要文件系統的支持,而Flash方式更加適合應用在無文件系統的小型嵌入式設備中。
9、移植
因為在linux下使用,所以直接進入EasyLogger\EasyLogger\demo\os\linux下測試即可
-
Demo路徑:\demo\os\rt-thread\stm32f10x\
-
API文檔:\docs\zh\api\kernel.md
-
移植文檔:\docs\zh\port\kernel.md
10、遇到的問題:
1、文件和控制台的開關問題,可以整體開關,沒有單一開關
2、級別、過濾策略不能動態控制
解決辦法:創建全局flag,寫一個配置文件,開一個線程處理,檢查文件的狀態,讀取文件內容,文件中包含問題1和問題2中的參數。
11、接口說明:
API:
elog_set_filter(uint8_t level, const char *tag, const char *keyword); //參數1:要過濾的級別,參數2:要過濾的標簽,參數3:要過濾的關鍵字
elog_set_filter_tag_lvl("test", ELOG_LVL_WARN); //參數1:要過濾的標簽(線程/進程名/模塊名)。 參數2:對指定標簽過濾,設置顯示級別,低於此級別不再顯示
elog_set_filter_tag(const char *tag); //參數1:要過濾的標簽
elog_set_filter_kw("EasyLogger"); //參數1:要過濾的關鍵字,所有log中帶有關鍵字的log才會顯示
elog_set_filter_lvl(ELOG_LVL_WARN); //參數1:要過濾的級別,低於此級別的log不顯示
elog_set_output_enabled(true); //參數1:開關,控制log是否打印的開關,全局的,包含文件和console
elog_start(); //這里默認啟動總開關,默認啟動異步輸出方式,默認啟動緩沖輸出方式
elog_init(); //log初始化
setbuf(stdout, NULL); //關閉 printf 緩沖機制
elog_set_text_color_enabled(true); //打開顏色選項
elog_set_fmt(ELOG_LVL_ERROR, ELOG_FMT_LVL | ELOG_FMT_TAG | ELOG_FMT_TIME); //設置不同級別所顯示的格式,這里有一個枚舉來控制
elog_a("tag","Hello hahah"); //每次需要傳入tag
log_a("hello"); //tag通過宏設置在頭文件上面
/* all formats index */
typedef enum {
ELOG_FMT_LVL = 1 << 0, /**< level */
ELOG_FMT_TAG = 1 << 1, /**< tag */
ELOG_FMT_TIME = 1 << 2, /**< current time */
ELOG_FMT_P_INFO = 1 << 3, /**< process info */
ELOG_FMT_T_INFO = 1 << 4, /**< thread info */
ELOG_FMT_DIR = 1 << 5, /**< file directory and name */
ELOG_FMT_FUNC = 1 << 6, /**< function name */
ELOG_FMT_LINE = 1 << 7, /**< line number */
} ElogFmtIndex;
12、規格,每行輸出最長字符,ELOG_LINE_BUF_SIZE=512最大
過濾標簽最大長度,ELOG_FILTER_TAG_MAX_LEN=16
過濾關鍵詞最大長度,ELOG_FILTER_KW_MAX_LEN=16
過濾器數目, 暫時僅支持一個
13、demo測試完畢后,移植到工程中封裝自己的接口即可使用