Python logging模块主要用于记录程序运行过程中发生的事件。它提供了多种日志级别、日志记录方式以及日志格式化方法。使用logging模块的基本步骤包括：配置日志记录器、设置日志级别、创建日志处理器、格式化日志消息。其中，配置日志记录器是最为关键的一步，因为它决定了日志记录的整体架构和行为。
配置日志记录器：日志记录器是logging模块的核心组件，负责接收日志消息并将其分发到相应的日志处理器。可以通过logging.getLogger()函数获取日志记录器实例，并使用logger.setLevel()方法设置日志级别。接下来，可以创建不同类型的日志处理器（例如FileHandler、StreamHandler）来指定日志的输出位置。最后，可以通过日志格式化器（Formatter）来定义日志消息的格式。
下面将详细介绍Python logging模块的各个方面及其使用方法。
一、配置日志记录器
配置日志记录器是使用logging模块的第一步。日志记录器（Logger）是用于记录日志消息的主要接口，通过它可以记录不同级别的日志消息。
1、获取日志记录器
可以使用logging.getLogger()函数获取一个日志记录器实例。如果不传递参数，则会返回根记录器（root logger）。也可以传递一个名称参数来获取或创建一个命名的日志记录器。
import logging
logger = logging.getLogger('my_logger')
2、设置日志级别
日志级别用于指定日志消息的重要性。常见的日志级别包括DEBUG、INFO、WARNING、ERROR和CRITICAL。可以使用logger.setLevel()方法设置日志记录器的级别。
logger.setLevel(logging.DEBUG)
3、创建日志处理器
日志处理器（Handler）用于指定日志消息的输出位置。常见的日志处理器包括StreamHandler（输出到控制台）、FileHandler（输出到文件）等。可以根据需要创建一个或多个处理器，并将其添加到日志记录器中。
console_handler = logging.StreamHandler()
file_handler = logging.FileHandler('app.log')
logger.addHandler(console_handler)
logger.addHandler(file_handler)
4、格式化日志消息
可以使用日志格式化器（Formatter）来定义日志消息的格式。格式化器可以指定日志消息的时间、级别、模块、行号等信息。可以使用logging.Formatter类创建格式化器，并将其添加到日志处理器中。
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
console_handler.setFormatter(formatter)
file_handler.setFormatter(formatter)
二、日志级别
日志级别用于指定日志消息的重要性，logging模块提供了五个标准日志级别：DEBUG、INFO、WARNING、ERROR和CRITICAL。
1、DEBUG
DEBUG级别用于记录调试信息，通常用于开发和调试阶段。记录DEBUG级别的日志消息可以帮助开发人员了解程序的内部状态和执行流程。
logger.debug('This is a debug message')
2、INFO
INFO级别用于记录一般信息，通常用于记录程序的正常运行情况。记录INFO级别的日志消息可以帮助用户了解程序的执行过程和结果。
logger.info('This is an info message')
3、WARNING
WARNING级别用于记录警告信息，通常用于记录可能会导致问题的情况。记录WARNING级别的日志消息可以提醒用户注意潜在的问题。
logger.warning('This is a warning message')
4、ERROR
ERROR级别用于记录错误信息，通常用于记录程序运行过程中发生的异常情况。记录ERROR级别的日志消息可以帮助用户了解错误的原因和位置。
logger.error('This is an error message')
5、CRITICAL
CRITICAL级别用于记录严重错误信息，通常用于记录程序运行过程中发生的致命错误。记录CRITICAL级别的日志消息可以帮助用户了解严重错误的影响和后果。
logger.critical('This is a critical message')
三、日志处理器
日志处理器（Handler）用于指定日志消息的输出位置。logging模块提供了多种日志处理器，可以根据需要选择合适的处理器。
1、StreamHandler
StreamHandler用于将日志消息输出到控制台（标准输出或标准错误）。可以使用logging.StreamHandler类创建StreamHandler，并将其添加到日志记录器中。
console_handler = logging.StreamHandler()
logger.addHandler(console_handler)
2、FileHandler
FileHandler用于将日志消息输出到文件。可以使用logging.FileHandler类创建FileHandler，并将其添加到日志记录器中。
file_handler = logging.FileHandler('app.log')
logger.addHandler(file_handler)
3、RotatingFileHandler
RotatingFileHandler用于将日志消息输出到文件，并支持日志文件的轮换。可以使用logging.handlers.RotatingFileHandler类创建RotatingFileHandler，并将其添加到日志记录器中。可以指定日志文件的大小和轮换的数量。
from logging.handlers import RotatingFileHandler
rotating_handler = RotatingFileHandler('app.log', maxBytes=1024, backupCount=3)
logger.addHandler(rotating_handler)
4、TimedRotatingFileHandler
TimedRotatingFileHandler用于将日志消息输出到文件，并支持按时间间隔轮换日志文件。可以使用logging.handlers.TimedRotatingFileHandler类创建TimedRotatingFileHandler，并将其添加到日志记录器中。可以指定时间间隔和轮换的数量。
from logging.handlers import TimedRotatingFileHandler
timed_handler = TimedRotatingFileHandler('app.log', when='midnight', interval=1, backupCount=7)
logger.addHandler(timed_handler)
5、其他处理器
除了上述常见的日志处理器外，logging模块还提供了其他一些特殊的处理器，例如SMTPHandler（通过电子邮件发送日志）、HTTPHandler（通过HTTP发送日志）、SysLogHandler（发送日志到Syslog服务器）等。可以根据需要选择合适的处理器。
四、日志格式化
日志格式化器（Formatter）用于定义日志消息的格式。格式化器可以指定日志消息的时间、级别、模块、行号等信息。
1、创建格式化器
可以使用logging.Formatter类创建格式化器，并指定日志消息的格式。格式字符串可以包含一些占位符，用于表示日志消息的不同部分。
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
常见的占位符包括：
- %(asctime)s：日志消息的时间
- %(name)s：日志记录器的名称
- %(levelname)s：日志级别
- %(message)s：日志消息内容
2、添加格式化器到处理器
创建格式化器后，可以将其添加到日志处理器中。这样，处理器输出的日志消息就会使用指定的格式。
console_handler.setFormatter(formatter)
file_handler.setFormatter(formatter)
3、自定义日志格式
除了使用默认的占位符外，还可以自定义日志格式。例如，可以添加模块名、行号等信息。
custom_formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(module)s - %(lineno)d - %(message)s')
console_handler.setFormatter(custom_formatter)
file_handler.setFormatter(custom_formatter)
五、日志配置
除了手动配置日志记录器、处理器和格式化器外，还可以使用配置文件或字典来配置日志。logging模块提供了config模块，用于从配置文件或字典中读取日志配置。
1、使用配置文件
可以使用INI格式的配置文件来配置日志。创建一个logging配置文件，例如logging.conf：
[loggers]
keys=root,my_logger
[handlers]
keys=consoleHandler,fileHandler
[formatters]
keys=formatter1
[logger_root]
level=DEBUG
handlers=consoleHandler
[logger_my_logger]
level=DEBUG
handlers=consoleHandler,fileHandler
qualname=my_logger
propagate=0
[handler_consoleHandler]
class=StreamHandler
level=DEBUG
formatter=formatter1
args=(sys.stdout,)
[handler_fileHandler]
class=FileHandler
level=DEBUG
formatter=formatter1
args=('app.log', 'a')
[formatter_formatter1]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
然后使用logging.config.fileConfig()函数加载配置文件：
import logging.config
logging.config.fileConfig('logging.conf')
logger = logging.getLogger('my_logger')
2、使用字典配置
可以使用字典来配置日志。创建一个日志配置字典，例如logging_config：
logging_config = {
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'formatter1': {
'format': '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
},
},
'handlers': {
'consoleHandler': {
'class': 'logging.StreamHandler',
'level': 'DEBUG',
'formatter': 'formatter1',
'stream': 'ext://sys.stdout'
},
'fileHandler': {
'class': 'logging.FileHandler',
'level': 'DEBUG',
'formatter': 'formatter1',
'filename': 'app.log',
'mode': 'a'
}
},
'loggers': {
'my_logger': {
'level': 'DEBUG',
'handlers': ['consoleHandler', 'fileHandler'],
'propagate': False
}
}
}
logging.config.dictConfig(logging_config)
logger = logging.getLogger('my_logger')
六、日志捕获异常
在实际应用中，捕获异常并记录日志是非常重要的。可以使用try-except语句来捕获异常，并使用logger.exception()方法记录异常信息。
try:
result = 10 / 0
except ZeroDivisionError as e:
logger.exception('An error occurred')
logger.exception()方法会自动记录异常的详细信息，包括异常类型、异常消息和堆栈跟踪。
七、多模块日志
在大型项目中，通常会有多个模块。为了方便管理和调试日志，可以在每个模块中创建独立的日志记录器。
1、在模块中创建日志记录器
在每个模块中，可以使用logging.getLogger()函数创建一个命名的日志记录器。可以使用模块的名称作为日志记录器的名称。
# module1.py
import logging
logger = logging.getLogger('module1')
def function1():
logger.info('Function1 in module1')
# module2.py
import logging
logger = logging.getLogger('module2')
def function2():
logger.info('Function2 in module2')
2、在主程序中配置日志
在主程序中，可以统一配置日志记录器、处理器和格式化器，并将配置应用到各个模块的日志记录器中。
# main.py
import logging
import logging.config
import module1
import module2
logging_config = {
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'formatter1': {
'format': '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
},
},
'handlers': {
'consoleHandler': {
'class': 'logging.StreamHandler',
'level': 'DEBUG',
'formatter': 'formatter1',
'stream': 'ext://sys.stdout'
},
'fileHandler': {
'class': 'logging.FileHandler',
'level': 'DEBUG',
'formatter': 'formatter1',
'filename': 'app.log',
'mode': 'a'
}
},
'loggers': {
'module1': {
'level': 'DEBUG',
'handlers': ['consoleHandler', 'fileHandler'],
'propagate': False
},
'module2': {
'level': 'DEBUG',
'handlers': ['consoleHandler', 'fileHandler'],
'propagate': False
}
}
}
logging.config.dictConfig(logging_config)
module1.function1()
module2.function2()
这样，在不同模块中记录的日志消息会使用统一的配置，并输出到指定的位置。
八、性能优化
在记录大量日志时，可能会影响程序的性能。可以通过以下几种方法优化日志记录性能。
1、异步日志
可以使用异步日志处理器（例如QueueHandler）来将日志消息放入队列中，然后由后台线程处理日志消息。这种方法可以减少日志记录对主线程的影响。
import logging
from logging.handlers import QueueHandler, QueueListener
import queue
log_queue = queue.Queue(-1)
queue_handler = QueueHandler(log_queue)
queue_listener = QueueListener(log_queue, console_handler, file_handler)
logger.addHandler(queue_handler)
queue_listener.start()
2、减少日志级别
可以根据需要设置适当的日志级别，减少不必要的日志记录。例如，在生产环境中可以设置日志级别为WARNING或ERROR，减少DEBUG和INFO级别的日志消息。
logger.setLevel(logging.WARNING)
3、批量记录日志
可以使用批量记录日志的方法，将多条日志消息合并为一条日志消息，减少日志处理的次数。
log_messages = []
for i in range(100):
log_messages.append(f'Message {i}')
logger.info('\n'.join(log_messages))
九、日志管理工具
在实际应用中，可以使用一些日志管理工具来集中管理和分析日志消息。例如：
1、Elasticsearch、Logstash和Kibana（ELK）
ELK是一套开源日志管理工具，Elasticsearch用于存储和搜索日志消息，Logstash用于收集和解析日志消息，Kibana用于可视化和分析日志消息。
2、Graylog
Graylog是一种开源日志管理工具，用于集中管理和分析日志消息。它支持多种日志输入和输出格式，并提供强大的搜索和分析功能。
3、Splunk
Splunk是一种商业日志管理工具，用于收集、存储和分析日志消息。它提供丰富的搜索、分析和可视化功能，适用于大规模日志管理和分析。
通过使用这些日志管理工具，可以更好地管理和分析日志消息，提升日志记录的效率和效果。
总结起来，Python logging模块是一个功能强大且灵活的日志记录工具，通过合理配置日志记录器、日志处理器和日志格式化器，可以满足不同应用场景的日志记录需求。同时，通过使用异步日志、减少日志级别和批量记录日志等方法，可以优化日志记录的性能。最后，通过使用日志管理工具，可以集中管理和分析日志消息，提升日志记录的效率和效果。
相关问答FAQs：
如何在Python中设置基本的日志记录配置？
要在Python中设置基本的日志记录配置，可以使用logging模块的basicConfig方法。通过指定日志级别、输出格式和日志文件等参数，可以轻松配置日志记录。例如，使用logging.basicConfig(level=logging.INFO)可以将日志级别设置为INFO，从而记录INFO及以上级别的日志信息。
可以使用哪些不同的日志级别？
Python的logging模块提供了多种日志级别，包括DEBUG、INFO、WARNING、ERROR和CRITICAL。DEBUG级别用于详细的调试信息，INFO级别用于常规信息，WARNING用于警告信息，ERROR表示错误事件，而CRITICAL则表示严重错误。根据需要选择合适的级别，以便记录所需的重要信息。
如何将日志信息输出到文件而不是控制台？
要将日志信息输出到文件，可以在basicConfig中指定filename参数。例如，使用logging.basicConfig(filename='app.log', level=logging.INFO)将日志信息写入名为app.log的文件中。这使得您可以方便地查看和分析日志记录，而不是仅在控制台上显示。
