用活用好logging，写就日志管理诗篇

2023-10-10 12:51:43

logging 模块简介

logging 模块是 Python 标准库中一个强大的日志记录工具，它提供了一种简单、一致的方式来记录应用程序的信息和错误。logging 模块具有以下特点：

灵活性: logging 模块允许您将日志记录到各种目的地，包括文件、控制台、电子邮件等。
可配置性: logging 模块提供了丰富的配置选项，您可以根据需要定制日志记录的行为。
可扩展性: logging 模块允许您创建自定义的日志记录处理程序和格式器，以满足您的特定需求。

使用 logging 模块记录日志

1. 创建 logger 对象

要开始使用 logging 模块，您需要创建一个 logger 对象。logger 对象是日志记录的入口点，它负责将日志记录到指定的目的地。您可以通过 logging.getLogger() 函数创建 logger 对象，该函数接受一个字符串参数，表示 logger 的名称。

例如，以下代码创建了一个名为 "my_logger" 的 logger 对象：

import logging

logger = logging.getLogger("my_logger")

2. 设置日志级别

每个 logger 对象都有一个日志级别，该级别决定了哪些日志消息将被记录。logging 模块定义了以下几种日志级别：

DEBUG: 最详细的日志级别，记录所有消息。
INFO: 记录一般性的信息，例如应用程序启动或关闭的消息。
WARNING: 记录潜在的问题，例如资源不足或配置错误的消息。
ERROR: 记录错误消息，例如应用程序崩溃或数据丢失的消息。
CRITICAL: 记录严重的错误消息，例如应用程序无法启动或数据损坏的消息。

您可以通过 logging.setLevel() 函数设置 logger 对象的日志级别。例如，以下代码将 "my_logger" logger 对象的日志级别设置为 INFO：

logger.setLevel(logging.INFO)

3. 记录日志消息

要记录日志消息，您可以使用 logger 对象的 debug()、info()、warning()、error() 和 critical() 方法。这些方法接受一个字符串参数，表示要记录的消息。例如，以下代码记录一条 INFO级别的日志消息：

logger.info("This is an INFO message.")

4. 配置日志记录

logging 模块提供了丰富的配置选项，您可以根据需要定制日志记录的行为。您可以通过以下两种方式配置日志记录：

使用 logging.basicConfig() 函数
使用 logging.config.dictConfig() 函数

logging.basicConfig() 函数是最简单的方式来配置日志记录。该函数接受几个参数，包括日志级别、日志格式和日志目的地。例如，以下代码使用 logging.basicConfig() 函数将日志记录到控制台：

import logging

logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s', datefmt='%Y-%m-%d %H:%M:%S')

logging.config.dictConfig() 函数允许您通过一个字典来配置日志记录。该字典可以包含以下键：

handlers: 日志记录处理程序的列表。
formatters: 日志记录格式器的列表。
filters: 日志记录过滤器的列表。
loggers: logger 对象的列表。

例如，以下代码使用 logging.config.dictConfig() 函数将日志记录到文件和控制台：

import logging

config = {
  'version': 1,
  'handlers': [
    {
      'class': 'logging.FileHandler',
      'filename': 'my.log',
      'level': 'INFO',
      'formatter': 'my_formatter',
    },
    {
      'class': 'logging.StreamHandler',
      'level': 'INFO',
      'formatter': 'my_formatter',
    },
  ],
  'formatters': [
    {
      'format': '%(asctime)s - %(name)s - %(levelname)s - %(message)s',
      'datefmt': '%Y-%m-%d %H:%M:%S',
      'name': 'my_formatter',
    },
  ],
  'loggers': [
    {
      'name': 'my_logger',
      'level': 'INFO',
      'handlers': ['my_file_handler', 'my_stream_handler'],
    },
  ],
}

logging.config.dictConfig(config)

logger = logging.getLogger("my_logger")
logger.info("This is an INFO message.")

logging 模块的优势

使用 logging 模块可以带来以下优势：

提高应用程序的可调试性和可维护性: logging 模块可以帮助您快速定位和解决应用程序中的问题。通过日志记录，您可以了解应用程序的运行状况，并及时发现潜在的问题。
提高应用程序的性能: logging 模块可以帮助您优化应用程序的性能。通过日志记录，您可以了解应用程序中哪些部分消耗了最多的时间，并采取措施提高性能。
提高应用程序的安全性: logging 模块可以帮助您保护应用程序免受安全威胁。通过日志记录，您可以监控应用程序中的可疑活动，并及时采取措施阻止攻击。