python 日誌模塊 logging 詳解

時間 2019-11-07

標籤 python 日誌模塊 logging 詳解欄目 Python 简体版

原文原文鏈接

Java 中最通用的日誌模塊莫過於 Log4j 了，在 python 中，也自帶了 logging 模塊，該模塊的用法其實和 Log4j 相似。html

Python 使用logging模塊記錄日誌涉及四個主要類，使用官方文檔中的歸納最爲合適：python

logger提供了應用程序能夠直接使用的接口；sql

handler將(logger建立的)日誌記錄發送到合適的目的輸出；網絡

filter提供了細度設備來決定輸出哪條日誌記錄；app

formatter決定日誌記錄的最終輸出格式。tcp

logging模塊是在2.3新引進的功能，下面是一些經常使用的類和模塊級函數

模塊級函數
logging.getLogger([name]):返回一個logger對象，若是沒有指定名字將返回root logger
logging.debug()、logging.info()、logging.warning()、logging.error()、logging.critical()：設定root logger的日誌級別
logging.basicConfig():用默認Formatter爲日誌系統創建一個StreamHandler，設置基礎配置並加到root logger中

Logger函數

每一個程序在輸出信息以前都要得到一個Logger。Logger一般對應了程序的模塊名，好比聊天工具的圖形界面模塊能夠這樣得到它的Logger：
LOG=logging.getLogger(」chat.gui」)
而核心模塊能夠這樣：
LOG=logging.getLogger(」chat.kernel」)
Logger.setLevel(lel):指定最低的日誌級別，低於lel的級別將被忽略。debug是最低的內置級別，critical爲最高
Logger.addFilter(filt)、Logger.removeFilter(filt):添加或刪除指定的filter
Logger.addHandler(hdlr)、Logger.removeHandler(hdlr)：增長或刪除指定的handler
Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical()：能夠設置的日誌級別
設置logger的level， level有如下幾個級別：

NOTSET < DEBUG < INFO < WARNING < ERROR < CRITICAL
若是把looger的級別設置爲INFO，那麼小於INFO級別的日誌都不輸出，大於等於INFO級別的日誌都輸出工具

Handlers
handler對象負責發送相關的信息到指定目的地。Python的日誌系統有多種Handler可使用。有些Handler能夠把信息輸出到控制檯，有些Logger能夠把信息輸出到文件，還有些 Handler能夠把信息發送到網絡上。若是以爲不夠用，還能夠編寫本身的Handler。能夠經過addHandler()方法添加多個多handler
Handler.setLevel(lel):指定被處理的信息級別，低於lel級別的信息將被忽略
Handler.setFormatter()：給這個handler選擇一個格式
Handler.addFilter(filt)、Handler.removeFilter(filt)：新增或刪除一個filter對象ui

Formattersthis

Formatter對象設置日誌信息最後的規則、結構和內容，默認的時間格式爲%Y-%m-%d %H:%M:%S，下面是Formatter經常使用的一些信息

%(name)s	Logger的名字
%(levelno)s	數字形式的日誌級別
%(levelname)s	文本形式的日誌級別
%(pathname)s	調用日誌輸出函數的模塊的完整路徑名，可能沒有
%(filename)s	調用日誌輸出函數的模塊的文件名
%(module)s	調用日誌輸出函數的模塊名
%(funcName)s	調用日誌輸出函數的函數名
%(lineno)d	調用日誌輸出函數的語句所在的代碼行
%(created)f	當前時間，用UNIX標準的表示時間的浮點數表示
%(relativeCreated)d	輸出日誌信息時的，自Logger建立以來的毫秒數
%(asctime)s	字符串形式的當前時間。默認格式是「2003-07-08 16:49:45,896」。逗號後面的是毫秒
%(thread)d	線程ID。可能沒有
%(threadName)s	線程名。可能沒有
%(process)d	進程ID。可能沒有
%(message)s	用戶輸出的消息

