概述
ulog是AliOS Things的日志模塊,同時支持經典同步機制和異步日志機制,異步機制使其他邏輯任務保持正常工作,支持簡短的日志格式和syslog協議格式,日志內容可以通過不同方式輸出(uart udp vfs uagent), 此外,文件系統中的日志文件可以通過HTTP上傳至云端。組件支持以下功能:
通過串口輸出日志
通過UDP輸出日志
通過文件系統輸出日志
通過uagent輸出日志到云端
版權信息
Apache license v2.0
目錄結構
ulog
├── README.md #ulog說明文檔
├── example
│ └── ulog_example.c #ulog使用demo
├── include
│ ├── ulog_config.h #ulog相關配置頭文件
│ └── ulog
│ └── ulog.h #ulog使用API頭文件
├── internal #內部頭文件
│ ├──ulog_api.h
│ ├──ulog_ring_fifo.h
│ └──ulog_session_file.h
├── src
│ ├── ulog_async.c #ulog 異步日志輸出功能
│ ├── ulog.c #ulog 整體功能
│ ├── ulog_fs_cfg.c #ulog 文件系統配置
│ ├── ulog_init.c #ulog 初始化
│ ├── ulog_ring_fifo.c #ulog ring fifo功能,供異步使用
│ ├── ulog_session_file.c #ulog 日志到文件系統
│ ├── ulog_session_udp.c #ulog 日志通過UDP發出
│ └── ulog_utility.c #ulog 通用功能
依賴組件
vfs
uagent
常用配置
系統中相關配置已有默認值,如需修改配置,統一在YAML中def_config節點修改,具體如下:
開啟異步打印:默認0, 如需修改,在YAML中修改ULOG_CONFIG_ASYNC配置
def_config:
ULOG_CONFIG_ASYNC: 1
支持日志實時上傳到云,默認不開啟,可按照實際需要修改YAML配置如:
def_config:
ULOG_CONFIG_POP_CLOUD: 0
ULOG_CONFIG_STOP_FILTER_CLOUD: 5
API說明
參考 aos_ulog
使用示例
組件使用示例相關的代碼下載、編譯和固件燒錄均依賴AliOS Things配套的開發工具,所以首先需要參考《AliOS Things集成開發環境使用說明之搭建開發環境》,下載安裝。待開發環境搭建完成后,可以按照以下步驟進行示例的測試。
步驟1 創建或打開工程
打開已有工程
如果用于測試的案例工程已存在,可參考《AliOS Things集成開發環境使用說明之打開工程》打開已有工程。
創建新的工程
組件的示例代碼可以通過編譯鏈接到AliOS Things的任意案例(solution)來運行,這里選擇helloworld_demo案例。helloworld_demo案例相關的源代碼下載可參考《AliOS Things集成開發環境使用說明之創建工程》。
步驟2 添加組件
案例下載完成后,需要在helloworld_demo組件的package.yaml中添加對組件的依賴:
depends:
- ulog: dev_aos # helloworld_demo中引入ulog組件
步驟3 下載組件
在已安裝了的開發環境工具欄中,選擇Terminal -> New Terminal啟動終端,并且默認工作路徑為當前工程的workspace,此時在終端命令行中輸入:
aos install ulog
上述命令執行成功后,組件源碼則被下載到了./components/ulog路徑中。
步驟4 添加示例
ulog組件的package.yaml中添加example示例代碼:
source_file:
- src/ulog_async.c? <ULOG_CONFIG_ASYNC>
- src/ulog.c
- src/ulog_fs_cfg.c? <ULOG_CONFIG_POP_FS>
- src/ulog_init.c
- src/ulog_ring_fifo.c
- src/ulog_session_file.c? <ULOG_CONFIG_POP_FS>
- src/ulog_session_udp.c? <ULOG_CONFIG_POP_UDP>
- src/ulog_utility.c
- example/ulog_example.c #add ulog example code
ulog 設置日志輸出等級,默認為不輸出
aos_set_log_level(AOS_LL_DEBUG);
步驟5 編譯固件
在示例代碼已經添加至組件的配置文件,并且helloworld_demo已添加了對該組件的依賴后,就可以編譯helloworld_demo案例來生成固件了,具體編譯方法可參考《AliOS Things集成開發環境使用說明之編譯固件》。
步驟6 燒錄固件
helloworld_demo案例的固件生成后,可參考《AliOS Things集成開發環境使用說明之燒錄固件》來燒錄固件。
步驟7 打開串口
固件燒錄完成后,可以通過串口查看示例的運行結果,打開串口的具體方法可參考《AliOS Things集成開發環境使用說明之查看日志》。
當串口終端打開成功后,可在串口中輸入help來查看已添加的測試命令。
步驟8 測試示例
CLI命令行輸入:
ulog_examp