Python - 日志记录

Python 中的日志记录

日志记录是在程序执行期间记录消息的过程，以提供可用于监视、调试和审计的运行时信息。

在 Python 中，日志记录是通过内置的 logging 模块实现的，该模块为生成日志消息提供了一个灵活的框架。

日志记录的好处

以下是在 Python 中使用日志记录的好处 -

• 调试 - 通过在程序执行期间捕获相关信息来帮助识别和诊断问题。
• 监控 - 提供对应用程序行为和性能的见解。
• 审计 - 出于安全目的，保留重要事件和操作的记录。
• 故障排除 - 有助于跟踪程序流和变量值，以了解意外行为。

Python 日志记录的组件

Python 日志记录由几个关键组件组成，这些组件协同工作以有效地管理和输出日志消息 -

• 记录器 -它是用于发出日志消息的主入口点。每个 Logger 实例都有名称，可以独立配置。
• 处理程序 -它确定日志消息的发送位置。处理程序将日志消息发送到不同的目标，例如控制台、文件、套接字等。
• 格式化程序 -它指定日志消息的布局。格式化程序通过指定要包含的信息（例如，时间戳、日志级别、消息）来定义日志记录的结构。
• 记录器级别 -它定义日志消息的严重性级别。低于此级别的消息将被忽略。常见级别包括 DEBUG、INFO、WARNING、ERROR 和 CRITICAL。
• 过滤器 −可选组件可以更精细地控制处理程序处理和发出哪些日志记录。

日志记录级别

Python 中的日志记录级别定义了日志消息的严重性，允许开发人员根据消息的重要性对消息进行分类和筛选。每个日志记录级别都有特定的用途，有助于了解记录信息的重要性 -

• 调试 -详细信息，通常仅用于调试目的。这些消息用于跟踪程序的流，通常在生产环境中看不到。
• 信息 -确认一切按预期进行。这些消息提供有关应用程序进度的一般信息。
• 警告 -指示不会阻止程序运行但可能需要注意的潜在问题。这些消息可用于提醒开发人员注意意外情况。
• 错误 -表示阻止特定功能或操作成功完成的更严重问题。这些消息突出显示了需要立即注意的错误，但不一定会终止应用程序。
• 严重 -最严重级别，表示可能导致程序终止的严重错误。这些消息是为需要立即干预的严重故障保留的。

用法

以下是 Python 应用程序中每个日志记录级别的使用方案 -

• 选择正确的级别 -选择适当的日志记录级别可确保日志消息提供相关信息，而不会使日志混乱。
• 设置级别 -Logger、处理程序和特定日志消息可以配置不同的级别，以控制记录哪些消息以及输出消息的位置。
• 层次结构 -日志记录级别是分层的，这意味着在 Logger 上设置级别也会影响处理程序和与之关联的日志消息。

基本日志记录示例

以下是 Python 中的一个基本日志记录示例，用于演示其用法和功能 -

import logging

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

# Example usage
def calculate_sum(a, b):
	 	logging.debug(f"Calculating sum of {a} and {b}")
	 	result = a + b
	 	logging.info(f"Sum calculated successfully: {result}")
	 	return result

# Main program
if __name__ == "__main__":
	 	logging.info("Starting the program")
	 	result = calculate_sum(10, 20)
	 	logging.info("Program completed")

输出

以下是上述代码的输出 -

配置日志记录

在 Python 中配置日志记录是指设置各种组件（如 Logger、处理程序和格式化程序）来控制日志消息的存储和显示方式和位置。此配置允许开发人员根据其应用程序的要求和部署环境自定义日志记录行为。

在以下示例中，getLogger（） 函数检索或创建命名记录器。Logger 根据其名称按层次结构进行组织。然后，创建诸如 “StreamHandler” （控制台处理程序） 之类的处理程序来定义日志消息的去向。它们可以配置特定的日志级别和格式化程序。

格式化程序指定日志记录的布局，确定日志消息在打印或存储时的显示方式 -

import logging

# Create logger
logger = logging.getLogger('my_app')
logger.setLevel(logging.DEBUG) 	# Set global log level

# Create console handler and set level to debug
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.DEBUG)

# Create formatter
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
console_handler.setFormatter(formatter)

# Add console handler to logger
logger.addHandler(console_handler)

# Example usage
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')

生成的结果如下所示 -

日志记录处理程序

Python 中的日志记录处理程序确定处理和输出日志消息的位置和方式。它们在将日志消息定向到特定目标（如控制台、文件、电子邮件、数据库甚至远程服务器）方面发挥着重要作用。

每个处理程序都可以独立配置，以控制它处理的消息的格式、日志级别和其他属性。

日志记录处理程序的类型

以下是 Python 中各种类型的日志记录处理程序 -

• StreamHandler - 流处理程序 -将日志消息发送到 sys.stdout 或 sys.stderr 等流。用于在控制台或命令行界面中显示日志消息。
• FileHandler 文件处理程序 -将日志消息写入文件系统上的指定文件。对于日志数据的持久日志记录和存档非常有用。
• RotatingFileHandler -与 FileHandler 类似，但会根据大小或时间间隔自动轮换日志文件。帮助管理日志文件大小并防止它们变得太大。
• SMTPHandler -通过 SMTP 将日志消息作为电子邮件发送给指定的收件人。用于提醒管理员或开发人员有关关键问题的信息。
• SysLogHandler -将日志消息发送到类 Unix 系统（例如 syslog）上的系统日志。允许与系统范围的日志记录工具集成。
• MemoryHandler -缓冲区在内存中记录消息，并在达到特定缓冲区大小或超时后将其发送到目标处理程序。对于批处理和管理日志消息的突发非常有用。
• HTTPHandler -通过 HTTP 或 HTTPS 将日志消息发送到 Web 服务器。允许将消息记录到远程服务器或记录服务。