設置過濾器
細心的朋友必定會發現前文調用logging.getLogger()時參數的格式相似於「A.B.C」。採起這樣的格式其實就是爲了能夠配置過濾器。看一下這段代碼：
LOG=logging.getLogger(」chat.gui.statistic」)
console = logging.StreamHandler()
console.setLevel(logging.INFO)
formatter = logging.Formatter(’%(asctime)s %(levelname)s %(message)s’)
console.setFormatter(formatter)
filter=logging.Filter(」chat.gui」)
console.addFilter(filter)
LOG.addHandler(console)
和前面不一樣的是咱們在Handler上添加了一個過濾器。如今咱們輸出日誌信息的時候就會通過過濾器的處理。名爲「A.B」的過濾器只讓名字帶有「A.B」前綴的Logger輸出信息。能夠添加多個過濾器，只要有一個過濾器拒絕，日誌信息就不會被輸出。另外，在Logger中也能夠添加過濾器。

每一個Logger能夠附加多個Handler。接下來咱們就來介紹一些經常使用的Handler：
1) logging.StreamHandler
使用這個Handler能夠向相似與sys.stdout或者sys.stderr的任何文件對象(file object)輸出信息。它的構造函數是：
StreamHandler([strm])
其中strm參數是一個文件對象。默認是sys.stderr
2) logging.FileHandler
和StreamHandler相似，用於向一個文件輸出日誌信息。不過FileHandler會幫你打開這個文件。它的構造函數是：
FileHandler(filename[,mode])
filename是文件名，必須指定一個文件名。
mode是文件的打開方式。參見Python內置函數open()的用法。默認是’a'，即添加到文件末尾。
3) logging.handlers.RotatingFileHandler
這個Handler相似於上面的FileHandler，可是它能夠管理文件大小。當文件達到必定大小以後，它會自動將當前日誌文件更名，而後建立一個新的同名日誌文件繼續輸出。好比日誌文件是chat.log。當chat.log達到指定的大小以後，RotatingFileHandler自動把文件更名爲chat.log.1。不過，若是chat.log.1已經存在，會先把chat.log.1重命名爲chat.log.2。。。最後從新建立 chat.log，繼續輸出日誌信息。它的構造函數是：
RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]])
其中filename和mode兩個參數和FileHandler同樣。
maxBytes用於指定日誌文件的最大文件大小。若是maxBytes爲0，意味着日誌文件能夠無限大，這時上面描述的重命名過程就不會發生。
backupCount用於指定保留的備份文件的個數。好比，若是指定爲2，當上面描述的重命名過程發生時，原有的chat.log.2並不會被改名，而是被刪除。
4) logging.handlers.TimedRotatingFileHandler
這個Handler和RotatingFileHandler相似，不過，它沒有經過判斷文件大小來決定什麼時候從新建立日誌文件，而是間隔必定時間就自動建立新的日誌文件。重命名的過程與RotatingFileHandler相似，不過新的文件不是附加數字，而是當前時間。它的構造函數是：
TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])
其中filename參數和backupCount參數和RotatingFileHandler具備相同的意義。
interval是時間間隔。
when參數是一個字符串。表示時間間隔的單位，不區分大小寫。它有如下取值：
S 秒
M 分
H 小時
D 天
W 每星期（interval==0時表明星期一）
midnight 天天凌晨
5) logging.handlers.SocketHandler
6) logging.handlers.DatagramHandler
以上兩個Handler相似，都是將日誌信息發送到網絡。不一樣的是前者使用TCP協議，後者使用UDP協議。它們的構造函數是：
Handler(host, port)
其中host是主機名，port是端口名
7) logging.handlers.SysLogHandler
8) logging.handlers.NTEventLogHandler
9) logging.handlers.SMTPHandler
10) logging.handlers.MemoryHandler
11) logging.handlers.HTTPHandler

最後舉個例子吧：

# encoding:utf-8
#import logging

