Python logging模块日志相关功能及应用示例

off999 2024-11-23 20:49 32 浏览 0 评论

logging模块提供了许多功能和配置选项，用于实现全面和可定制的日志记录。以下是logging模块的主要功能及其应用示例：

多级别日志记录：

logging模块提供了多个日志级别，如DEBUG、INFO、WARNING、ERROR和CRITICAL，用于区分不同严重程度的日志消息。可以通过设置日志级别来控制哪些级别的消息将被记录。

import logging

# 设置日志级别为DEBUG
logging.basicConfig(level=logging.DEBUG)

# 记录不同级别的日志消息
logging.debug('这是一个DEBUG级别的日志消息')
logging.info('这是一个INFO级别的日志消息')
logging.warning('这是一个WARNING级别的日志消息')
logging.error('这是一个ERROR级别的日志消息')
logging.critical('这是一个CRITICAL级别的日志消息')

日志消息输出位置：

logging模块支持将日志消息输出到不同的位置，如控制台、文件、网络等。可以通过添加不同类型的处理器（Handler）来实现日志消息的输出。

import logging

# 创建处理器，将日志消息输出到文件
file_handler = logging.FileHandler('app.log')

# 设置日志级别为DEBUG
file_handler.setLevel(logging.DEBUG)

# 创建日志记录器
logger = logging.getLogger('example')
logger.addHandler(file_handler)

# 记录日志消息
logger.info('这是一个日志消息')

日志消息格式化

logging模块支持自定义日志消息的格式，可以包含日期、时间、日志级别、日志内容等信息。可以通过设置格式化器（Formatter）来定义日志消息的输出格式。

import logging

# 创建处理器，将日志消息输出到控制台
console_handler = logging.StreamHandler()

# 创建格式化器
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')

# 将格式化器添加到处理器
console_handler.setFormatter(formatter)

# 创建日志记录器
logger = logging.getLogger('example')
logger.addHandler(console_handler)

# 记录日志消息
logger.info('这是一个日志消息')

日志消息过滤：

logging模块支持根据特定的条件过滤日志消息，只记录满足条件的消息。可以通过添加过滤器（Filter）来实现日志消息的过滤。

import logging

# 创建过滤器，只记录包含特定关键字的日志消息
class KeywordFilter(logging.Filter):
    def __init__(self, keyword):
        self.keyword = keyword

    def filter(self, record):
        return self.keyword in record.getMessage()

# 创建处理器，将日志消息输出到控制台
console_handler = logging.StreamHandler()

# 创建过滤器
keyword_filter = KeywordFilter('error')

# 将过滤器添加到处理器
console_handler.addFilter(keyword_filter)

# 创建日志记录器
logger = logging.getLogger('example')
logger.addHandler(console_handler)

# 记录日志消息
logger.info('这是一个信息日志消息')
logger.error('这是一个错误日志消息')

日志消息的传递与继承：

logging模块支持将日志消息传递给父级记录器，以及在不同模块之间继承日志记录器。可以通过设置记录器的propagate属性来控制日志消息的传递与继承。

import logging

# 创建过滤器，只记录包含特定关键字的日志消息
class KeywordFilter(logging.Filter):
    def __init__(self, keyword):
        self.keyword = keyword

    def filter(self, record):
        return self.keyword in record.getMessage()

# 创建处理器，将日志消息输出到控制台
console_handler = logging.StreamHandler()

# 创建过滤器
keyword_filter = KeywordFilter('error')

# 将过滤器添加到处理器
console_handler.addFilter(keyword_filter)

# 创建日志记录器
logger = logging.getLogger('example')
logger.addHandler(console_handler)

# 记录日志消息
logger.info('这是一个信息日志消息')
logger.error('这是一个错误日志消息')

多线程安全：

logging模块提供了线程安全的日志记录功能，可以在多线程环境中同时记录日志消息。

import logging
import threading

# 创建处理器，将日志消息输出到控制台
console_handler = logging.StreamHandler()

# 创建格式化器
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')

# 将格式化器添加到处理器
console_handler.setFormatter(formatter)

# 创建日志记录器
logger = logging.getLogger('example')
logger.addHandler(console_handler)

# 定义线程函数
def log_message():
    logger.info('这是一个日志消息')

# 创建多个线程
threads = []
for _ in range(5):
    thread = threading.Thread(target=log_message)
    threads.append(thread)

# 启动线程
for thread in threads:
    thread.start()

# 等待线程结束
for thread in threads:
    thread.join()

以上是logging模块的一些核心功能及其应用示例。通过灵活使用这些功能和配置选项，可以实现详细、可定制和线程安全的日志记录。在实际应用中，可以根据具体的需求来选择合适的功能和配置方式。

python日志