Python - 日志记录

上一页
下一页

Python 中的日志记录

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

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

日志记录的优势

以下是使用 Python 日志记录的优势 −

  • 调试 − 通过在程序执行期间捕获相关信息来帮助识别和诊断问题。

  • 监控 − 提供对应用程序行为和性能的洞察。

  • 审计 − 为安全目的保留重要事件和操作的记录。

  • 故障排除 − 促进跟踪程序流程和变量值以了解意外行为。

Python 日志记录的组件

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

  • 日志器 − 它是您用来发出日志消息的主要入口点。每个日志器实例都有名称，并且可以独立配置。

  • 处理器 − 它确定日志消息发送到的位置。处理器将日志消息发送到不同的目标，例如控制台、文件、套接字等。

  • 格式化器 − 它指定日志消息的布局。格式化器通过指定要包含哪些信息（例如，时间戳、日志级别、消息）来定义日志记录的结构。

  • 日志级别 − 它定义日志消息的严重性级别。低于此级别的消息将被忽略。常见的级别包括 DEBUG、INFO、WARNING、ERROR 和 CRITICAL。

  • 过滤器 − 它是可选组件，可提供更精细的控制，以控制处理器处理和发出的日志记录。

日志级别

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

  • DEBUG − 详细的信息，通常仅对调试目的有用。这些消息用于跟踪程序的流程，通常不会在生产环境中看到。

  • INFO − 确认事情按预期工作。这些消息提供有关应用程序进度的一般信息。

  • WARNING − 指示可能存在的问题，这些问题不会阻止程序运行，但可能需要关注。这些消息可用于提醒开发人员注意意外情况。

  • ERROR − 指示更严重的问题，这些问题会阻止特定功能或操作成功完成。这些消息突出显示需要立即关注的错误，但不一定终止应用程序。

  • CRITICAL − 最严重的级别，指示可能导致程序终止的严重错误。这些消息保留用于需要立即干预的关键故障。

用法

以下是 Python 应用程序中每个日志级别的使用场景 −

选择正确的级别 − 选择合适的日志级别可确保日志消息提供相关信息，而不会使日志混乱。

设置级别 - 可以为记录器、处理器和特定日志消息配置不同的级别，以控制记录哪些消息以及将其输出到哪里。

层次结构 - 日志级别是分层的，这意味着在记录器上设置级别也会影响与其关联的处理器和日志消息。

基本日志记录示例

以下是 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")

输出

以下是上述代码的输出 -

2024-06-19 09:00:06,774 - INFO - Starting the program
2024-06-19 09:00:06,774 - DEBUG - Calculating sum of 10 and 20
2024-06-19 09:00:06,774 - INFO - Sum calculated successfully: 30
2024-06-19 09:00:06,775 - INFO - Program completed

配置日志记录

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

示例

在以下示例中，getLogger() 函数检索或创建命名记录器。记录器根据其名称进行分层组织。然后，创建诸如“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')

产生的结果如下所示 -

2024-06-19 09:05:20,852 - my_app - DEBUG - This is a debug message
2024-06-19 09:05:20,852 - my_app - INFO - This is an info message
2024-06-19 09:05:20,852 - my_app - WARNING - This is a warning message
2024-06-19 09:05:20,852 - my_app - ERROR - This is an error message
2024-06-19 09:05:20,852 - my_app - 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 服务器。能够将日志消息记录到远程服务器或日志记录服务。

打印页面
上一页
下一页
广告