python如何写log日志

Python写日志的步骤包括：导入logging模块、配置日志记录器、定义日志级别、设置日志格式、添加日志处理器。其中，配置日志记录器是关键步骤，需要细致处理。下面将详细介绍这些步骤及其背后的原理。

一、导入logging模块

Python内置的logging模块是记录日志的核心库。它提供了灵活的日志记录功能，支持不同级别的日志消息，并可以将日志输出到不同位置。

import logging

二、配置日志记录器

日志记录器（Logger）是logging模块的核心组件，负责处理各种日志消息。配置日志记录器时，需要指定日志级别、日志格式、日志处理器等。

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

日志级别：日志级别决定了哪些日志消息会被处理。常见的日志级别有DEBUG、INFO、WARNING、ERROR和CRITICAL。
日志格式：日志格式定义了日志消息的显示方式。可以包括时间、日志级别、日志消息等。

三、定义日志级别

日志级别用于控制日志的输出。不同级别的日志消息可以帮助开发者在不同情况下调试代码。

logger.setLevel(logging.DEBUG)

常见的日志级别：

DEBUG：调试级别，记录详细的信息，通常只在开发和调试阶段使用。
INFO：信息级别，记录程序运行的普通信息。
WARNING：警告级别，记录潜在的问题。
ERROR：错误级别，记录程序中的错误信息。
CRITICAL：严重错误级别，记录系统崩溃等严重错误。

四、设置日志格式

日志格式决定了日志消息的显示方式。可以通过Formatter类来设置日志格式。

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

常见的格式化字符串：

%(asctime)s：日志记录的时间。
%(name)s：日志记录器的名称。
%(levelname)s：日志级别。
%(message)s：日志消息。

五、添加日志处理器

日志处理器（Handler）决定了日志的输出位置。可以将日志输出到控制台、文件、网络等。

控制台处理器

将日志输出到控制台。

console_handler = logging.StreamHandler()
console_handler.setFormatter(formatter)
logger.addHandler(console_handler)

文件处理器

将日志输出到文件。

file_handler = logging.FileHandler('app.log')
file_handler.setFormatter(formatter)
logger.addHandler(file_handler)

其他处理器

可以将日志输出到网络、邮件等其他位置。logging模块提供了多种处理器，如SMTPHandler、HTTPHandler等。

六、日志消息

配置好日志记录器后，可以通过调用日志记录器的方法来记录日志消息。

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')

七、示例代码

以下是一个完整的示例代码，展示了如何使用logging模块记录日志。

import logging
创建日志记录器
logger = logging.getLogger('my_logger')
logger.setLevel(logging.DEBUG)
创建日志格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
创建控制台处理器
console_handler = logging.StreamHandler()
console_handler.setFormatter(formatter)
创建文件处理器
file_handler = logging.FileHandler('app.log')
file_handler.setFormatter(formatter)
添加处理器到日志记录器
logger.addHandler(console_handler)
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')

八、日志轮转

在长时间运行的应用程序中，日志文件可能会变得非常大。为了避免日志文件过大，可以使用日志轮转机制。logging模块提供了RotatingFileHandler和TimedRotatingFileHandler来实现日志轮转。

轮转文件处理器

RotatingFileHandler会在日志文件达到指定大小后进行轮转。

from logging.handlers import RotatingFileHandler
rotating_handler = RotatingFileHandler('app.log', maxBytes=1024*1024, backupCount=3)
rotating_handler.setFormatter(formatter)
logger.addHandler(rotating_handler)

maxBytes：日志文件的最大大小，单位为字节。
backupCount：保留的备份日志文件数量。

定时轮转文件处理器

TimedRotatingFileHandler会在指定时间间隔后进行轮转。

from logging.handlers import TimedRotatingFileHandler
timed_handler = TimedRotatingFileHandler('app.log', when='midnight', interval=1, backupCount=7)
timed_handler.setFormatter(formatter)
logger.addHandler(timed_handler)

when：轮转时间的单位，可以是‘S’（秒）、‘M’（分钟）、‘H’（小时）、‘D’（天）、‘W0’-‘W6’（星期一到星期天）、‘midnight’（午夜）。
interval：时间间隔。
backupCount：保留的备份日志文件数量。

九、日志过滤器

日志过滤器（Filter）用于对日志消息进行过滤。可以自定义过滤器来决定哪些日志消息会被记录。

class MyFilter(logging.Filter):
    def filter(self, record):
        return 'specific_keyword' in record.msg
filter = MyFilter()
logger.addFilter(filter)

十、日志配置文件

可以使用配置文件来配置日志记录器。常见的配置文件格式有INI、JSON和YAML。

INI配置文件

[loggers]
keys=root,my_logger
[handlers]
keys=consoleHandler,fileHandler
[formatters]
keys=myFormatter
[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=myFormatter
args=(sys.stdout,)
[handler_fileHandler]
class=FileHandler
level=DEBUG
formatter=myFormatter
args=('app.log', 'a')
[formatter_myFormatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
datefmt=

JSON配置文件

{
    "version": 1,
    "disable_existing_loggers": false,
    "formatters": {
        "myFormatter": {
            "format": "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
        }
    },
    "handlers": {
        "consoleHandler": {
            "class": "logging.StreamHandler",
            "formatter": "myFormatter",
            "level": "DEBUG",
            "stream": "ext://sys.stdout"
        },
        "fileHandler": {
            "class": "logging.FileHandler",
            "formatter": "myFormatter",
            "level": "DEBUG",
            "filename": "app.log",
            "mode": "a"
        }
    },
    "loggers": {
        "my_logger": {
            "level": "DEBUG",
            "handlers": ["consoleHandler", "fileHandler"],
            "propagate": "no"
        }
    },
    "root": {
        "level": "DEBUG",
        "handlers": ["consoleHandler"]
    }
}

YAML配置文件

version: 1 disable_existing_loggers: false formatters: myFormatter: format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s' handlers: consoleHandler: class: logging.StreamHandler formatter: myFormatter level: DEBUG stream: ext://sys.stdout fileHandler: class: logging.FileHandler formatter: myFormatter level: DEBUG filename: app.log mode: a loggers: my_logger: level: DEBUG handlers: [consoleHandler, fileHandler] propagate: no root: level: DEBUG handlers: [consoleHandler]

十一、使用配置文件

使用配置文件配置日志记录器时，可以使用logging.config模块。

import logging
import logging.config
import json
with open('logging.json', 'r') as f:
    config = json.load(f)
logging.config.dictConfig(config)
logger = logging.getLogger('my_logger')
logger.debug('This is a debug message')

十二、总结

通过logging模块，Python提供了强大而灵活的日志记录功能。通过配置日志记录器、定义日志级别、设置日志格式、添加日志处理器等步骤，可以实现丰富的日志记录功能。此外，通过使用日志轮转、日志过滤器和日志配置文件，可以进一步增强日志记录的灵活性和可维护性。在实际应用中，合理使用日志记录功能，可以极大地提高代码的可调试性和可维护性。