python如何写系统日志

Python写系统日志的方法：使用logging模块、设置日志级别、配置日志格式、日志文件输出

在Python中，写系统日志是非常重要的，它可以帮助我们记录程序运行过程中的重要信息、调试程序、以及在出错时进行排查。其中，使用logging模块是最常见和推荐的方法。通过logging模块可以方便地设置日志级别、配置日志格式、并将日志输出到文件中。接下来，我们将详细介绍这些方法中的一个：配置日志格式。

配置日志格式：

在日志记录中，格式非常重要，因为它决定了日志信息的可读性和有用性。通过设置日志格式，我们可以自定义日志条目的内容，包括时间戳、日志级别、模块名称、消息内容等。下面是一个例子：

import logging
配置日志格式
logging.basicConfig(
    level=logging.DEBUG,
    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
    datefmt='%Y-%m-%d %H:%M:%S',
    handlers=[
        logging.FileHandler('app.log', encoding='utf-8'),
        logging.StreamHandler()
    ]
)
logger = logging.getLogger(__name__)
logger.debug('这是一个调试信息')
logger.info('这是一个信息日志')
logger.warning('这是一个警告信息')
logger.error('这是一个错误信息')
logger.critical('这是一个严重错误信息')

在上面的例子中，我们通过logging.basicConfig函数配置了日志格式，指定了日志的级别、格式、日期格式、输出处理器等。接下来，我们来详细介绍Python写系统日志的各个方面。

一、使用logging模块

1、logging模块简介

Python的标准库提供了一个功能强大的日志模块logging。logging模块提供了多个日志级别、灵活的日志配置、以及多种日志处理器，能够满足各种日志记录需求。它的主要组件包括：

Logger：日志记录器，用于生成日志信息。
Handler：日志处理器，用于控制日志的输出位置，如文件、控制台等。
Formatter：日志格式化器，用于控制日志信息的格式。
Filter：日志过滤器，用于控制哪些日志会被记录。

2、Logger的使用

Logger是日志模块的核心组件，用于生成日志信息。我们可以通过logging.getLogger()函数获取一个Logger对象，然后使用它的各种方法记录不同级别的日志信息。

import logging
logger = logging.getLogger(__name__)
logger.debug('这是一个调试信息')
logger.info('这是一个信息日志')
logger.warning('这是一个警告信息')
logger.error('这是一个错误信息')
logger.critical('这是一个严重错误信息')

在上面的例子中，我们通过logging.getLogger(__name__)获取了一个Logger对象，然后使用它的debug()、info()、warning()、error()和critical()方法记录不同级别的日志信息。

3、设置日志级别

日志级别用于控制日志的输出。logging模块提供了以下几种日志级别（按严重程度递增）：

DEBUG：调试信息，详细的信息，通常只在调试时使用。
INFO：信息日志，程序正常运行的信息。
WARNING：警告信息，表示程序可能会出现问题。
ERROR：错误信息，表示程序出错，但还能继续运行。
CRITICAL：严重错误信息，表示程序遇到严重错误，可能无法继续运行。

我们可以通过Logger对象的setLevel()方法设置日志级别。例如，设置日志级别为DEBUG：

logger.setLevel(logging.DEBUG)

二、配置日志格式

1、基本配置

logging模块提供了一个basicConfig()函数，用于配置日志的基本设置。通过basicConfig()函数，我们可以设置日志级别、日志格式、日志输出位置等。

import logging
logging.basicConfig(
    level=logging.DEBUG,
    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
    datefmt='%Y-%m-%d %H:%M:%S'
)
logger = logging.getLogger(__name__)
logger.debug('这是一个调试信息')
logger.info('这是一个信息日志')
logger.warning('这是一个警告信息')
logger.error('这是一个错误信息')
logger.critical('这是一个严重错误信息')

在上面的例子中，我们通过basicConfig()函数设置了日志级别为DEBUG，日志格式为'%(asctime)s - %(name)s - %(levelname)s - %(message)s'，日期格式为'%Y-%m-%d %H:%M:%S'。

2、日志格式化

日志格式化器（Formatter）用于控制日志信息的格式。我们可以通过定义一个Formatter对象，并将其添加到Handler中，来设置日志的格式。

import logging
创建日志格式化器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s', '%Y-%m-%d %H:%M:%S')
创建日志处理器
handler = logging.StreamHandler()
handler.setFormatter(formatter)
创建Logger对象
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)
logger.addHandler(handler)
logger.debug('这是一个调试信息')
logger.info('这是一个信息日志')
logger.warning('这是一个警告信息')
logger.error('这是一个错误信息')
logger.critical('这是一个严重错误信息')

