||
遠(yuǎn)程errDump調(diào)試中的陷阱猶如暗礁,阻礙效率提升。本文系統(tǒng)化呈現(xiàn)避坑方法論,結(jié)合具體案例與技巧,教您如何預(yù)判、規(guī)避并解決常見陷阱,實(shí)現(xiàn)高效排障。
本文特別分享errDump功能及Air8101開發(fā)板實(shí)操驗(yàn)證。
一、errDump功能介紹
errDump是LuatOS系統(tǒng)中的錯(cuò)誤日志上報(bào)模塊,主要用于遠(yuǎn)程調(diào)試與故障診斷。
其原理是將模塊運(yùn)行過程中產(chǎn)生的錯(cuò)誤信息或者應(yīng)用日志,通過TCP/UDP上報(bào)到互聯(lián)網(wǎng)上的指定服務(wù)器,技術(shù)人員可以在服務(wù)器上查閱日志,協(xié)助遠(yuǎn)程了解設(shè)備運(yùn)行情況或者故障診斷。
核心價(jià)值體現(xiàn)在:
1)實(shí)時(shí)監(jiān)控設(shè)備狀態(tài)將設(shè)備運(yùn)行時(shí)的錯(cuò)誤信息(如系統(tǒng)崩潰、協(xié)程異常、網(wǎng)絡(luò)故障等)通過TCP/UDP/HTTP協(xié)議上報(bào)到指定服務(wù)器。
2)支持量產(chǎn)設(shè)備維護(hù)對(duì)于已投放市場(chǎng)的設(shè)備,無需現(xiàn)場(chǎng)調(diào)試即可遠(yuǎn)程定位問題,顯著降低維護(hù)成本。
3)靈活配置用戶可自定義上報(bào)周期、服務(wù)器地址及日志類型,適應(yīng)不同場(chǎng)景需求。
目前errDump支持2類錯(cuò)誤日志的儲(chǔ)存與上報(bào):
1)系統(tǒng)任務(wù)報(bào)錯(cuò)
腳本報(bào)錯(cuò)屬于系統(tǒng)異常日志,程序報(bào)錯(cuò)時(shí)會(huì)自動(dòng)寫入。
如果使用自動(dòng)上報(bào)到iot平臺(tái),則在下次重啟會(huì)自動(dòng)讀取并上報(bào);如果是自行讀取上報(bào),可通過errDump.dump(buff,errDump.TYPE_SYS, ture) 來讀取系統(tǒng)異常日志,并根據(jù)自己需求自定義傳輸。
2)用戶自行寫入
用戶自行寫入異常日志,是通過 errDump.record() 接口來保存的異常日志。
如果設(shè)置了定時(shí)上報(bào)周期的話,則會(huì)定期上報(bào)到服務(wù)器中;如果自行讀取上報(bào)的話,可以通過 errDump.dump(nil, errDump.TYPE_SYS, true) 來讀取用戶異常日志,并根據(jù)自己需求自定義傳輸。
日志文件都是儲(chǔ)存在文件系統(tǒng)中。系統(tǒng)異常日志文件和用戶異常日志文件最大都是4KB。
當(dāng)存儲(chǔ)空間不足時(shí),新日志會(huì)覆蓋最舊的數(shù)據(jù)。用戶可通過errDump.dump() 手動(dòng)讀取并清理日志,避免自動(dòng)覆蓋。
1)自動(dòng)上報(bào)
通過errDump.config(enable, period, user_flag, custom_id, host, port) 配置服務(wù)器地址和周期(默認(rèn)600 秒)。上報(bào)成功后,本地日志自動(dòng)清空。
2)手動(dòng)讀取
使用errDump.dump(zbuff, type, isDelete) 讀取日志,支持指定類型(如系統(tǒng)日志、用戶日志)并選擇是否刪除。
3)自定義傳輸
禁用自動(dòng)上報(bào)后,用戶可通過errDump.dump() 獲取日志內(nèi)容,再通過MQTT、HTTP API等方式發(fā)送到自有服務(wù)器。
1)自動(dòng)清除:設(shè)置自動(dòng)模式的話,上報(bào)到服務(wù)器成功后,本地日志自動(dòng)刪除。
2)手動(dòng)清除:設(shè)置手動(dòng)讀取模組,調(diào)用errDump.dump(nil, type, true) 指定日志類型并刪除。
3)覆蓋策略:系統(tǒng)/用戶日志達(dá)到4KB時(shí),新寫入內(nèi)容覆蓋舊數(shù)據(jù)。
下文以Air8101開發(fā)板為例,演示errdump日志上報(bào)功能實(shí)操要點(diǎn)。
最新源碼及實(shí)操教程詳見:https://docs.openluat.com/air8101/luatos/app/base/errdump/
主要示例代碼如下:
1)main.lua
2)errdump_test.lua
本功能模塊為:使用自動(dòng)上報(bào)異常日志到iot平臺(tái)。
3)errdump_uart.lua
本功能模塊為:使用手動(dòng)讀取異常日志并通過串口傳出。
4)errdump_tcp.lua
本功能模塊為:手動(dòng)讀取異常日志上傳到自己平臺(tái)。
云平臺(tái):iot.openluat.com
1)登錄IoT平臺(tái)
手機(jī)號(hào)為賬號(hào),默認(rèn)密碼888888,創(chuàng)建一個(gè)IoT賬號(hào)。
用這個(gè)賬號(hào)即可登錄IoT平臺(tái),將Air8101的sta mac歸屬到此賬號(hào)名下。
2)新建一個(gè)項(xiàng)目
3)將你自己建的項(xiàng)目key復(fù)制到demo中
4)打開設(shè)備DEBUG開關(guān)
特別注意:使用IoT云服務(wù)器時(shí),迫于服務(wù)器壓力,只有手動(dòng)打開debug開關(guān),才會(huì)有日志上報(bào)。
5)LuaTools日志打印
6)云平臺(tái)查看錯(cuò)誤上報(bào)
手動(dòng)讀取系統(tǒng)異常日志和用戶自定義消息,并通過串口輸出。
1)LuaTools日志打印
2)串口打印異常日志
手動(dòng)讀取系統(tǒng)異常日志和用戶自定義消息,并通過TCP協(xié)議上報(bào)到服務(wù)器中。
本文使用TCP服務(wù)器來演示: https://netlab.luatos.com/
1)啟動(dòng)TCP服務(wù)器
啟動(dòng)TCP服務(wù)器并修改demo中的IP和端口號(hào):
2)LuaTools日志打印
3)服務(wù)器日志打印
今天的內(nèi)容就分享到這里了~