#FORMAT = '%(asctime)-15s %(clientip)s %(user)-8s %(message)s'
#logging.basicConfig(format=FORMAT)
#d = {'clientip': '192.168.0.1', 'user': 'fbloggs'}
#logger = logging.getLogger('tcpserver')
#logger.warning('Protocol problem: %s', 'connection reset', extra=d)

#FORMAT = '%(asctime)-15s %(message)s'
#logging.basicConfig(filename = "C:\\Users\\june\\Desktop\\1.txt", level = logging.DEBUG, filemode = "a", format=FORMAT)  
#logging.debug('this is a message')  
#logging.debug('test')  

#import logging
#import datetime
#
#curDate = datetime.date.today() - datetime.timedelta(days=0)
#logName =  'C:\\Users\\june\\Desktop\\error_%s.log' %curDate
#
#logging.basicConfig(level=logging.INFO,
#				format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
#				#datefmt='%a, %d %b %Y %H:%M:%S',
#				filename=logName,
#				filemode='a')
#
##2013-10-21 03:25:51,509 writeLog.py[line:14] INFO This is info message
##2013-10-21 03:25:51,510 writeLog.py[line:15] WARNING This is warning message
#logging.debug('This is debug message')
#logging.info('This is info message')
#logging.warning('This is warning message')import logging

import logging
logger = logging.getLogger('mylogger')
logger.setLevel(logging.DEBUG)

# print(os.path.join(results.output_dir, 'debug.log'))
fh = logging.FileHandler(os.path.join(results.output_dir, 'debug.log'))
fh.setLevel(logging.INFO)

sh = logging.StreamHandler()
sh.setLevel(logging.DEBUG)

formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
fh.setFormatter(formatter)
sh.setFormatter(formatter)

logger.addHandler(fh)
logger.addHandler(sh)

logger.debug(results.output_dir + 'debug.log')

# 定義logger模塊，root是父類，必需存在的，其它的是自定義。
# logging.getLogger(NAME)便至關於向logging模塊註冊了一種日誌打印
# name 中用 . 表示 log 的繼承關係
[loggers]
keys=root,infoLogger,errorLogger

# 定義handler
[handlers]
keys=infoHandler,errorHandler

# 定義格式化輸出
[formatters]
keys=infoFmt,errorFmt

#--------------------------------------------------
# 實現上面定義的logger模塊，必需是[logger_xxxx]這樣的形式
#--------------------------------------------------
# [logger_xxxx] logger_模塊名稱
# level     級別，級別有DEBUG、INFO、WARNING、ERROR、CRITICAL
# handlers  處理類，能夠有多個，用逗號分開
# qualname  logger名稱，應用程序經過 logging.getLogger獲取。對於不能獲取的名稱，則記錄到root模塊。
# propagate 是否繼承父類的log信息，0:否 1:是
[logger_root]
level=INFO
handlers=errorHandler

[logger_errorLogger]
level=ERROR
handlers=errorHandler
propagate=0
qualname=errorLogger

[logger_infoLogger]
level=INFO
handlers=infoHandler
propagate=0
qualname=infoLogger

#--------------------------------------------------
# handler
#--------------------------------------------------
# [handler_xxxx]
# class handler類名
# level 日誌級別
# formatter，上面定義的formatter
# args handler初始化函數參數

[handler_infoHandler]
class=StreamHandler
level=INFO
formatter=infoFmt
args=(sys.stdout,)

[handler_errorHandler]
class=logging.handlers.TimedRotatingFileHandler
level=ERROR
formatter=errorFmt
# When computing the next rollover time for the first time (when the handler is created),
# the last modification time of an existing log file, or else the current time,
# is used to compute when the next rotation will occur.
# 這個功能太雞肋了，是從handler被建立的時間算起，不能按天然時間 rotation 切分，除非程序一直運行，不然這個功能會有問題
# 臨時解決方案參考下面的連接：Python 多進程日誌記錄
# http://blogread.cn/it/article/4175?f=wb2
args=('C:\\Users\\june\\Desktop\\error.log', 'M', 1, 5)

