原文:
https://my.oschina.net/leejun2005/blog/126713
http://www.stamhe.com/?p=862
Python 使用logging模塊記錄日志涉及四個(gè)主要類,使用官方文檔中的概括最為合適:
- logger提供了應(yīng)用程序可以直接使用的接口;
- handler將(logger創(chuàng)建的)日志記錄發(fā)送到合適的目的輸出;
- filter提供了細(xì)度設(shè)備來(lái)決定輸出哪條日志記錄;
- formatter決定日志記錄的最終輸出格式。
模塊級(jí)函數(shù)
logging.getLogger([name]):返回一個(gè)logger對(duì)象,如果沒(méi)有指定名字將返回root logger:
- logging.debug()、logging.info()、logging.warning()、logging.error()、logging.critical():設(shè)定root logger的日志級(jí)別
- logging.basicConfig():用默認(rèn)Formatter為日志系統(tǒng)建立
*StreamHandler,設(shè)置基礎(chǔ)配置并加到root logger中
logger:
每個(gè)程序在輸出信息之前都要獲得一個(gè)Logger。Logger通常對(duì)應(yīng)了程序的模塊名,比如聊天工具的圖形界面模塊可以這樣獲得它的Logger:
LOG=logging.getLogger(”chat.gui”)
而核心模塊可以這樣:
LOG=logging.getLogger(”chat.kernel”)
Logger.setLevel(lel):指定最低的日志級(jí)別,低于lel的級(jí)別將被忽略。debug是最低的內(nèi)置級(jí)別,critical為最高
Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical():可以設(shè)置的日志級(jí)別
Handlers:
handler對(duì)象負(fù)責(zé)發(fā)送相關(guān)的信息到指定目的地。
Python的日志系統(tǒng)有多種Handler可以使用。
- logging.StreamHandler() 信息輸出到控制臺(tái)
- logging.FileHandler() 把信息輸出到文件
- logging.handlers.HTTPHandler: 通過(guò)"GET"或"POST"遠(yuǎn)程輸出到HTTP服務(wù)器
- logging.handlers.SMTPHandler 遠(yuǎn)程輸出日志到郵件地址
上面的方法返回一個(gè)Handler對(duì)象
- addHandler() 可以通過(guò)方法添加多個(gè)handler.
- Handler.setLevel(lel):指定被處理的信息級(jí)別,低于lel級(jí)別的信息將被忽略
- Handler.setFormatter():給這個(gè)handler選擇一個(gè)格式
- Handler.addFilter(filt)、Handler.removeFilter(filt):新增或刪除一個(gè)filter對(duì)象
example:
console = logging.StreamHandler()
# 打到屏幕上
console.setLevel(logging.INFO)
# 這個(gè)Level不起作用么??
formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s')
# 日志格式
console.setFormatter(formatter)
# 選定格式
logging.getLogger('').addHandler(console)
# 添加多個(gè)Handler
Formatters
Formatter對(duì)象設(shè)置日志信息最后的規(guī)則、結(jié)構(gòu)和內(nèi)容,默認(rèn)的時(shí)間格式為%Y-%m-%d %H:%M:%S,下面是Formatter常用的一些信息 :

