python 建立記錄檔 logging 日誌記錄

文章目錄

• 4個主要的組件
• 記錄層級
• logging.basicConfig([**kwargs]):
• logging.setLoggerClass(klass)
• logging.getLoggerClass()
• logging.getLevelName(lvl)
• logging.shutdown()
• Logger.exception(msg[, *args])
• Logger.addFilter(filt)
• Logger.removeFilter(filt)
• Logger.addHandler(hdlr)
• Logger.removeHandler(hdlr)
• Logger.makeRecord(name, lvl, fn, lno, msg, args, exc_info[, func, extra])

　許多應用程式中都會有日誌模組，用於記錄系統在運行過程中的一些關鍵資訊，以便於對系統的健全狀態進行跟蹤。在.NET平台中，有非常著名的第三方開源日誌組件log4net，c++中，有人們熟悉的log4cpp，而在python中，我們不需要第三方的日誌組件，因為它已經為我們提供了簡單易用、且功能強大的日誌模組：logging。logging模組支援將日誌資訊儲存到不同的目標域中，如：儲存到記錄檔中；以郵件的形式發送日誌資訊；以http get或post的方式提交日誌到web伺服器；以windows事件的形式記錄等等。這些日誌儲存方式可以組合使用，每種方式可以設定自己的記錄層級以及日誌格式。日誌模組的內容比較多，今天先學習logging模組的基本使用，下次具體學習日誌的處理。

先看一個比較簡單的例子，讓我們對logging模組有個感性的認識：

1. import logging  
2. logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), level = logging.DEBUG)  
3. logging.debug('this is a message') 

import logging logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), level = logging.DEBUG) logging.debug('this is a message')

　　運行上面例子的代碼，將會在程式的根目錄下建立一個log.txt檔案，開啟該檔案，裡面有一條日誌記錄："DEBUG:root:this is a message"。

4個主要的組件

logger: 日誌類，應用程式往往通過調用它提供的api來記錄日誌；

handler: 對日誌資訊處理，可以將日誌發送(儲存)到不同的目標域中；

filter: 對日誌資訊進行過濾；

formatter:日誌的格式化；

記錄層級

　　在記錄日誌時, 日誌訊息都會關聯一個層級("層級"本質上是一個非負整數)。系統預設提供了6個層級，它們分別是：

層級	對應的值
CRITICAL	50
ERROR	40
WARNING	30
INFO	20
DEBUG	10
NOTSET	0

可以給日誌對象(Logger Instance)設定記錄層級，低於該層級的日誌訊息將會被忽略，也可以給Hanlder設定記錄層級，對於低於該層級的日誌訊息, Handler也會忽略。

logging模組中的常用函數：

logging.basicConfig([**kwargs]):

　　為日誌模組配置基本資料。kwargs 支援如下幾個關鍵字參數：
filename ：記錄檔的儲存路徑。如果配置了些參數，將自動建立一個FileHandler作為Handler；
filemode ：記錄檔的開啟模式。 預設值為'a'，表示日誌訊息以追加的形式添加到記錄檔中。如果設為'w', 那麼每次程式啟動的時候都會建立一個新的記錄檔；
format ：設定日誌輸出格式；
datefmt ：定義日期格式；
level ：設定日誌的層級.對低於該層級的日誌訊息將被忽略；
stream ：設定特定的流用於初始化StreamHandler；

　　下面是一個簡單的例子：

 

1. #coding=gbk  
2. import logging  
3. logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), \  
4.     level = logging.WARN, filemode = 'w', format = '%(asctime)s - %(levelname)s: %(message)s')  
5. logging.debug('debug')  #被忽略  
6. logging.info('info')    #被忽略  
7. logging.warning('warn')  
8. logging.error('error')  
9. #----- 結果  
10. #2009-07-13 21:42:15,592 - WARNING: warn  
11. #2009-07-13 21:42:15,640 - ERROR: error 

#coding=gbk import logging logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), \ level = logging.WARN, filemode = 'w', format = '%(asctime)s - %(levelname)s: %(message)s') logging.debug('debug')#被忽略 logging.info('info')#被忽略 logging.warning('warn') logging.error('error') #----- 結果 #2009-07-13 21:42:15,592 - WARNING: warn #2009-07-13 21:42:15,640 - ERROR: error

logging.getLogger([name])

　　建立Logger對象。日誌記錄的工作主要由Logger對象來完成。在調用getLogger時要提供Logger的名稱（註：多次使用相同名稱來調用getLogger，返回的是同一個對象的引用。），Logger執行個體之間有層次關係，這些關係通過Logger名稱來體現，如：

p = logging.getLogger("root")

c1 = logging.getLogger("root.c1")

c2 = logging.getLogger("root.c2")

