Python日誌輸出到文件詳解

一、日誌輸出概述

在程序開發中，日誌輸出是一個非常重要的工具。一方面，它可以幫助程序員在開發階段更好的調試和定位問題，另一方面，它也能夠在程序正式部署後，幫助運維人員定位bug並解決問題。

Python的logging模塊是一個強大的日誌輸出模塊，它支持多種輸出方式，包括輸出到控制台，輸出到文件，甚至可以將日誌輸出到遠程伺服器等。

二、將日誌輸出到文件

將日誌輸出到文件是非常常見的一種方式。下面是一個簡單的例子，展示如何將日誌輸出到文件。

import logging.handlers

# 創建日誌對象
logger = logging.getLogger()
logger.setLevel(logging.INFO)

# 創建文件日誌處理器
file_handler = logging.handlers.RotatingFileHandler("/var/log/python.log", maxBytes=1024*1024, backupCount=10, encoding='utf8')

# 創建日誌格式對象
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

# 將日誌格式配置到文件日誌處理器中
file_handler.setFormatter(formatter)

# 將文件日誌處理器添加到日誌對象中
logger.addHandler(file_handler)

# 輸出日誌
logger.info("This is a log message.")

以上代碼中，我們首先使用logging模塊的getLogger方法創建了一個日誌對象。然後設置了日誌對象的級別，這裡我們設置為INFO級別，表示只會輸出INFO級別及以上的日誌信息。接下來，我們使用RotatingFileHandler類創建了一個文件日誌處理器，參數含義如下：

• filename：日誌輸出文件的路徑和名稱
• maxBytes：單個日誌文件最大的大小（單位：位元組），當超過這個大小時系統會自動生成新的日誌文件
• backupCount：日誌文件最大數量，超過這個數量後，系統會自動刪除最早的日誌文件
• encoding：日誌文件的編碼格式

然後我們通過logging.Formatter類創建了一個日誌格式對象，並將這個日誌格式配置到了文件日誌處理器中。最後，我們將文件日誌處理器添加到了日誌對象中，並輸出了一條日誌信息。

三、日誌等級

logging模塊支持多種日誌級別，如下所示：

• DEBUG：詳細的 debug 信息，通常只在開發 / 測試階段使用
• INFO：確認一切按預期進行
• WARNING：表示出現了一些意外或異常，但是並不是致命的或者錯誤的
• ERROR：由於更嚴重的問題，某些功能已經不能正常執行
• CRITICAL：非常嚴重的問題，程序已經不能繼續執行

對於不同的應用場景，我們可以根據需要選擇不同的日誌級別。一般來說，我們可以將日誌級別設置為INFO或者WARNING，同時將日誌輸出到文件，這樣既能保證程序運行的正常，同時又能夠在出現問題時方便地定位和解決問題。

四、日誌回滾和歸檔

在實際應用中，日誌文件可能會比較大，此時就需要對日誌文件進行回滾和歸檔。Python的logging模塊提供了RotatingFileHandler和TimedRotatingFileHandler兩個類實現日誌回滾和歸檔的功能。

RotatingFileHandler類實現了按大小回滾，當日誌文件大小超過maxBytes時，會自動將當前日誌文件重命名為一個備份文件，並創建一個新的日誌文件繼續寫入。backupCount參數指定保留的備份文件數量。

TimedRotatingFileHandler類實現了按時間回滾，可以按天/小時/分鐘等進行歸檔。when參數指定回滾時間的單位，比如when=’D’表示按天回滾，when=’H’表示按小時回滾，interval參數指定回滾時間的間隔，backupCount參數指定備份文件數量。下面是一個TimedRotatingFileHandler的例子：

import logging.handlers

logger = logging.getLogger()
logger.setLevel(logging.INFO)

file_handler = logging.handlers.TimedRotatingFileHandler('/var/log/python.log', when='midnight', interval=1, backupCount=10, encoding='utf8')

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

file_handler.setFormatter(formatter)

logger.addHandler(file_handler)

logger.info("This is a log message.")

以上代碼中，我們使用了TimedRotatingFileHandler類創建了一個按天歸檔的文件日誌處理器。參數含義如下：

• filename：日誌輸出文件的路徑和名稱
• when：回滾時間單位，支持的值包括：「S」-秒，「M」-分鐘，「H」-小時，「D」-天，「W0」-「W6」(星期一到星期日)
• interval：回滾時間間隔
• backupCount：保留的備份文件數量
• encoding：日誌文件的編碼格式

五、總結

本文介紹了Python日誌輸出到文件的相關知識，包括將日誌輸出到文件、日誌等級、日誌回滾和歸檔等內容。在實際應用中，我們可以根據不同的場景選擇不同的日誌輸出方式，並結合日誌等級、回滾和歸檔等機制，使得系統在運行過程中更加健壯。