Python日志输出到文件详解

一、日志输出概述

在程序开发中，日志输出是一个非常重要的工具。一方面，它可以帮助程序员在开发阶段更好的调试和定位问题，另一方面，它也能够在程序正式部署后，帮助运维人员定位bug并解决问题。

Python的logging模块是一个强大的日志输出模块，它支持多种输出方式，包括输出到控制台，输出到文件，甚至可以将日志输出到远程服务器等。

二、将日志输出到文件

将日志输出到文件是非常常见的一种方式。下面是一个简单的例子，展示如何将日志输出到文件。

import logging.handlers

# 创建日志对象
logger = logging.getLogger()
logger.setLevel(logging.INFO)

# 创建文件日志处理器
file_handler = logging.handlers.RotatingFileHandler("/var/log/python.log", maxBytes=1024*1024, backupCount=10, encoding='utf8')

# 创建日志格式对象
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

# 将日志格式配置到文件日志处理器中
file_handler.setFormatter(formatter)

# 将文件日志处理器添加到日志对象中
logger.addHandler(file_handler)

# 输出日志
logger.info("This is a log message.")

以上代码中，我们首先使用logging模块的getLogger方法创建了一个日志对象。然后设置了日志对象的级别，这里我们设置为INFO级别，表示只会输出INFO级别及以上的日志信息。接下来，我们使用RotatingFileHandler类创建了一个文件日志处理器，参数含义如下：

filename：日志输出文件的路径和名称
maxBytes：单个日志文件最大的大小（单位：字节），当超过这个大小时系统会自动生成新的日志文件
backupCount：日志文件最大数量，超过这个数量后，系统会自动删除最早的日志文件
encoding：日志文件的编码格式

然后我们通过logging.Formatter类创建了一个日志格式对象，并将这个日志格式配置到了文件日志处理器中。最后，我们将文件日志处理器添加到了日志对象中，并输出了一条日志信息。

三、日志等级

logging模块支持多种日志级别，如下所示：

DEBUG：详细的 debug 信息，通常只在开发 / 测试阶段使用
INFO：确认一切按预期进行
WARNING：表示出现了一些意外或异常，但是并不是致命的或者错误的
ERROR：由于更严重的问题，某些功能已经不能正常执行
CRITICAL：非常严重的问题，程序已经不能继续执行

对于不同的应用场景，我们可以根据需要选择不同的日志级别。一般来说，我们可以将日志级别设置为INFO或者WARNING，同时将日志输出到文件，这样既能保证程序运行的正常，同时又能够在出现问题时方便地定位和解决问题。

四、日志回滚和归档

在实际应用中，日志文件可能会比较大，此时就需要对日志文件进行回滚和归档。Python的logging模块提供了RotatingFileHandler和TimedRotatingFileHandler两个类实现日志回滚和归档的功能。

RotatingFileHandler类实现了按大小回滚，当日志文件大小超过maxBytes时，会自动将当前日志文件重命名为一个备份文件，并创建一个新的日志文件继续写入。backupCount参数指定保留的备份文件数量。

TimedRotatingFileHandler类实现了按时间回滚，可以按天/小时/分钟等进行归档。when参数指定回滚时间的单位，比如when=’D’表示按天回滚，when=’H’表示按小时回滚，interval参数指定回滚时间的间隔，backupCount参数指定备份文件数量。下面是一个TimedRotatingFileHandler的例子：

import logging.handlers

logger = logging.getLogger()
logger.setLevel(logging.INFO)

file_handler = logging.handlers.TimedRotatingFileHandler('/var/log/python.log', when='midnight', interval=1, backupCount=10, encoding='utf8')

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

file_handler.setFormatter(formatter)

logger.addHandler(file_handler)

logger.info("This is a log message.")

以上代码中，我们使用了TimedRotatingFileHandler类创建了一个按天归档的文件日志处理器。参数含义如下：

filename：日志输出文件的路径和名称
when：回滚时间单位，支持的值包括：“S”-秒，“M”-分钟，“H”-小时，“D”-天，“W0”-“W6”(星期一到星期日)
interval：回滚时间间隔
backupCount：保留的备份文件数量
encoding：日志文件的编码格式

五、总结

本文介绍了Python日志输出到文件的相关知识，包括将日志输出到文件、日志等级、日志回滚和归档等内容。在实际应用中，我们可以根据不同的场景选择不同的日志输出方式，并结合日志等级、回滚和归档等机制，使得系统在运行过程中更加健壮。

原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/241201.html