掌握 Python Logging 模組的 10 個技巧

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

以上是掌握 Python Logging 模組的 10 個技巧的詳細內容。更多資訊請關注PHP中文網其他相關文章！