example:
# !/usr/bin/python
# encoding=utf-8
import logging
logging.basicConfig(level=logging.DEBUG,
format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
datefmt='%a, %d %b %Y %H:%M:%S',
filename='myapp.log',
filemode='w')
# level: logging.DEBUG 最低級(jí)別(會(huì)打印所有), 默認(rèn)日志級(jí)別為logging.WARNING
# format: asctime -> 當(dāng)前時(shí)間
# filename -> 調(diào)用函數(shù)的文件名
# lineno -> 調(diào)用日志輸出的代碼行
# levelname -> 文本形式的日志級(jí)別
# message -> 用戶輸出的信息
# datefmt: 指定時(shí)間格式,同time.strftime()
# stream: 指定將日志的輸出流,可以指定輸出到sys.stderr,sys.stdout或者文件,默認(rèn)輸出到sys.stderr,當(dāng)stream和 filename同時(shí)指定時(shí),stream被忽略
# filename: 指定日志文件名
# filemode: 和file函數(shù)意義相同,指定日志文件的打開模式,’w’或’a’
logging.debug('This is debug message')
logging.info('This is info message')
logging.warning('This is warning message')
longging日志回滾
import logging
from logging.handlers import RotatingFileHandler
#################################################################################################
#定義一個(gè)RotatingFileHandler,最多備份5個(gè)日志文件,每個(gè)日志文件最大10M
Rthandler = RotatingFileHandler('myapp.log', maxBytes=10*1024*1024,backupCount=5)
Rthandler.setLevel(logging.INFO)
formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s')
Rthandler.setFormatter(formatter)
logging.getLogger('').addHandler(Rthandler)
################################################################################################
從上例和本例可以看出,logging有一個(gè)日志處理的主對(duì)象,其它處理方式都是通過(guò)addHandler添加進(jìn)去的。
logging的幾種handle方式如下:
logging.StreamHandler: 日志輸出到流,可以是sys.stderr、sys.stdout或者文件
logging.FileHandler: 日志輸出到文件
日志回滾方式,實(shí)際使用時(shí)用RotatingFileHandler和TimedRotatingFileHandler
logging.handlers.BaseRotatingHandler
logging.handlers.RotatingFileHandler
logging.handlers.TimedRotatingFileHandler
logging.handlers.SocketHandler: 遠(yuǎn)程輸出日志到TCP/IP sockets
logging.handlers.DatagramHandler: 遠(yuǎn)程輸出日志到UDP sockets
logging.handlers.SMTPHandler: 遠(yuǎn)程輸出日志到郵件地址
logging.handlers.SysLogHandler: 日志輸出到syslog
logging.handlers.NTEventLogHandler: 遠(yuǎn)程輸出日志到Windows NT/2000/XP的事件日志
logging.handlers.MemoryHandler: 日志輸出到內(nèi)存中的制定buffer
logging.handlers.HTTPHandler: 通過(guò)"GET"或"POST"遠(yuǎn)程輸出到HTTP服務(wù)器
logging.config.fileConfig
上面的例子是將日志打印配置寫在代碼里的,實(shí)際上我們用的時(shí)候更多是將其寫在單獨(dú)的一個(gè)配置文件里,方便修改:
#logger.conf
###############################################
[loggers]
keys=root,example01,example02
[logger_root]
level=DEBUG
handlers=hand01,hand02
[logger_example01]
handlers=hand02
qualname=example01
propagate=0
[logger_example02]
handlers=hand01,hand03
qualname=example02
propagate=0
###############################################
[handlers]
keys=hand01,hand02,hand03
[handler_hand01]
class=StreamHandler
level=INFO
formatter=form02
args=(sys.stderr,)
[handler_hand02]
class=FileHandler
level=DEBUG
formatter=form01
args=('myapp.log', 'a')
[handler_hand03]
class=handlers.RotatingFileHandler
level=INFO
formatter=form02
args=('myapp.log', 'a', 10*1024*1024, 5)
###############################################
[formatters]
keys=form01,form02
[formatter_form01]
format=%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s
datefmt=%a, %d %b %Y %H:%M:%S
[formatter_form02]
format=%(name)-12s:%(asctime)s: %(levelname)-8s %(message)s
datefmt=%a, %d %b %Y %H:%M:%S
[formatter_form03]
format=%(name)-12s: %(levelname)-8s %(message)s
datefmt=
配置中
args=(sys.stderr) 屏幕打印
hand03中的RotatingFileHandler 當(dāng)file滿了10M時(shí),會(huì)將log文件myapp.log 備份, 重新命名為myapp.log.1, 以此類推。
而FileHandler默認(rèn)值保存一個(gè)文件, 不限大小
代碼中調(diào)用日志配置文件:
logging.config.fileConfig("logging.conf")
# 讀取配置文件
logger = logging.getLogger("example01")
# 返回一個(gè)logger對(duì)象,如果沒(méi)有指定名字將返回root logger