Python日誌功能與處理邏輯

2020 年 9 月 13 日
筆記
Python

前言

在應用程序執行過程中，我們希望通過規範格式輸出程序執行的詳細信息，這時我們需要用到日誌功能。在Python語言中，有個內建模塊logging能夠很好的實現日誌功能。整體來說，logging配置可以分成4個部分: Loggers、Handlers、Filters和Formatters。接下來我們詳細探討其處理邏輯和配置方法。

1.日誌功能邏輯

LogRecord

每個事件生成日誌條目稱之為LogRecord，在LogRecord中包含了日誌級別，日誌元數據信息兩個重要組成部分。在Python語言中日誌級別可以分為5個等級：

DEBUG: Low level system information for debugging purposes.
INFO: General system information.
WARNING: Information describing a minor problem that has occurred.
ERROR: Information describing a major problem that has occurred.
CRITICAL: Information describing a critical problem that has occurred.
當LogRecord傳入Logger中處理時，會比較LogRecord和Logger中的日誌級別。若日誌級別相等或者高於Logger的日誌級別，該條LogRecord才會被Logger處理。

Formatter

Formatter主要用於渲染日誌的輸出格式，在Python中給定了內置的格式變量，我們可以自定義日誌信息的輸出格式。

格式變量列舉：
%(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用戶輸出的消息

Filter

Filter用來為日誌信息的處理提供額外的過濾選項。在默認情況下，從Logger獲取到的每一條LogRecord都會交給Handler處理。但是，當我們有一些額外的處理邏輯，比方說我希望將LogRecord的日誌級別變更，或者我希望後續僅處理ERROR類型的記錄，那麼就可以使用Filter來過濾。

Handler

Handler是日誌處理的核心，描述了程序日誌的後續執行方式。一般而言，我們希望日誌能夠輸出到Console顯示，或者寫成文件本地持久化存儲，都要靠Handler來實現。為此，Python中主要提供了FileHandler和StreamHandler兩種Handler來分別執行文件存儲和控制台打印兩種日誌處理方式。

2.函數式配置日誌

函數式配置日誌輸出是最簡單的方式，我們可以將日誌打印到文件中。但是，這種方式有個缺陷，即無法將日誌打印到Console。
特點：配置簡單，但無法同時輸出控制台和文件

import logging
logging.basicConfig(
    level=logging.DEBUG, # 設定打印日誌的級別
    # 日誌消息格式，level=日誌級別 format=日誌格式 asctime=對應下面的datefmt filename=日誌文件路徑
    format="%(asctime)s %(filename)s [line:%(lineno)d] %(levelname)s %(message)s",
    datefmt="%Y-%d-%d %H:%M:%S",
    filename="1.log",
    # a=追加 w=覆蓋
    filemode="a"
)
logging.debug("debug")
logging.info("info")

3.對象式配置日誌

對象式配置日誌能夠較強的進行定製化配置，包括日誌的輸出格式、控制台輸出、輸出本地文件持久化存儲。因此，在實際使用時一般都採用對象式配置日誌的方式來處理。
特點：定製化強，配置較為複雜

配置流程：

創建並獲取logger對象;
創建FileHandler對象;
創建StreamHandler對象;
創建Formatter對象;
給Handler對象綁定Formatter;
給logger對象綁定Handler

import logging
logger = logging.RootLogger("DEBUG") # 如果要自定義level，則可使用RootLogger，或者logger.setLevel()
# logger = logging.getLogger() # 使用getLogger默認level為WARNING
fh = logging.FileHandler('test.log', encoding='utf-8')  # 創建FileHandler對象
sh = logging.StreamHandler()  # 創建StreamHandler對象

fmt = logging.Formatter("%(asctime)s %(filename)s [line:%(lineno)d] %(levelname)s %(message)s")
fh.setFormatter(fmt)  # 給Handler對象綁定Formatter
sh.setFormatter(fmt)  # 給Handler對象綁定Formatter

logger.addHandler(fh)  # 給logger對象綁定Handler
logger.addHandler(sh) # 給logger對象綁定Handler

logger.info('info')
logger.debug('debug')
logger.error("error")

Tags: Python