Log日誌規範

2021-09-26 14:58:41 字數 883 閱讀 8261

1 日誌等級

trace/debug :記錄和追蹤整個程式的執行過程,針對不是非常重要的資訊。

info:記錄關鍵的步驟

warn:警告資訊,磁碟已滿等資訊,預期的錯誤

error:普通錯誤,程式還可以執行

fatal:嚴重錯誤,表示程式已經無法執行了。

2 列印規範

2.1 trace/debug 級別的日誌不列印,只列印info及以上級別的日誌

2.2 日誌的容量應控制在一定範圍內,需要定時的清理日誌。如果日誌框架有最大儲存容量及最長時間的設定,可以由日誌框架來決定刪除日誌。如果沒有,我們可以自定義定時清理程式,固定來清楚一段時間以前的日誌。

2.3 日誌應最少保留15天

2.4 普通日誌必須列印出時間,類,行數等資訊,而異常錯誤要列印出堆疊資訊

2.5 需要列印引數時,必須採用佔位符的方式。防止執行了額外的方法卻沒有列印日誌,浪費資源

2.6 預期的錯誤,但是不會影響程式執行的,用warn,否則用error

2.7 對於trace/debug中的列印資訊需要複雜計算的,需要用巨集定義或者開關控制,否則就算不列印但是也會被執行

2.8 捕獲異常後要麼列印日誌,要麼丟擲異常,不要兩個都做,否則會記錄2此異常

2.9 程式入口採用debug級別

2.10 確保日誌中的引數一定不會為null

在trace中記錄方法的進入和方法的退出

在debug中記錄方法傳入的引數

如果方法的返回引數比較重要,則採用info記錄

底層函式,沒有邏輯方面的方法全部由teace和debug構成,在底層函式中有判斷某個方法是否執行成功,如果呼叫它的方法會判斷這個結果的,那麼本層不需要做任何記錄,全部交由呼叫者記錄。info主要記錄和業務邏輯相關的流程。

參考:

log書寫規範

問題追蹤 在程式除錯時,通過日誌追蹤程式的bug,也可在使用者發現bug後,通過日誌對問題進行分析和定位。狀態監控 通過日誌可檢視系統的執行狀態,做到發現和定位問題。安全審計 通過對日誌進行分析,可發現是否存在非授權的操作。安全類資訊 記錄系統邊界互動行為和資訊。業務類資訊 記錄系統內部業務處理行為...

關於 日誌log

概述 介紹日誌的基本概念 用途和日誌生成規則。x系統 日誌包括 x系統 執行過程中的所有行為記錄資訊,各模組在執行過程中的關鍵位置,都會記錄相關日誌。通過分析 x系統 日誌,可以了解 x系統 的執行狀態。出現故障時可以通過日誌定位故障產生的時間,原因等資訊。x系統 的日誌生成是通過緩衝方式實現。即日...

Log 日誌級別

日誌記錄器 logger 是日誌處理的核心元件。log4j具有5種正常級別 level 1.static level debug debug level指出細粒度資訊事件對除錯應用程式是非常有幫助的。2.static level info info level表明 訊息在粗粒度級別上突出強調應用程式...