Python日誌記錄：記錄應用程序的運行狀態

一、日誌記錄的作用

在應用程序開發中，日誌記錄是必不可少的工具。通過記錄應用程序的運行狀態，我們可以提高代碼的可維護性、可讀性和可調試性。同時，日誌文件也可用於應用程序的審計和安全檢查，確保應用程序的正常運行。

Python內置的logging模塊提供了良好的日誌記錄功能。本文將介紹如何使用logging模塊來記錄應用程序的運行狀態。

二、logging模塊的基本使用

logging模塊提供了5個日誌級別：DEBUG、INFO、WARNING、ERROR和CRITICAL，級別逐漸升高。

logging模塊的基本使用方法如下：

import logging

logging.basicConfig(level=logging.DEBUG, filename='app.log', filemode='w', format='%(asctime)s - %(levelname)s - %(message)s')
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')

上述代碼使用基本配置方法來配置日誌記錄。其中：

• level：設置日誌級別。此處是DEBUG級別，能夠記錄所有級別的日誌記錄。
• filename：設置日誌文件名。
• filemode：設置文件的打開模式。此處為『w』，代表只寫模式。
• format：設置日誌記錄的格式化字元串。

日誌級別依次逐漸升高，所以只記錄文件中WARNING及以上級別的日誌。上面的代碼會向app.log文件中輸出以下內容：
2021-07-06 09:21:24,522 – DEBUG – This is a debug message
2021-07-06 09:21:24,522 – INFO – This is an info message
2021-07-06 09:21:24,522 – WARNING – This is a warning message
2021-07-06 09:21:24,522 – ERROR – This is an error message
2021-07-06 09:21:24,522 – CRITICAL – This is a critical message

三、日誌記錄的高級使用

1. 使用配置文件

我們可以使用配置文件來配置日誌記錄。這樣可以分離日誌記錄的配置和應用程序的代碼。

在同級目錄下，創建logging.conf文件，內容如下：

[loggers]
keys=root,sampleLogger

[handlers]
keys=defaultHandler

[formatters]
keys=defaultFormatter

[logger_root]
level=DEBUG
handlers=defaultHandler

[logger_sampleLogger]
level=DEBUG
handlers=defaultHandler
qualname=sampleLogger
propagate=0

[handler_defaultHandler]
class=handlers.TimedRotatingFileHandler
level=DEBUG
formatter=defaultFormatter
args=('logs/app.log', 'D', 1, 30)

[formatter_defaultFormatter]
format=%(asctime)s %(levelname)s %(filename)s:%(lineno)d %(message)s
datefmt=%Y-%m-%d %H:%M:%S

現在，我們可以使用下面的代碼來使用剛剛創建好的配置文件。

import logging.config

logging.config.fileConfig('logging.conf')
logger = logging.getLogger('sampleLogger')

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. 日誌記錄的格式化

logging模塊使用格式化字元串來記錄日誌記錄。下面介紹一些常用的格式化字元串。

• %s：字元串型
• %d：整型
• %f：浮點型
• %(asctime)s：可用於記錄時間
• %(levelname)s：可用於記錄日誌級別
• %(filename)s：可用於記錄文件名
• %(message)s：可用於記錄用戶自定義消息

3. 代碼中的日誌記錄

在應用程序中，我們需要在代碼中添加日誌記錄，可以按照下面的方式來實現：

import logging

logger = logging.getLogger(__name__)

def do_something():
  logger.info('Doing something')
  # do something
  logger.debug('Something is done')

上面的do_something()方法中添加了兩個日誌記錄，可以更好地跟蹤代碼的執行，從而減輕代碼的調試難度。