#--------------------------------------------------
# 日誌格式
#--------------------------------------------------
# %(asctime)s       年-月-日 時-分-秒,毫秒 2013-04-26 20:10:43,745
# %(filename)s      文件名，不含目錄
# %(pathname)s      目錄名，完整路徑
# %(funcName)s      函數名
# %(levelname)s     級別名
# %(lineno)d        行號
# %(module)s        模塊名
# %(message)s       消息體
# %(name)s          日誌模塊名
# %(process)d       進程id
# %(processName)s   進程名
# %(thread)d        線程id
# %(threadName)s    線程名

[formatter_infoFmt]
format=%(asctime)s %(levelname)s %(message)s
datefmt=
class=logging.Formatter

[formatter_errorFmt]
format=%(asctime)s %(levelname)s %(message)s
datefmt=
class=logging.Formatter

##############################################################################
##############################################################################

# -*- coding:utf8 -*-

[loggers]
keys=root,infoLogger,errorLogger

[handlers]
keys=infoHandler,errorHandler

[formatters]
keys=infoFmt,errorFmt

[logger_root]
level=INFO
handlers=errorHandler

[logger_errorLogger]
level=DEBUG
handlers=errorHandler,infoHandler
propagate=0
qualname=errorLogger

[logger_infoLogger]
level=INFO
handlers=infoHandler
propagate=0
qualname=infoLogger

#--------------------------------------------------
# handler
#--------------------------------------------------


[handler_infoHandler]
class=StreamHandler
level=INFO
formatter=infoFmt
args=(sys.stdout,)

[handler_errorHandler]
class=FileHandler
level=DEBUG
formatter=errorFmt
args=(r'C:\Users\Jun\Desktop\debug.log', 'a')


[formatter_infoFmt]
format=%(asctime)s %(levelname)s %(message)s
datefmt=
class=logging.Formatter

[formatter_errorFmt]
format=%(asctime)s %(levelname)s %(message)s
datefmt=
class=logging.Formatter

# encoding: utf-8
# parse_slow_log.py -f C:\Users\Jun\Desktop\tjtx-103-26-slow.log.2017-08-29 -d C:\Users\Jun\Desktop
# 解析 MySQL 慢查詢日誌
import os, sys, argparse
import logging
import logging.config

# logging.config.fileConfig("logging.conf")

script_path = os.path.split(os.path.realpath(__file__))[0]

DEBUG = True  # 標記是否在開發環境


# 給過濾器使用的判斷
class RequireDebugTrue(logging.Filter):
    # 實現filter方法
    def filter(self, record):
        return DEBUG


parser = argparse.ArgumentParser()
parser.add_argument('-f', action='store', dest='slowlog',
                    help='slowlog')
parser.add_argument('-d', action='store', dest='output_dir',
                    help='output_dir', default=script_path)

results = parser.parse_args()
if results.slowlog is None:
    parser.exit(1, parser.format_usage())

debug_log_path = os.path.join(results.output_dir if results.output_dir else script_path, 'debug.log')

