logging模块用于记录日志的标准库

标签：logger logging file handler 模块日志 message

日志级别是监控和调试软件系统的关键组成部分，它们帮助开发者和运维人员区分不同严重程度的信息，从而更有效地响应和解决问题。以下是日志级别的详细说明及如何在Python中使用它们的示例。

日志级别分类

日志级别按严重程度从低到高排序如下：

DEBUG：用于记录详细的调试信息，通常在开发阶段使用，帮助定位问题。
INFO：记录应用程序的常规运行状态，对用户和运维人员提供系统状态的反馈。
WARNING：标记潜在的问题，系统可能仍在运行，但存在风险，需要关注。
ERROR：记录错误信息，系统功能可能受损，但系统仍能尝试继续运行。
CRITICAL（或FATAL）：记录极其严重的错误，系统无法继续运行，需要立即处理。

Python日志级别示例

Python的logging模块提供了丰富的日志级别和配置选项。下面是一个使用logging模块的例子，展示了如何记录不同级别的日志信息：

import logging

# 创建一个logger
logger = logging.getLogger('my_logger')
logger.setLevel(logging.DEBUG)  # 设置logger的日志级别为DEBUG

# 创建一个FileHandler，用于写入日志文件
fh = logging.FileHandler('app.log')
fh.setLevel(logging.DEBUG)  # 设置handler的日志级别为DEBUG

# 创建一个StreamHandler，用于控制台输出
ch = logging.StreamHandler()
ch.setLevel(logging.WARNING)  # 控制台输出的日志级别设为WARNING

# 创建一个Formatter，用于设定日志格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
fh.setFormatter(formatter)
ch.setFormatter(formatter)

# 添加handler到logger
logger.addHandler(fh)
logger.addHandler(ch)

# 记录不同级别的日志信息
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.")  # 在文件和控制台中记录

# 生产环境中，通常只输出WARNING及以上级别的日志
logger.removeHandler(fh)  # 移除文件handler
logger.setLevel(logging.WARNING)
logger.addHandler(ch)

logger.warning("Production warning message.")
logger.error("Production error message.")

选择日志级别

DEBUG：在开发阶段使用，记录详细的调试信息。
INFO：记录应用运行的基本信息，适用于生产环境，但应谨慎使用以避免过多输出。
WARNING：标记潜在的问题，系统仍在运行，但可能存在风险或异常情况。
ERROR：记录错误信息，系统功能受损，但仍尝试运行。
CRITICAL：记录极其严重的错误，系统无法继续运行。

在生产环境中，通常推荐设置日志级别为WARNING或ERROR，以减少日志输出量，避免不必要的性能影响和磁盘空间消耗。而在开发和测试阶段，可以设置较低的日志级别如DEBUG或INFO，以获取更详细的系统运行信息。

步骤1：导入logging模块

首先，你需要在你的Python脚本或模块中导入logging模块。

import logging

步骤2：创建Logger实例

接下来，创建一个Logger实例。通常，你会根据模块或应用的名称来命名你的Logger，这有助于在日志文件中区分不同来源的日志。

logger = logging.getLogger('my_logger_name')

步骤3：设置日志级别

设置Logger的日志级别。日志级别有DEBUG, INFO, WARNING, ERROR, 和 CRITICAL。例如，设置日志级别为DEBUG：

logger.setLevel(logging.DEBUG)

步骤4：创建Handler

Handler决定了日志信息发送到哪里。常见的Handler有StreamHandler（输出到屏幕）、FileHandler（输出到文件）等。例如，创建一个输出到文件的Handler：

file_handler = logging.FileHandler('app.log')

步骤5：设置Handler的日志级别

与Logger一样，Handler也有自己的日志级别。例如，设置Handler级别为WARNING：

file_handler.setLevel(logging.WARNING)

步骤6：创建Formatter

Formatter用于定义日志信息的格式。例如，创建一个显示时间、名字、日志级别和消息的Formatter：

formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

步骤7：将Formatter添加到Handler

将Formatter应用到Handler上：

file_handler.setFormatter(formatter)

步骤8：将Handler添加到Logger

将Handler添加到Logger实例中，这样Logger就可以通过Handler来输出日志信息：

logger.addHandler(file_handler)

步骤9：记录日志

现在，你可以使用logger来记录不同级别的日志信息了。例如：

logger.debug("Debug message")
logger.info("Info message")
logger.warning("Warning message")
logger.error("Error message")
logger.critical("Critical message")

完整示例

将以上步骤组合成一个完整的示例：

import logging

# 创建logger
logger = logging.getLogger('my_logger')
logger.setLevel(logging.DEBUG)

# 创建handler
file_handler = logging.FileHandler('app.log')
file_handler.setLevel(logging.WARNING)

# 创建formatter
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
file_handler.setFormatter(formatter)

# 添加handler到logger
logger.addHandler(file_handler)

# 记录日志
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.")

多个Handler的使用

你还可以为一个Logger添加多个Handler，这样就可以将日志信息同时输出到多个地方。例如，同时输出到文件和控制台：

import logging

logger = logging.getLogger('my_logger')
logger.setLevel(logging.DEBUG)

# 文件handler
file_handler = logging.FileHandler('app.log')
file_handler.setLevel(logging.DEBUG)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
file_handler.setFormatter(formatter)
logger.addHandler(file_handler)

# 控制台handler
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.INFO)
console_handler.setFormatter(formatter)
logger.addHandler(console_handler)

# 记录日志
logger.debug("Debug message (only in file).")
logger.info("Info message (in console and file).")
logger.warning("Warning message (in console and file).")
logger.error("Error message (in console and file).")
logger.critical("Critical message (in console and file).")

通过合理配置日志级别，你可以确保在不影响系统性能的同时，记录下所有关键信息，便于后续分析和问题解决。在Python中，logging模块提供了灵活的日志管理机制，可以根据需要动态调整日志级别和输出方式。

标签：logger,logging,file,handler,模块,日志,message
From： https://blog.csdn.net/KIKI3666/article/details/142144492