一、簡介
這裡介紹在python中的日誌記錄，流程邏輯與java中類似。日誌記錄包含Logger(日誌記錄器)、Handler(日誌輸出地)、 Filter(過濾器)、Formatter(日誌輸出格式)以及日誌級別等。下面進行分別介紹。
二、內容
2.1 日誌級別
日誌的級別及相就數值如下：
CRITICAL = 50
FATAL = CRITICAL
ERROR = 40
WARNING = 30
WARN = WARNING
INFO = 20
DEBUG = 10
NOTSET = 0
2.2 handler日誌輸出地
handler定義日誌輸出目的地，有如下目的地:
StreamHandler：輸出到流,如標準輸出、錯誤輸出
FileHandler：輸出到檔案
RotatingFileHandler：輸出到檔案，按檔案大小歸檔
TimedRotatingFileHandler：輸出到檔案，按時間歸檔
HTTPHandler：輸出到http
SMTPHandler：輸出到郵件
NullHandler：不輸出
2.3 formatter日誌格式
透過logging.Formatter方法定義日誌格式，具體如下：
日誌格式定義方法：logging.Formatter(self, fmt=None, datefmt=None, style='%')
引數：
fmt:訊息格式化
datefmt:日期格式化
style：預設為%,指定格式格式化的佔位符，可選值為'%', '{' or '$'
訊息格式的常用變數如下：
%(name)s:日誌名稱
%(levelno)s:日誌級別,數字形式
%(levelname)s:日誌級別
%(pathname)s:日誌路徑名
%(filename)s:日誌檔名
%(module)s:日誌模組名
%(funcName)s:日誌所在方法名
%(lineno)d:日誌所在程式碼行
%(asctime)s:當前時間
%(thread)d:執行緒id
%(threadName)s:執行緒名稱
%(process)d:程序id
%(message)s:訊息
2.4 filter過濾器
由logging.Filter()生成過濾器，過濾引數與formatter變數類似，具體變數引數在logging.LogRecord類中
三、示例
3.1 配置檔案logging.json
定義json格式配置檔案logging.json，示例如下：
{
"version": 1,
"disable_existing_loggers": false,
"formatters": {
"simple": {
"format": "%(asctime)s %(name)s [%(levelname)s] %(funcName)s %(message)s"
}
},
"handlers": {
"streamHandler": {
"class": "logging.StreamHandler",
"level": "DEBUG",
"formatter": "simple",
"stream": "ext://sys.stdout"
},
"timedRotatingFileHandler": {
"class": "logging.handlers.TimedRotatingFileHandler",
"level": "DEBUG",
"formatter": "simple",
"filename": "../logs/test_log.log",
"when":"midnight"
}
},
"root": {
"level": "INFO",
"handlers": [
"streamHandler",
"timedRotatingFileHandler"
]
}
}
3.2 程式碼示例
import datetime
import json
import logging.config
import os
from logging.handlers import TimedRotatingFileHandler
# 程式碼中建立輸出handler,每個日誌一個單獨檔案
def get_logger(name='all', level='INFO'):
# 訊息格式化
log_format = logging.Formatter('%(asctime)s %(levelname)s %(message)s')
# 時間格式化
date_format = '%Y-%m-%d %H:%M:%S'
# 日誌初始化配置,僅第一次配置有效,後續修改不起作用
# logging.basicConfig(filename="main.log", level=logging.DEBUG, format=log_format, datefmt=date_format)
# 基於時間歸檔日誌檔案,filename:日誌檔名, when:歸檔觸發時間, backupCount:日誌保留個數
handler = TimedRotatingFileHandler(filename="../logs/{}.log".format(name),
when='midnight',
atTime=datetime.time(0, 0, 0, 0),
backupCount=20)
handler.setFormatter(log_format)
handler.suffix = '%Y-%m-%d'
# 輸出到控制檯
streamHandler = logging.StreamHandler()
streamHandler.setFormatter(log_format)
test_filter = logging.Filter()
# 過濾器，根據日誌訊息過濾
test_filter.filter = lambda record: 'test' in record.message
# 過濾器，根據日誌級別過濾
# test_filter.filter = lambda record: record.levelno > logging.INFO
streamHandler.addFilter(test_filter)
# 獲取logger
logger = logging.getLogger(name)
# 指定日誌級別
logger.setLevel(level)
# 新增handler
logger.addHandler(handler)
logger.addHandler(streamHandler)
return logger
pass
# 從json配置檔案中配置日誌,獲取logger
def get_logger_from_json_config(name='all', level='INFO'):
logger_config_file = '../logging.json'
if os.path.exists(logger_config_file):
with open(logger_config_file, encoding='UTF-8') as f:
cfg = json.load(f)
logging.config.dictConfig(cfg)
logger = logging.getLogger(name)
logger.setLevel(level)
return logger
def main():
# 根據程式碼配置獲取logger
logger = get_logger('log_study', 'INFO')
# 根據json格式的配置檔案獲取logger
# logger = get_logger_from_json_config('log_study_1', 'DEBUG')
logger.debug("%s log", 'debug')
logger.info("%s log", 'info')
logger.warning("%s log", 'warning test')
logger.error("%s log", 'error')
logger.fatal("%s log", 'fatal')
if __name__ == '__main__':
main()
日誌輸出示例如下：
2019-01-22 23:17:53,315 INFO info log
2019-01-22 23:17:53,318 WARNING warning test log
2019-01-22 23:17:53,319 ERROR error log
2019-01-22 23:17:53,319 CRITICAL fatal log