日志
日志是跟蹤軟件運(yùn)行時所發(fā)生的事件的一種方法浇衬。軟件開發(fā)者在代碼中調(diào)用日志函數(shù)枫弟,表明發(fā)生了特定的事件阳掐。事件由描述性消息描述,該描述性消息可以可選地包含可變數(shù)據(jù)(即武福,對于事件的每次出現(xiàn)都潛在地不同的數(shù)據(jù))议双。事件還具有開發(fā)者歸因于事件的重要性;重要性也可以稱為級別或嚴(yán)重性捉片。
logging提供了一組便利的函數(shù)平痰,用來做簡單的日志。它們是 debug()伍纫、 info()宗雇、 warning()、 error() 和 critical()翻斟。
logging函數(shù)根據(jù)它們用來跟蹤的事件的級別或嚴(yán)重程度來命名逾礁。標(biāo)準(zhǔn)級別及其適用性描述如下(以嚴(yán)重程度遞增排序):
級別 | 何時使用 |
---|---|
DEBUG |
詳細(xì)信息说铃,一般只在調(diào)試問題時使用访惜。 |
INFO |
證明事情按預(yù)期工作。 |
WARNING |
某些沒有預(yù)料到的事件的提示腻扇,或者在將來可能會出現(xiàn)的問題提示债热。例如:磁盤空間不足。但是軟件還是會照常運(yùn)行幼苛。 |
ERROR |
由于更嚴(yán)重的問題窒篱,軟件已不能執(zhí)行一些功能了。 |
CRITICAL |
嚴(yán)重錯誤舶沿,表明軟件已不能繼續(xù)運(yùn)行了墙杯。 |
級別 | 數(shù)字值 |
---|---|
CRITICAL |
50 |
ERROR |
40 |
WARNING |
30 |
INFO |
20 |
DEBUG |
10 |
NOTSET |
0 |
默認(rèn)等級是WARNING
,這意味著僅僅這個等級及以上的才會反饋信息括荡,除非logging模塊被用來做其它事情高镐。
被跟蹤的事件能以不同的方式被處理。最簡單的處理方法就是把它們在控制臺上打印出來畸冲。另一種常見的方法就是寫入磁盤文件嫉髓。
一观腊、打印到控制臺
import logging
logging.debug('debug 信息')
logging.warning('只有這個會輸出。算行。梧油。')
logging.info('info 信息')</pre>
由于默認(rèn)設(shè)置的等級是warning,所有只有warning的信息會輸出到控制臺州邢。
WARNING:root:只有這個會輸出儡陨。。量淌。
利用logging.basicConfig()打印信息到控制臺
import logging
logging.basicConfig(format='%(asctime)s - %(pathname)s[line:%(lineno)d] - %(levelname)s: %(message)s',
level=logging.DEBUG)
logging.debug('debug 信息')
logging.info('info 信息')
logging.warning('warning 信息')
logging.error('error 信息')
logging.critical('critial 信息')</pre>
由于在logging.basicConfig()中的level 的值設(shè)置為logging.DEBUG, 所有debug, info, warning, error, critical 的log都會打印到控制臺迄委。
日志級別: debug < info < warning < error < critical
logging.debug('debug級別,最低級別类少,一般開發(fā)人員用來打印一些調(diào)試信息')
logging.info('info級別叙身,正常輸出信息,一般用來打印一些正常的操作')
logging.warning('waring級別硫狞,一般用來打印警信息')
logging.error('error級別信轿,一般用來打印一些錯誤信息')
logging.critical('critical 級別,一般用來打印一些致命的錯誤信息,等級最高')</pre>
所以如果設(shè)置level = logging.info()的話残吩,debug 的信息則不會輸出到控制臺财忽。
二、利用logging.basicConfig()保存log到文件
logging.basicConfig(level=logging.DEBUG,#控制臺打印的日志級別
filename='new.log',
filemode='a',##模式泣侮,有w和a即彪,w就是寫模式,每次都會重新寫日志活尊,覆蓋之前的日志
#a是追加模式隶校,默認(rèn)如果不寫的話,就是追加模式
format=
'%(asctime)s - %(pathname)s[line:%(lineno)d] - %(levelname)s: %(message)s'
#日志格式
如果在logging.basicConfig()設(shè)置filename 和filemode蛹锰,則只會保存log到文件深胳,不會輸出到控制臺。
三铜犬、既往屏幕輸入舞终,也往文件寫入log
logging庫采取了模塊化的設(shè)計(jì),提供了許多組件:記錄器癣猾、處理器敛劝、過濾器和格式化器。
- Logger 暴露了應(yīng)用程序代碼能直接使用的接口纷宇。
- Handler將(記錄器產(chǎn)生的)日志記錄發(fā)送至合適的目的地夸盟。
- Filter提供了更好的粒度控制,它可以決定輸出哪些日志記錄呐粘。
- Formatter 指明了最終輸出中日志記錄的布局满俗。
Loggers:
Logger 對象要做三件事情转捕。首先,它們向應(yīng)用代碼暴露了許多方法唆垃,這樣應(yīng)用可以在運(yùn)行時記錄消息五芝。其次,記錄器對象通過嚴(yán)重程度(默認(rèn)的過濾設(shè)施)或者過濾器對象來決定哪些日志消息需要記錄下來辕万。第三枢步,記錄器對象將相關(guān)的日志消息傳遞給所有感興趣的日志處理器。
常用的記錄器對象的方法分為兩類:配置和發(fā)送消息渐尿。
這些是最常用的配置方法:
Logger.setLevel()指定logger將會處理的最低的安全等級日志信息, debug是最低的內(nèi)置安全等級醉途,critical是最高的內(nèi)建安全等級。例如砖茸,如果嚴(yán)重程度為INFO隘擎,記錄器將只處理INFO,WARNING凉夯,ERROR和CRITICAL消息货葬,DEBUG消息被忽略。
Logger.addHandler()和Logger.removeHandler()從記錄器對象中添加和刪除處理程序?qū)ο缶⒐弧L幚砥髟斠奌andlers震桶。
Logger.addFilter()和Logger.removeFilter()從記錄器對象添加和刪除過濾器對象。
Handlers
處理程序
對象負(fù)責(zé)將適當(dāng)?shù)娜罩鞠ⅲɑ谌罩鞠⒌膰?yán)重性)分派到處理程序的指定目標(biāo)征绎。Logger
對象可以通過addHandler()
方法增加零個或多個handler對象蹲姐。舉個例子,一個應(yīng)用可以將所有的日志消息發(fā)送至日志文件人柿,所有的錯誤級別(error)及以上的日志消息發(fā)送至標(biāo)準(zhǔn)輸出柴墩,所有的嚴(yán)重級別(critical)日志消息發(fā)送至某個電子郵箱。在這個例子中需要三個獨(dú)立的處理器顷扩,每一個負(fù)責(zé)將特定級別的消息發(fā)送至特定的位置拐邪。
常用的有4種:
1.logging.StreamHandler -> 控制臺輸出
使用這個Handler可以向類似與sys.stdout或者sys.stderr的任何文件對象(file object)輸出信息慰毅。
它的構(gòu)造函數(shù)是:
StreamHandler([strm])
其中strm參數(shù)是一個文件對象隘截。默認(rèn)是sys.stderr
2) logging.FileHandler -> 文件輸出
和StreamHandler類似,用于向一個文件輸出日志信息汹胃。不過FileHandler會幫你打開這個文件婶芭。它的構(gòu)造函數(shù)是:
FileHandler(filename[,mode])
filename是文件名,必須指定一個文件名着饥。
mode是文件的打開方式犀农。默認(rèn)是’a',即添加到文件末尾宰掉。
3.logging.handlers.RotatingFileHandler** **-> 按照大小自動分割日志文件呵哨,一旦達(dá)到指定的大小重新生成文件
這個Handler類似于上面的FileHandler赁濒,但是它可以管理文件大小。當(dāng)文件達(dá)到一定大小之后孟害,它會自動將當(dāng)前日志文件改名拒炎,然后創(chuàng)建 一個新的同名日志文件繼續(xù)輸出。比如日志文件是chat.log挨务。當(dāng)chat.log達(dá)到指定的大小之后击你,RotatingFileHandler自動把 文件改名為chat.log.1。不過谎柄,如果chat.log.1已經(jīng)存在丁侄,會先把chat.log.1重命名為chat.log.2。朝巫。鸿摇。最后重新創(chuàng)建 chat.log,繼續(xù)輸出日志信息劈猿。它的構(gòu)造函數(shù)是:
RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]])
其中filename和mode兩個參數(shù)和FileHandler一樣户辱。
maxBytes用于指定日志文件的最大文件大小。如果maxBytes為0糙臼,意味著日志文件可以無限大庐镐,這時上面描述的重命名過程就不會發(fā)生。
backupCount用于指定保留的備份文件的個數(shù)变逃。比如必逆,如果指定為2,當(dāng)上面描述的重命名過程發(fā)生時揽乱,原有的chat.log.2并不會被更名名眉,而是被刪除。
4. logging.handlers.TimedRotatingFileHandler ->** **按照時間自動分割日志文件
這個Handler和RotatingFileHandler類似凰棉,不過损拢,它沒有通過判斷文件大小來決定何時重新創(chuàng)建日志文件,而是間隔一定時間就 自動創(chuàng)建新的日志文件撒犀。重命名的過程與RotatingFileHandler類似福压,不過新的文件不是附加數(shù)字,而是當(dāng)前時間或舞。它的構(gòu)造函數(shù)是:
TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])
其中filename參數(shù)和backupCount參數(shù)和RotatingFileHandler具有相同的意義荆姆。
interval是時間間隔。
when參數(shù)是一個字符串映凳。表示時間間隔的單位胆筒,不區(qū)分大小寫。它有以下取值:
S 秒
M 分
H 小時
D 天
W 每星期(interval==0時代表星期一)
midnight 每天凌晨
配置方法:
-
setLevel()
方法和日志對象的一樣诈豌,指明了將會分發(fā)日志的最低級別仆救。為什么會有兩個setLevel()
方法抒和?記錄器的級別決定了消息是否要傳遞給處理器。每個處理器的級別決定了消息是否要分發(fā)彤蔽。 -
setFormatter()
為該處理器選擇一個格式化器构诚。 -
addFilter()
和removeFilter()
分別配置和取消配置處理程序上的過濾器對象。
Formatters
Formatter對象設(shè)置日志信息最后的規(guī)則铆惑、結(jié)構(gòu)和內(nèi)容范嘱,默認(rèn)的時間格式為%Y-%m-%d %H:%M:%S,下面是Formatter常用的一些信息
Formatter對象設(shè)置日志信息最后的規(guī)則员魏、結(jié)構(gòu)和內(nèi)容丑蛤,默認(rèn)的時間格式為%Y-%m-%d %H:%M:%S,下面是Formatter常用的一些信息
信息 | 含義 |
---|---|
%(name)s | Logger的名字 |
%(levelno)s | 數(shù)字形式的日志級別 |
%(levelname)s | 文本形式的日志級別 |
%(pathname)s | 調(diào)用日志輸出函數(shù)的模塊的完整路徑名撕阎,可能沒有 |
%(filename)s | 調(diào)用日志輸出函數(shù)的模塊的文件名 |
%(module)s | 調(diào)用日志輸出函數(shù)的模塊名 |
%(funcName)s | 調(diào)用日志輸出函數(shù)的函數(shù)名 |
%(lineno)d | 調(diào)用日志輸出函數(shù)的語句所在的代碼行 |
%(created)f | 當(dāng)前時間受裹,用UNIX標(biāo)準(zhǔn)的表示時間的浮 點(diǎn)數(shù)表示 |
%(relativeCreated)d | 輸出日志信息時的,自Logger創(chuàng)建以 來的毫秒數(shù) |
%(asctime)s | 字符串形式的當(dāng)前時間虏束。默認(rèn)格式是 “2003-07-08 16:49:45,896”棉饶。逗號后面的是毫秒 |
%(thread)d | 線程ID≌蛟龋可能沒有 |
%(threadName)s | 線程名照藻。可能沒有 |
%(process)d | 進(jìn)程ID汗侵⌒衣疲可能沒有 |
%(message)s | 用戶輸出的消息 |
需求:
輸出log到控制臺以及將日志寫入log文件。
保存debug以上的log類型晰韵, 同時按照時間自動分割日志文件发乔。
import os
import logging
import re
from logging.handlers import TimedRotatingFileHandler
currentPath = os.path.dirname(__file__) + '/logs/'
def setup_log(log_name):
# 創(chuàng)建logger對象。傳入logger名字
logger = logging.getLogger(log_name)
log_path = os.path.join(currentPath, log_name)
# 設(shè)置日志記錄等級
logger.setLevel(logging.DEBUG)
# interval 滾動周期雪猪,
# when="MIDNIGHT", interval=1 表示每天0點(diǎn)為更新點(diǎn)栏尚,每天生成一個文件
# backupCount 表示日志保存?zhèn)€數(shù)
file_handler = TimedRotatingFileHandler(
filename=log_path, when="MIDNIGHT", interval=1, backupCount=30
)
# filename="mylog" suffix設(shè)置,會生成文件名為mylog.2020-02-25.log
file_handler.suffix = "%Y-%m-%d.log" # 生成的日志是xxx.日期.log
# extMatch是編譯好正則表達(dá)式只恨,用于匹配日志文件名后綴
# 需要注意的是suffix和extMatch一定要匹配的上译仗,如果不匹配,過期日志不會被刪除坤次。
file_handler.extMatch = re.compile(r"^\d{4}-\d{2}-\d{2}.log$")
# 定義日志輸出格式
format_str = '[%(asctime)s - %(name)s]%(levelname)s: %(message)s - %(filename)s:%(lineno)d ')
formatter = logging.Formatter(format_str, '%Y-%m-%dT%H:%M:%SZ')
file_handler.setFormatter(logging.Formatter(format_str)) # 設(shè)置寫入日志文件
streamHandler = logging.StreamHandler() # 設(shè)置日志在控制臺輸出
streamHandler.setFormatter(formatter) # 設(shè)置控制臺中輸出日志格式
logger.addHandler(file_handler)
logger.addHandler(streamHandler)
return logger
if __name__ == "__main__":
logger = setup_log("mylog")
logger.info("this is info message")
logger.warning("this is a warning message")
try:
int("xjk")
except ValueError as e:
logger.error(e)
# 如果其他py文件想使用此配置日志古劲,只需 logging.getLogger(日志的名字) 即可