log_config_dict = {
    "version": 1,
    'disable_existing_loggers': False,  # 是否禁用現有的記錄器

    # 日誌管理器集合
    'loggers': {
        # 管理器
        'default': {
            'handlers': ['console', 'log'],
            'level': 'DEBUG',
            'propagate': True,  # 是否傳遞給父記錄器
        },
    },

    # 處理器集合
    'handlers': {
        # 輸出到控制檯
        'console': {
            'level': 'DEBUG',  # 輸出信息的最低級別
            'class': 'logging.StreamHandler',
            'formatter': 'standard',  # 使用standard格式
            'filters': ['require_debug_true', ],  # 僅當 DEBUG = True 該處理器才生效
        },
        # 輸出到文件
        'log': {
            'level': 'DEBUG',
            'class': 'logging.handlers.RotatingFileHandler',
            'formatter': 'standard',
            'filename': debug_log_path,  # 輸出位置
            'maxBytes': 1024 * 1024 * 5,  # 文件大小 5M
            'backupCount': 5,  # 備份份數
            'encoding': 'utf8',  # 文件編碼
        },
    },
    # 過濾器
    'filters': {
        'require_debug_true': {
            '()': RequireDebugTrue,
        }
    },

    # 日誌格式集合
    'formatters': {
        # 標準輸出格式
        'standard': {
            # [具體時間][線程名:線程ID][日誌名字:日誌級別名稱(日誌級別ID)] [輸出的模塊:輸出的函數]:日誌內容
            'format': '[%(asctime)s][%(threadName)s:%(thread)d][%(name)s:%(levelname)s(%(lineno)d)]--[%(module)s:%(funcName)s]:%(message)s'
        }
    }
}

logging.config.dictConfig(log_config_dict)
logger_info = logging.getLogger("default")


class Parse_MySQL_Slow_Log:
    __auther = "June"

    sql_count = 0
    file_rows = 0
    word_list = None
    file_list = None
    word_file_dict = None

    def __init__(self, slowlog):
        self.slowlog = slowlog
        self.word_list = ['select', 'load', 'delete', 'update', 'insert', 'other']
        self.file_list = [os.path.join(results.output_dir, str(i) + ".sql") for i in self.word_list]
        self.word_file_dict = dict(zip(self.word_list, self.file_list))

    @staticmethod
    def rm_file(file_list):
        for _ in file_list:
            if os.path.exists(_):
                os.remove(_)
                logger_info.debug(_)

    def write_file(self, file_name, data):
        with open(file_name, 'a') as file_handler:
            if type(data) is list:
                for item in data:
                    file_handler.write(item)
                file_handler.write("\n")
                # 文件條數計數器
                Parse_MySQL_Slow_Log.sql_count += 1
                logger_info.info("sql count:" + str(Parse_MySQL_Slow_Log.sql_count))
            else:
                file_handler.write(data)

    def parse_log(self):
        with open(self.slowlog, encoding="utf8") as f:
            tmp_list = []
            flag = 0
            flag_word = ""
            self.rm_file(self.file_list)
            for line in f:
                Parse_MySQL_Slow_Log.file_rows += 1
                logger_info.info(">>>>>>>>>>>> file rows:" + str(Parse_MySQL_Slow_Log.file_rows))
                if line.startswith('#'):
                    flag += 1

                for word in self.word_list:
                    if word in line.lower():
                        flag_word = word
                        logger_info.debug("----------------------------" + word)

                if 0 < flag <= 3:
                    tmp_list.append(line)

                elif flag == 4:
                    flag = 1
                    self.write_file(self.word_file_dict.get(flag_word, self.word_file_dict.get("other")), tmp_list)
                    tmp_list.clear()
                    tmp_list.append(line)
                    flag_word = ""

            self.write_file(self.word_file_dict.get(flag_word, self.word_file_dict.get("other")), tmp_list)


if __name__ == '__main__':
    parse_log = Parse_MySQL_Slow_Log(results.slowlog)
    parse_log.parse_log()

Python標準模塊logging http://blog.csdn.net/fxjtoday/article/details/6307285

Logging Cookbook http://docs.python.org/2/howto/logging-cookbook.html

REF：

[1] [精華] [翻譯]python的logging模塊配置文件的格式

http://www.python88.com/topic/85

[2] Python多進程log日誌切分錯誤的解決方案

http://bit.ly/2wtkNDJ

[3] Python 多進程日誌記錄

http://blogread.cn/it/article/4175?f=wb2

[4] Python日誌管理(logging模塊)

http://yshblog.com/blog/125

[5] argparse - 命令行選項與參數解析（譯）