Python日志模塊logging如何使用

Python日志模塊logging如何使用

在Python開發中，日志記錄是一個非常重要的功能。它可以幫助開發者追蹤程序的執行過程，記錄錯誤信息，以及監控應用程序的運行狀態。Python標準庫中的logging模塊提供了強大的日志記錄功能，可以滿足大多數應用場景的需求。本文將詳細介紹如何使用logging模塊進行日志記錄。

1. 基本使用

1.1 導入logging模塊

首先，我們需要導入logging模塊：

import logging

1.2 配置日志記錄

logging模塊提供了多種方式來配置日志記錄。最簡單的方式是使用basicConfig()函數進行基本配置：

logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')

• level：設置日志記錄的級別。常見的級別有DEBUG、INFO、WARNING、ERROR和CRITICAL。級別越高，記錄的信息越少。
• format：設置日志記錄的格式。%(asctime)s表示時間，%(name)s表示日志記錄器的名稱，%(levelname)s表示日志級別，%(message)s表示日志消息。

1.3 記錄日志

配置完成后，我們可以使用logging模塊提供的不同級別的日志記錄函數來記錄日志：

logging.debug('This is a debug message')
logging.info('This is an info message')
logging.warning('This is a warning message')
logging.error('This is an error message')
logging.critical('This is a critical message')

1.4 輸出結果

運行上述代碼后，日志信息將輸出到控制臺：

2023-10-01 12:00:00,000 - root - DEBUG - This is a debug message
2023-10-01 12:00:00,001 - root - INFO - This is an info message
2023-10-01 12:00:00,002 - root - WARNING - This is a warning message
2023-10-01 12:00:00,003 - root - ERROR - This is an error message
2023-10-01 12:00:00,004 - root - CRITICAL - This is a critical message

2. 高級配置

2.1 日志記錄器

logging模塊允許我們創建多個日志記錄器（Logger），每個記錄器可以有不同的配置。我們可以通過logging.getLogger()函數來獲取或創建一個日志記錄器：

logger = logging.getLogger('my_logger')
logger.setLevel(logging.DEBUG)

2.2 處理器（Handler）

處理器用于將日志記錄發送到不同的目的地，如控制臺、文件、網絡等。常見的處理器有StreamHandler（輸出到控制臺）和FileHandler（輸出到文件）：

# 創建一個文件處理器
file_handler = logging.FileHandler('my_log.log')
file_handler.setLevel(logging.DEBUG)

# 創建一個控制臺處理器
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.INFO)

# 設置處理器的格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
file_handler.setFormatter(formatter)
console_handler.setFormatter(formatter)

# 將處理器添加到日志記錄器
logger.addHandler(file_handler)
logger.addHandler(console_handler)

2.3 過濾器（Filter）

過濾器用于對日志記錄進行過濾，只有滿足條件的日志記錄才會被處理。我們可以通過繼承logging.Filter類來創建自定義過濾器：

class MyFilter(logging.Filter):
    def filter(self, record):
        return record.levelno == logging.ERROR

# 添加過濾器
logger.addFilter(MyFilter())

2.4 日志記錄

配置完成后，我們可以使用日志記錄器來記錄日志：

logger.debug('This is a debug message')
logger.info('This is an info message')
logger.warning('This is a warning message')
logger.error('This is an error message')
logger.critical('This is a critical message')

2.5 輸出結果

日志信息將同時輸出到控制臺和文件中?？刂婆_只顯示INFO級別及以上的日志，而文件中記錄所有級別的日志。

3. 日志輪轉

在實際應用中，日志文件可能會變得非常大。logging模塊提供了RotatingFileHandler和TimedRotatingFileHandler來實現日志文件的輪轉。

3.1 RotatingFileHandler

RotatingFileHandler根據文件大小進行輪轉：

from logging.handlers import RotatingFileHandler

# 創建一個RotatingFileHandler，最大文件大小為1MB，最多保留3個備份文件
rotating_handler = RotatingFileHandler('my_log.log', maxBytes=1*1024*1024, backupCount=3)
rotating_handler.setLevel(logging.DEBUG)
rotating_handler.setFormatter(formatter)

logger.addHandler(rotating_handler)

3.2 TimedRotatingFileHandler

TimedRotatingFileHandler根據時間進行輪轉：

from logging.handlers import TimedRotatingFileHandler

# 創建一個TimedRotatingFileHandler，每天輪轉一次，最多保留7個備份文件
timed_handler = TimedRotatingFileHandler('my_log.log', when='midnight', interval=1, backupCount=7)
timed_handler.setLevel(logging.DEBUG)
timed_handler.setFormatter(formatter)

logger.addHandler(timed_handler)

4. 總結

logging模塊是Python中非常強大的日志記錄工具，通過合理的配置，可以滿足各種復雜的日志記錄需求。本文介紹了logging模塊的基本使用、高級配置以及日志輪轉功能。希望這些內容能幫助你在實際項目中更好地使用logging模塊進行日志記錄。