例子中，p是父logger, c1,c2分別是p的子logger。c1, c2將繼承p的設定。如果省略了name參數, getLogger將返回日誌對象層次關係中的根Logger。

logging.setLoggerClass(klass)logging.getLoggerClass()

　　擷取/設定日誌類型。使用者可以自訂日誌類來代替系統提供的logging.Logger類。

logging.getLevelName(lvl)

　　擷取記錄層級對應的名稱。例如：

1. print logging.getLevelName(logging.NOTSET)  
2. print logging.getLevelName(10) #logging.DEBUG  
3. print logging.getLevelName(logging.DEBUG)  
4. print logging.getLevelName(30) #logging.WARN  
5. print logging.getLevelName(logging.ERROR)  
6. print logging.getLevelName(50)  #logging.CRITICAL 

print logging.getLevelName(logging.NOTSET) print logging.getLevelName(10) #logging.DEBUG print logging.getLevelName(logging.DEBUG) print logging.getLevelName(30) #logging.WARN print logging.getLevelName(logging.ERROR) print logging.getLevelName(50) #logging.CRITICAL

logging.shutdown()

　　當不再使用日誌系統的時候，調用該方法，它會將日誌flush到對應的目標域上。一般在系統退出的時候調用。

Logger對象 通過調用logging.getLogger(name)來建立，它有如下常用的方法和屬性：

Logger.setLevel(lvl):

　　設定日誌的層級。對於低於該層級的日誌訊息將被忽略。下面一個例子示範setLevel方法：

1. #coding=gbk  
2. import logging  
3. logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), level = logging.DEBUG)  
4. log = logging.getLogger('root.test')  
5. log.setLevel(logging.WARN)  #日誌記錄層級為WARNNING  
6. log.info('info')    #不會被記錄  
7. log.debug('debug')  #不會被記錄  
8. log.warning('warnning')  
9. log.error('error') 

#coding=gbk import logging logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), level = logging.DEBUG) log = logging.getLogger('root.test') log.setLevel(logging.WARN) #日誌記錄層級為WARNNING log.info('info') #不會被記錄 log.debug('debug') #不會被記錄 log.warning('warnning') log.error('error')

Logger.debug(msg [ ,*args [, **kwargs]])

　　記錄DEBUG層級的日誌資訊。參數msg是資訊的格式，args與kwargs分別是格式參數。

1. import logging  
2. logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), level = logging.DEBUG)  
3. log = logging.getLogger('root')  
4. log.debug('%s, %s, %s', *('error', 'debug', 'info'))  
5. log.debug('%(module)s, %(info)s', {'module': 'log', 'info': 'error'}) 

import logging logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), level = logging.DEBUG) log = logging.getLogger('root') log.debug('%s, %s, %s', *('error', 'debug', 'info')) log.debug('%(module)s, %(info)s', {'module': 'log', 'info': 'error'})

Logger.info(msg[ , *args[ , **kwargs] ] ) Logger.warnning(msg[ , *args[ , **kwargs] ] ) Logger.error(msg[ , *args[ , **kwargs] ] ) Logger.critical(msg[ , *args[ , **kwargs] ] )

　　記錄相應層級的日誌資訊。參數的含義與Logger.debug一樣。

Logger.log(lvl, msg[ , *args[ , **kwargs] ] )

　　記錄日誌，參數lvl使用者佈建日誌資訊的層級。參數msg, *args, **kwargs的含義與Logger.debug一樣。

Logger.exception(msg[, *args])

　　以ERROR層級記錄日誌訊息，異常跟蹤資訊將被自動添加到日誌訊息裡。Logger.exception通過用在異常處理塊中，如：

1. import logging  
2. logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), level = logging.DEBUG)  
3. log = logging.getLogger('root')  
4. try:  
5.     raise Exception, 'this is a exception' 
6. except:  
7.     log.exception('exception') #異常資訊被自動添加到日誌訊息中 

import logging logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), level = logging.DEBUG) log = logging.getLogger('root') try: raise Exception, 'this is a exception' except: log.exception('exception') #異常資訊被自動添加到日誌訊息中

Logger.addFilter(filt) Logger.removeFilter(filt)

　　添加/移除日誌訊息過濾器。在講述Filter時具體介紹。

Logger.addHandler(hdlr) Logger.removeHandler(hdlr)

　　添加/移除日誌訊息處理器。在講述Handler時具體介紹。

Logger.makeRecord(name, lvl, fn, lno, msg, args, exc_info[, func, extra])

　　建立LogRecord對象。日誌訊息被執行個體為一個LogRecord對象，並在日誌類內處理。

 

轉載於：http://blog.csdn.net/jgood/archive/2009/07/11/4340740.aspx