python通過TimedRotatingFileHandler按時間切割日誌

學一點也是好發表於2019-07-17
Python

通過TimedRotatingFileHandler按時間切割日誌

線上跑了一個定時指令碼，每天生成的日誌檔案都寫在了一個檔案中。但是日誌資訊不可能輸出到單一的一個檔案中。
原因有二：1.日誌檔案越來越大會影響系統的效能。2.日誌檔案格式不夠清晰，比如我想看今天的日誌，不太方便找到的今天的日誌資訊(即使對日誌輸出做了時間提示)
通過設定TimedRotatingFileHandler進行日誌按周(W)、天(D)、時(H)、分(M)、秒(S)切割。
先看一個簡單例子：

import time
import logging
import os
from logging import handlers


def _logging(**kwargs):
    level = kwargs.pop('level', None)
    filename = kwargs.pop('filename', None)
    datefmt = kwargs.pop('datefmt', None)
    format = kwargs.pop('format', None)
    if level is None:
        level = logging.DEBUG
    if filename is None:
        filename = 'default.log'
    if datefmt is None:
        datefmt = '%Y-%m-%d %H:%M:%S'
    if format is None:
        format = '%(asctime)s [%(module)s] %(levelname)s [%(lineno)d] %(message)s'

    log = logging.getLogger(filename)
    format_str = logging.Formatter(format, datefmt)
    # backupCount 儲存日誌的數量，過期自動刪除
    # when 按什麼日期格式切分(這裡方便測試使用的秒)
    th = handlers.TimedRotatingFileHandler(filename=filename, when='S', backupCount=3, encoding='utf-8')
    th.setFormatter(format_str)
    th.setLevel(logging.INFO)
    log.addHandler(th)
    log.setLevel(level)
    return log

os.makedirs("./logs", exist_ok=True)
logger = _logging(filename='./logs/default.log')



if __name__ == '__main__':
    while True:
        time.sleep(0.1)
        logger.info('哈哈哈')

結果如下：
6cbd34660f2e89833322d78c77b4811a

上述程式碼可以正常執行，而且也可以生成固定的日誌個數，但是有一個問題，生成的日誌檔案格式是你的檔名+時間的格式，沒有設定時間的話預設設定到了秒(這裡是按秒切割)
修改日誌格式字尾名稱：

# 在上述程式碼中加入
def namer(filename):
    return filename.split('default.')
th.namer = namer
# 設定為S，預設的suffix為 Y-%m-%d_%H-%M-%S
th.suffix = "%Y-%m-%d_%H-%M-%S.log"

# 為了看的更視覺效果，可以顯示在控制檯答應
cmd = logging.StreamHandler()
cmd.setFormatter(format_str)
cmd.setLevel(level)
log.addHandler(cmd)

執行結果：
f26d7f27295b762d8d3322c9c12a1c85

名字好像可以了，但是日誌好像沒有起到自動刪除的目的啊，而且也沒在之前的log資料夾了。
來看看原始碼：

    def getFilesToDelete(self):
        """
        Determine the files to delete when rolling over.

        More specific than the earlier method, which just used glob.glob().
        """
        dirName, baseName = os.path.split(self.baseFilename)
        fileNames = os.listdir(dirName)
        result = []
        prefix = baseName + "."
        plen = len(prefix)
        for fileName in fileNames:
            if fileName[:plen] == prefix:
                suffix = fileName[plen:]
                if self.extMatch.match(suffix):
                    result.append(os.path.join(dirName, fileName))
        if len(result) < self.backupCount:
            result = []
        else:
            result.sort()
            result = result[:len(result) - self.backupCount]
        return result

這是它的刪除邏輯，關鍵是通過.前面的欄位判斷是否重複，當有特定的重複數後開始刪除。
所以問題來了，要麼自己去重寫原始碼，要麼就只能用default.日期.log這種格式了。
附上平時使用的日誌程式碼

import logging
import os
from logging import handlers


def _logging(**kwargs):
    level = kwargs.pop('level', None)
    filename = kwargs.pop('filename', None)
    datefmt = kwargs.pop('datefmt', None)
    format = kwargs.pop('format', None)
    if level is None:
        level = logging.DEBUG
    if filename is None:
        filename = 'default.log'
    if datefmt is None:
        datefmt = '%Y-%m-%d %H:%M:%S'
    if format is None:
        format = '%(asctime)s [%(module)s] %(levelname)s [%(lineno)d] %(message)s'

    log = logging.getLogger(filename)
    format_str = logging.Formatter(format, datefmt)

    def namer(filename):
        return filename.split('default.')[1]

    # cmd = logging.StreamHandler()
    # cmd.setFormatter(format_str)
    # cmd.setLevel(level)
    # log.addHandler(cmd)

    os.makedirs("./debug/logs", exist_ok=True)
    th_debug = handlers.TimedRotatingFileHandler(filename="./debug/" + filename, when='D', backupCount=3,
                                                 encoding='utf-8')
    # th_debug.namer = namer
    th_debug.suffix = "%Y-%m-%d.log"
    th_debug.setFormatter(format_str)
    th_debug.setLevel(logging.DEBUG)
    log.addHandler(th_debug)

    th = handlers.TimedRotatingFileHandler(filename=filename, when='D', backupCount=3, encoding='utf-8')
    # th.namer = namer
    th.suffix = "%Y-%m-%d.log"
    th.setFormatter(format_str)
    th.setLevel(logging.INFO)
    log.addHandler(th)
    log.setLevel(level)
    return log


os.makedirs('./logs', exist_ok=True)
logger = _logging(filename='./logs/default')

相關文章