日志的作用


1.1 日志的作用

一般程序日志出自下面幾個方面的需求:
1. 記錄用戶操作的審計日志,甚至有的時候就是監管部門的要求。
2. 快速定位問題的根源
3. 追蹤程序執行的過程。
4. 追蹤數據的變化
5. 數據統計和性能分析
6. 采集運行環境數據
一般在程序上線之后,一旦發生異常,第一件事就是要弄清楚當時發生了什么。用戶當時做了什么操作,環境有無影響,數據有什么變化,是不是反復發生等,然后再進一步的確定大致是哪個方面的問題。確定是程序的問題之后再交由開發人員去重現、研究、提出解決方案。這時,日志就給我們提供了第一手的資料。

1.2 撰寫日志的要求

既然撰寫日志是有需求,而且也能在未來幫助我們提高工作效率的事情,長遠來看是非常有利的一件事情。因此我們應該在自己開發的程序中符合規范的撰寫日志,在寫日志時要注意以下的問題。

1.2.1 日志的可讀性

日志時給人讀的,不僅僅是讓自己明白,也要讓沒有接觸過我們源代碼的其他程序員也能夠一目了然。有的同事在日志中打印特殊的標識符號,例如“++++++++++”, “===========”,“—————”,這些符號令人眼花繚亂。這是一種不好的編程習慣。
另外,把日志分類輸出到不同的文件也有利於我們排除干擾,迅速找到我們需要的信息。而且,最好在打印日志時輸出英文,防止中文不支持而打印出亂碼的情況。

1.2.2 日志的性能

無論我們把日志寫到文件還是數據庫,都需要消耗IO資源。適當的控制日志的輸出也有利於提高程序的性能。例如:盡量避免在在大的循環中打印意義不大的日志內容。輸出日志之前最好能判斷日志的級別(例如. debug前先調用isDebugEnabled()作出判斷)。

1.2.3 占用磁盤空間

通常,我們都是把日志寫入磁盤上的日志文件中。適當的使用滾動日志並且定時清除舊文件是有好處的。我見過這樣一個例子,程序運行幾次后就跑不起來了,前幾次都是正常的。怎么都想不明白程序有什么問題,最后才發現居然是日志文件占滿了磁盤空間。在實際的應用中出現上G的日志文件也往往不少見。要在這樣規模的日志文件中找出對解決問題有用的信息也是一大挑戰。

1.2.4 日志的時效性

有的時候我們並不能及時的發現問題。需要追溯之前的日志。所以我們是需要保留一段時間以內的日志便於追溯。
1.2.5 日志級別
通常我們在產品環境中日志的級別都在INFO以上,所以我們必須保證在這樣的情況下程序仍然能夠輸出足夠我們作出判斷的信息。

1.2.6 日志內容

我們在寫日志的時候,需要注意輸出適當的內容。首先,盡量使用業務相關的描述。我們的程序是實現某種業務的,那么就最好能描述清楚這個時候走到了業務過程的哪一步。其次,避免在日志中輸出一些敏感信息,例如用戶名和密碼。以及,要保持編碼的一致。如果不能保證就盡量使用英文而不是中文。這樣當我們拿到日志之后就不會因為看到一堆亂碼而不知所雲了。

1.2.7 日志格式

常見的日志格式中對於每一條日志應含有的信息包括日期、時間、日志級別、代碼位置、日志內容、錯誤碼等信息。下面是一個工作中的日志文件的一部分內容:

 

原文:  https://blog.csdn.net/monk1992/article/details/82687182

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM