如何查看python程序日志

要查看Python程序日志，可以使用内置的logging模块、通过设置不同的日志级别来控制输出、将日志输出到文件中以便于后续查看。 其中，使用logging模块是最常见的方法，因为它提供了灵活而强大的日志记录功能。我们可以通过配置日志记录器（logger）来控制日志的格式和输出位置。接下来，我将详细介绍如何使用logging模块来查看和管理Python程序的日志。

一、使用LOGGING模块设置日志

Python的logging模块提供了一种通用的日志系统，它可以很方便地帮助我们记录程序的运行过程、错误信息以及其他重要的调试信息。

1.1、配置基本日志

要快速配置日志记录，可以使用logging.basicConfig()方法。这种方法适用于简单的日志记录需求。

import logging
配置基本的日志信息
logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s - %(levelname)s - %(message)s')
记录不同级别的日志
logging.debug('这是一个调试消息')
logging.info('这是一个信息消息')
logging.warning('这是一个警告消息')
logging.error('这是一个错误消息')
logging.critical('这是一个严重错误消息')

在上述代码中，我们使用basicConfig方法配置了日志的输出格式和级别。level参数设置最低级别的日志消息，低于此级别的日志消息将被忽略。format参数定义了日志消息的格式。

1.2、日志级别

logging模块定义了多个日志级别（从低到高）：DEBUG、INFO、WARNING、ERROR、CRITICAL。默认情况下，logging模块只会处理级别为WARNING及以上的消息，但我们可以通过配置来改变这一行为。

二、将日志输出到文件

为便于后续分析和查看，可以将日志输出到文件中。logging模块允许我们将日志写入文件，这在调试和生产环境中非常有用。

2.1、将日志输出到文件

要将日志输出到文件，可以在basicConfig中使用filename参数。

import logging
将日志输出到文件
logging.basicConfig(filename='app.log', level=logging.DEBUG,
                    format='%(asctime)s - %(levelname)s - %(message)s')
logging.debug('这是一个调试消息')
logging.info('这是一个信息消息')
logging.warning('这是一个警告消息')
logging.error('这是一个错误消息')
logging.critical('这是一个严重错误消息')

2.2、使用多个处理器

如果需要同时将日志输出到控制台和文件，可以使用logging模块中的处理器（Handler）来实现。常用的处理器包括StreamHandler（用于输出到控制台）和FileHandler（用于输出到文件）。

import logging
创建一个日志记录器
logger = logging.getLogger()
logger.setLevel(logging.DEBUG)
创建一个控制台处理器并设置级别
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.DEBUG)
创建一个文件处理器并设置级别
file_handler = logging.FileHandler('app.log')
file_handler.setLevel(logging.DEBUG)
定义日志格式
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
设置处理器的格式
console_handler.setFormatter(formatter)
file_handler.setFormatter(formatter)
将处理器添加到日志记录器
logger.addHandler(console_handler)
logger.addHandler(file_handler)
记录日志
logger.debug('这是一个调试消息')
logger.info('这是一个信息消息')
logger.warning('这是一个警告消息')
logger.error('这是一个错误消息')
logger.critical('这是一个严重错误消息')

三、日志格式化和记录器

logging模块提供了灵活的日志格式化选项，可以根据需要自定义日志输出的格式。

3.1、自定义日志格式

通过Formatter类，我们可以定义日志消息的格式。

import logging
自定义日志格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
创建一个日志记录器
logger = logging.getLogger('MyLogger')
logger.setLevel(logging.DEBUG)
创建一个控制台处理器并设置级别
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.DEBUG)
设置处理器的格式
console_handler.setFormatter(formatter)
将处理器添加到日志记录器
logger.addHandler(console_handler)
记录日志
logger.debug('这是一个调试消息')
logger.info('这是一个信息消息')
logger.warning('这是一个警告消息')
logger.error('这是一个错误消息')
logger.critical('这是一个严重错误消息')

3.2、使用不同的日志记录器

在复杂的应用程序中，可以定义多个日志记录器来处理不同的日志需求。

import logging
创建日志记录器
app_logger = logging.getLogger('AppLogger')
app_logger.setLevel(logging.DEBUG)
db_logger = logging.getLogger('DBLogger')
db_logger.setLevel(logging.INFO)
创建控制台处理器并设置级别
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.DEBUG)
定义日志格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
console_handler.setFormatter(formatter)
将处理器添加到日志记录器
app_logger.addHandler(console_handler)
db_logger.addHandler(console_handler)
记录日志
app_logger.debug('应用程序日志 - 调试消息')
db_logger.info('数据库日志 - 信息消息')

四、日志轮转和高级配置

在某些情况下，日志文件可能会变得非常大。为了避免这个问题，可以使用日志轮转技术。

4.1、使用RotatingFileHandler

RotatingFileHandler可以让日志文件在达到指定大小时进行轮转。

import logging
from logging.handlers import RotatingFileHandler
创建一个日志记录器
logger = logging.getLogger('RotatingLogger')
logger.setLevel(logging.DEBUG)
创建一个轮转文件处理器
rotating_handler = RotatingFileHandler('rotating_app.log', maxBytes=2000, backupCount=5)
rotating_handler.setLevel(logging.DEBUG)
定义日志格式
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
rotating_handler.setFormatter(formatter)
将处理器添加到日志记录器
logger.addHandler(rotating_handler)
记录日志
for i in range(100):
    logger.debug(f'这是第{i}条调试消息')

4.2、使用TimedRotatingFileHandler

TimedRotatingFileHandler可以根据时间间隔进行日志轮转，例如每天创建一个新的日志文件。

import logging
from logging.handlers import TimedRotatingFileHandler
创建一个日志记录器
logger = logging.getLogger('TimedRotatingLogger')
logger.setLevel(logging.DEBUG)
创建一个基于时间的轮转文件处理器
timed_handler = TimedRotatingFileHandler('timed_app.log', when='midnight', interval=1, backupCount=5)
timed_handler.setLevel(logging.DEBUG)
定义日志格式
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
timed_handler.setFormatter(formatter)
将处理器添加到日志记录器
logger.addHandler(timed_handler)
记录日志
logger.debug('这是一个调试消息')

五、在实际项目中应用日志

在实际项目中，合理使用日志可以帮助开发者快速定位问题、监控程序运行状态、以及记录重要的业务操作。

5.1、记录关键业务操作

在重要的业务操作中记录日志，可以帮助我们追踪操作过程及结果。例如，在用户注册、登录、订单支付等环节记录日志。

import logging
创建一个日志记录器
logger = logging.getLogger('BusinessLogger')
logger.setLevel(logging.INFO)
创建控制台处理器
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.INFO)
定义日志格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
console_handler.setFormatter(formatter)
将处理器添加到日志记录器
logger.addHandler(console_handler)
记录关键业务操作
def user_register(username):
    logger.info(f'用户{username}注册成功')
def user_login(username):
    logger.info(f'用户{username}登录成功')
user_register('Alice')
user_login('Alice')

5.2、记录错误和异常信息

在程序中捕获异常时记录错误日志，可以帮助我们分析问题原因和定位错误位置。

import logging
创建一个日志记录器
logger = logging.getLogger('ErrorLogger')
logger.setLevel(logging.ERROR)
创建控制台处理器
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.ERROR)
定义日志格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
console_handler.setFormatter(formatter)
将处理器添加到日志记录器
logger.addHandler(console_handler)
捕获异常并记录错误日志
def divide(a, b):
    try:
        result = a / b
    except ZeroDivisionError as e:
        logger.error('除数不能为零', exc_info=True)
    else:
        return result
divide(10, 0)