在上面的例子中，我们首先创建了一个Formatter对象，然后创建了一个StreamHandler，并将Formatter添加到Handler中。最后，我们将Handler添加到Logger对象中。

三、日志文件输出

1、文件处理器

logging模块提供了多个日志处理器（Handler），用于控制日志的输出位置。常见的日志处理器包括：

StreamHandler：将日志输出到控制台。
FileHandler：将日志输出到文件。
RotatingFileHandler：将日志输出到文件，并支持日志文件的轮转。
TimedRotatingFileHandler：将日志输出到文件，并按时间进行日志文件的轮转。

我们可以使用FileHandler将日志输出到文件中。例如：

import logging
创建日志格式化器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s', '%Y-%m-%d %H:%M:%S')
创建文件处理器
file_handler = logging.FileHandler('app.log', encoding='utf-8')
file_handler.setFormatter(formatter)
创建Logger对象
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)
logger.addHandler(file_handler)
logger.debug('这是一个调试信息')
logger.info('这是一个信息日志')
logger.warning('这是一个警告信息')
logger.error('这是一个错误信息')
logger.critical('这是一个严重错误信息')

在上面的例子中，我们创建了一个FileHandler，并将其日志输出文件设置为'app.log'，编码设置为'utf-8'。然后将Formatter添加到FileHandler中，并将FileHandler添加到Logger对象中。

2、日志文件轮转

在某些情况下，我们可能需要对日志文件进行轮转，以防止单个日志文件过大。logging模块提供了RotatingFileHandler和TimedRotatingFileHandler来实现日志文件轮转。

import logging
from logging.handlers import RotatingFileHandler
创建日志格式化器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s', '%Y-%m-%d %H:%M:%S')
创建轮转文件处理器
rotating_handler = RotatingFileHandler('app.log', maxBytes=1024*1024, backupCount=3, encoding='utf-8')
rotating_handler.setFormatter(formatter)
创建Logger对象
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)
logger.addHandler(rotating_handler)
logger.debug('这是一个调试信息')
logger.info('这是一个信息日志')
logger.warning('这是一个警告信息')
logger.error('这是一个错误信息')
logger.critical('这是一个严重错误信息')

在上面的例子中，我们创建了一个RotatingFileHandler，并将日志文件设置为'app.log'，最大文件大小设置为1MB，备份文件数量设置为3个，编码设置为'utf-8'。然后将Formatter添加到RotatingFileHandler中，并将RotatingFileHandler添加到Logger对象中。

四、日志过滤与筛选

1、日志过滤器

日志过滤器（Filter）用于控制哪些日志会被记录。我们可以通过定义一个Filter类，并将其添加到Logger或Handler中，实现日志的过滤。

import logging
class MyFilter(logging.Filter):
    def filter(self, record):
        return '关键字' in record.getMessage()
创建日志格式化器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s', '%Y-%m-%d %H:%M:%S')
创建日志处理器
handler = logging.StreamHandler()
handler.setFormatter(formatter)
创建Logger对象
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)
logger.addHandler(handler)
添加日志过滤器
logger.addFilter(MyFilter())
logger.debug('这是一个调试信息')
logger.info('这是一个包含关键字的信息日志')
logger.warning('这是一个警告信息')
logger.error('这是一个错误信息')
logger.critical('这是一个严重错误信息')

在上面的例子中，我们定义了一个Filter类MyFilter，并实现了它的filter方法，使得只有包含'关键字'的日志信息才会被记录。然后将MyFilter添加到Logger对象中。

2、日志筛选

除了使用Filter类，我们还可以通过在日志记录方法中添加条件来实现日志的筛选。例如：

import logging
创建日志格式化器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s', '%Y-%m-%d %H:%M:%S')
创建日志处理器
handler = logging.StreamHandler()
handler.setFormatter(formatter)
创建Logger对象
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)
logger.addHandler(handler)
日志记录条件
if '关键字' in '这是一个包含关键字的信息日志':
    logger.info('这是一个包含关键字的信息日志')
logger.debug('这是一个调试信息')
logger.warning('这是一个警告信息')
logger.error('这是一个错误信息')
logger.critical('这是一个严重错误信息')

在上面的例子中，我们在日志记录方法中添加了一个条件，使得只有包含'关键字'的日志信息才会被记录。

五、总结

通过本文的介绍，我们详细讲解了Python写系统日志的方法，包括使用logging模块、设置日志级别、配置日志格式、日志文件输出、日志过滤与筛选等方面的内容。使用logging模块可以方便地记录程序运行过程中的重要信息，通过配置日志格式和日志文件输出，我们可以提高日志信息的可读性和可用性。希望本文对您了解和使用Python的日志功能有所帮助。