日誌消息的風格指南

Question

我正在尋找一個風格指南來記錄消息：

例如：

• 什麼&當
• 約定
• 風格&格式化
• 可讀性

即是什麼讓一個好/壞日誌消息字符串

我在什麼使一個很好的日誌字符串特別感興趣 - 超越包括時間，嚴重程度和組成部分，因爲我傾向於使用log4j的，給了我這個信息免費。

YYYY-MM-DDTHH：MM：SS.mmm

無論你決定，如果它是一個文本日誌，每一行的開頭用，最好，ISO格式良好的時間戳

Answer 1

所有可能的情況下，您都需要使用嚴重代碼來跟蹤時間戳。

一些好的日誌指引可以在這裏找到：

http://watchitlater.com/blog/2009/12/logging-guidelines/

這裏

http://download.oracle.com/docs/cd/B32110_01/web.1013/b28952/logging.htm

Answer 2

這確實取決於你的應用。我可以從任何位於/ var/log中汲取靈感/ *

Answer 3

有效的記錄是一門藝術，但也有一些重大的項目，可以幫助：

• 線程ID：企業應用程序通常在多線程環境中執行。使用線程ID信息，您可以區分一個請求與另一個請求。

• 來電顯示：來電的身份（或主體）也是一個重要的信息。由於不同的用戶有不同的權限，他們的執行路徑可能會有很大的不同將用戶的身份放在日誌消息中對於支持安全性的應用程序來說是一個很大的幫助。

• 時間戳：通常，用戶只能近似發生問題的時間。沒有時間戳，支持人員很難確定問題。

• 源代碼信息：這包括類名，方法名和行號。

（這些提示取自this IBM article on Java logging。）

Answer 4

公約方面，幾年我一直在格式化我的日誌爲：

severity timestamp source message 

隨着severity是符號：

(-) Info 
(!) Warning 
(*) Error 

如：

(-) 2010-10-13T18:53:42 foo: Starting up... 
(!) 2010-10-13T18:54:11 foo: bar: Unable to lock file "quux", will try again in 4 seconds. 
(-) 2010-10-13T18:56:13 foo: Loading plugin "baz"... 
(*) 2010-10-13T18:57:39 foo: baz: Error 0xbaadbeef during RPC. 
(-) 2010-10-13T18:58:04 foo: Shutting down... 

我發現瀏覽更容易 - 搜索特定的消息類（所有錯誤，所有警告），特別是在使用終端中的尋呼機瀏覽日誌時。

Answer 5

10 Commandments of Logging是對伐木世界的完美介紹。

本網站將教你做的& dont's創建自己的日誌文件。