記錄日誌
CLI 採用 swift-log 介面進行日誌記錄。該套件將日誌實現細節抽象化,使 CLI 無需依賴特定後端。日誌器透過 task locals 進行依賴注入,可於任何位置使用以下方式存取:
bash
Logger.current
Note
使用 Dispatch 或 detached tasks 時,task locals 不會傳播值,因此若使用它們,你需要取得該值並傳遞給異步操作。
應該記錄什麼#
日誌並非 CLI 的使用者介面。它們是用於診斷問題的工具。因此,提供的資訊越多越好。在開發新功能時,請設身處地為遇到意外行為的開發者著想,思考哪些資訊對他們有幫助。請確保使用正確的 日誌級別,否則開發者將無法過濾雜訊。