EasyLogger

EasyLogger

---

1. 介紹

EasyLogger 是一款超輕量級(ROM<1.6K, RAM<0.3K)、高性能的C/C++ 日誌庫，非常適合對資源敏感的軟件項目，例如： IoT 產品、可穿戴設備、智能家居等等。相比log4c、zlog 這些知名的C/C++ 日誌庫， EasyLogger 的功能更加簡單，提供給用戶的接口更少，但上手會很快，更多實用功能支持以插件形式進行動態擴展。

1.1 主要特性

• 支持用戶自定義輸出方式（例如：終端、文件、數據庫、串口、485、Flash...）；
• 日誌內容可包含級別、時間戳、線程信息、進程信息等；
• 日誌輸出被設計為線程安全的方式，並支持異步輸出及緩衝輸出模式；
• 支持多種操作系統（RT-Thread、UCOS、Linux、Windows、Nuttx...），也支持裸機平台；
• 日誌支持RAW格式，支持hexdump ；
• 支持按標籤、級別、關鍵詞進行動態過濾；
• 各級別日誌支持不同顏色顯示；
• 擴展性強，支持以插件形式擴展新功能。

名詞解釋：

• 1、RAW格式：未經過格式化的原始日誌。
• 2、標籤：在軟件中可以按照文件、模塊、功能等方面，對需要打印的日誌設定標籤，實現日誌分類。

1.2 插件

• 1、Flash：使用EasyFlash 庫提供的Flash操作接口，無需文件系統，直接將日誌存儲在Flash 中。
• 2、File：支持文件轉檔、文件循環保存等與文件日誌輸出相關功能。
• 3、敬請期待……

1.3 Star & Fork

後續我還會提供更多插件。也非常歡迎大家設計、開發更多實用插件和功能，一起來完善EasyLogger (Github|OSChina|Coding) 。如果覺得這個開源項目很贊，可以點擊項目主頁右上角的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對各個級別日誌的顏色及字體風格進行單獨設置。

2.3 輸出過濾

支持按照級別、標籤及關鍵詞進行過濾。日誌內容較多時，使用過濾功能可以更快定位日誌，保證日誌的可讀性。更多的過濾功能設置方法及細節請閱讀docszhapikernel.md文檔

注：RAW格式、hexdump 格式日誌不支持標籤、關鍵詞過濾

2.4 輸出格式

輸出格式支持：級別、時間、標籤、進程信息、線程信息、文件路徑、行號、方法名。每種優先級別可以獨立設置輸出格式。

2.5 輸出方式

通過用戶的移植，可以支持任何一種輸出方式。只不過對於某種輸出方式可能引入的新功能，需要通過插件實現，例如：文件轉存，檢索Flash日誌等等。後期會有更多的插件開源出來。下面簡單對比下部分輸出方式使用場景：

• 終端：方便用戶動態查看，不具有存儲功能；
• 文件與Flash：都具有存儲功能，用戶可以查看歷史日誌。但是文件方式需要文件系統的支持，而Flash方式更加適合應用在無文件系統的小型嵌入式設備中。

2.6 Demo

2.6.1 核心功能

下圖為在終端中輸入命令來控制日誌的輸出及過濾器的設置，更加直觀的展示了EasyLogger 核心功能。

• Demo 路徑： demoosrt-threadstm32f10x
• API 文檔： docszhapikernel.md
• 移植文檔： docszhportkernel.md

2.6.2 Flash Log（將日誌保存到Flash 中）

下圖過程為通過控制台輸出日誌，並將輸出的日誌存儲到Flash 中。重啟再讀取上次保存的日誌，最後清空Flash 日誌。

• Demo 路徑： demoosrt-threadstm32f10x
• API 文檔： docszhapiflash.md
• 移植文檔： docszhportflash.md

2.6.2 File Log（將日誌保存到文件中）

通過FIle 插件，可以將日誌自動保存至文件中。每個文件可以設定大小，超過規定大小後，自動新建新的文件來存儲日誌。

3. 文檔

具體內容參考docszh下的文件。務必保證在閱讀文檔後再移植使用。

4. 後期

• Flash存儲：在EasyFlash中增加日誌存儲、讀取功能，讓EasyLogger與其無縫對接。使日誌可以更加容易的存儲在非文件系統中，並具有歷史日誌檢索的功能；
• 配置文件：文件系統下的配置文件；
• 文件轉檔：文件系統下支持文件按容量轉檔，按時間區分；
• 日誌助手：開發跨平台的日誌助手，兼容Linux、Windows、Mac系統，打開助手即可查看、過濾（支持正則表達式）、排序、保存日誌等。前端：HTML5 + Bootstrap + AngularJS + NW.js，後端：Rust + iron + rust-websocket + serial-rs；
• 異步輸出：目前日誌輸出與用戶代碼之間是同步的方式，這種方式雖然軟件簡單，也不存在日誌覆蓋的問題。但在輸出速度較低的平台下，會由於增加日誌功能，而降低軟件運行速度。所以後期會增加異步輸出方式，關鍵字過濾也可以放到異步輸出中去；
• Arduino：增加Arduino lib，並提供其Demo；

5. 許可

MIT Copyright (c) [email protected]