掌握 Python Logging 模塊的 10 個技巧

2024-02-24 18:46:03 綜合教程 150

1. 自定義日志級別

除了默認的 DEBUG、INFO、WARNING、ERROR 和 CRITICAL 級別，您可以創建自定義級別。這對于區分不同嚴重程度的事件非常有用。

import logging

# 創建自定義日志級別
CUSTOM_LEVEL = logging.INFO + 5
logging.addLevelName(CUSTOM_LEVEL, "CUSTOM")

# 創建一個 Logger 并設置自定義日志級別
logger = logging.getLogger("my_logger")
logger.setLevel(CUSTOM_LEVEL)

2. 使用不同處理器

處理器負責將日志事件發送到特定目標，如文件或控制臺。您可以自定義處理器以滿足您的特定需求。

import logging

# 創建一個 FileHandler 并設置日志文件名
file_handler = logging.FileHandler("my_log.txt")

# 創建一個 StreamHandler 并輸出到控制臺
stream_handler = logging.StreamHandler()

# 將處理器添加到 Logger
logger = logging.getLogger("my_logger")
logger.addHandler(file_handler)
logger.addHandler(stream_handler)

3. 使用過濾器

過濾器允許您根據特定條件過濾日志事件。這對于僅記錄感興趣的事件非常有用。

import logging

# 創建一個過濾器以過濾 INFO 級別以上的事件
info_filter = logging.Filter()
info_filter.filter = lambda record: record.levelno >= logging.INFO

# 將過濾器添加到 Logger
logger = logging.getLogger("my_logger")
logger.addFilter(info_filter)

4. 格式化日志輸出

您可以自定義日志事件的格式，以提供所需的信息。

import logging

# 創建一個 FORMatter 并設置格式字符串
formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")

# 將 Formatter 添加到處理器
handler = logging.StreamHandler()
handler.setFormatter(formatter)

# 將處理器添加到 Logger
logger = logging.getLogger("my_logger")
logger.addHandler(handler)

5. 使用上下文處理器

上下文處理器允許您在日志記錄時添加額外的信息。這對于跟蹤請求或事務中的上下文很有用。

import logging
from contextlib import contextmanager

# 創建一個上下文處理器以添加請求 ID
@contextmanager
def request_id_context(request_id):
previous_request_id = logging.currentframe().f_locals.get("request_id")
try:
logging.currentframe().f_locals["request_id"] = request_id
yield
finally:
logging.currentframe().f_locals["request_id"] = previous_request_id

# 使用上下文處理器
logger = logging.getLogger("my_logger")
with request_id_context("1234"):
logger.info("Received request")

6. 使用字典配置

您可以使用字典輕松地配置 Logging 模塊。

import logging

# 配置字典
logging_config = {
"version": 1,
"formatters": {
"default": {
"format": "%(asctime)s - %(levelname)s - %(message)s"
}
},
"handlers": {
"file": {
"class": "logging.FileHandler",
"filename": "my_log.txt",
"formatter": "default",
},
"console": {
"class": "logging.StreamHandler",
"formatter": "default",
}
},
"loggers": {
"my_logger": {
"handlers": ["file", "console"],
"level": "INFO",
}
}
}

# 從字典配置 Logging
logging.config.dictConfig(logging_config)

7. 集成第三方包

Logging 模塊可以與第三方包集成，例如 Sentry 或 Rollbar。這使您可以輕松地將日志事件發送到遠程服務。

import logging
import sentry_sdk

# 初始化 Sentry 并與 Logging 集成
sentry_sdk.init()
logging.basicConfig(level=logging.INFO, handlers=[sentry_sdk.handler.SentryHandler()])

8. 使用多線程支持

Logging 模塊支持多線程應用程序。它使用線程本地存儲來確保每個線程都有其自己的獨立日志處理器。

import logging
import threading

# 創建線程安全的 Logger
logger = logging.getLogger("my_logger")

# 創建一個線程并向 Logger 記錄
def thread_function():
logger.info("Executing in a separate thread")

# 啟動線程
thread = threading.Thread(target=thread_function)
thread.start()

9. 記錄異常

Logging 模塊可以自動記錄發生的異常。

import logging

# 創建一個 Logger
logger = logging.getLogger("my_logger")

# 記錄一個異常
try:
raise Exception("An error occurred")
except Exception as e:
logger.exception(e)

10. 使用擴展日志記錄

python 3.8 引入了對擴展日志記錄的支持。這允許您創建自定義日志記錄函數和處理程序。

import logging

# 創建一個自定義日志記錄函數
def my_log_function(logger, level, msg, *args, **kwargs):
# 您的自定義日志記錄邏輯

# 添加自定義日志記錄函數到 Logger
logger = logging.getLogger("my_logger")
logger.addHandler(logging.NullHandler())
logger.addFilter(logging.Filter())
logger.log = my_log_function