Python 日志（logging）模块

级别	什么时候使用	数值
DEBUG	详细信息，一般只在调试问题时使用。	10
INFO	证明事情按预期工作。	20
WARNING	某些没有预料到的事件的提示，或者在将来可能会出现的问题提示。例如：磁盘空间不足。但是软件还是会照常运行。	30
ERROR	由于更严重的问题，软件已不能执行一些功能了。	40
CRITICAL	严重错误，表明软件已不能继续运行了。	50

log 配置

logging 库采取了模块化的设计，提供了许多组件：记录器、处理器、过滤器和格式化器。

• Logger 暴露了应用程序代码能直接使用的接口。
• Handler 将（记录器产生的）日志记录发送至合适的目的地。
• Filter 提供了更好的粒度控制，它可以决定输出哪些日志记录。
• Formatter 指明了最终输出中日志记录的布局。

Loggers:

Logger 对象要做三件事情。首先，它们向应用代码暴露了许多方法，这样应用可以在运行时记录消息。其次，记录器对象通过严重程度（默认的过滤设施）或者过滤器对象来决定哪些日志消息需要记录下来。第三，记录器对象将相关的日志消息传递给所有感兴趣的日志处理器。

常用的记录器对象的方法分为两类：配置和发送消息。

这些是最常用的配置方法：

Logger.setLevel() 指定logger将会处理的最低的安全等级日志信息, debug是最低的内置安全等级，critical是最高的内建安全等级。例如，如果严重程度为INFO，记录器将只处理INFO，WARNING，ERROR和CRITICAL消息，DEBUG消息被忽略。

Logger.addHandler() 和 Logger.removeHandler() 从记录器对象中添加和删除处理程序对象。处理器详见Handlers。

Logger.addFilter() 和Logger.removeFilter() 从记录器对象添加和删除过滤器对象。

Handlers

处理程序对象负责将适当的日志消息（基于日志消息的严重性）分派到处理程序的指定目标。Logger 对象可以通过 addHandler() 方法增加零个或多个 handler 对象。举个例子，一个应用可以将所有的日志消息发送至日志文件，所有的错误级别（error）及以上的日志消息发送至标准输出，所有的严重级别（critical）日志消息发送至某个电子邮箱。在这个例子中需要三个独立的处理器，每一个负责将特定级别的消息发送至特定的位置。

常用的有4种：

1) logging.StreamHandler -> 控制台输出

使用这个 Handler 可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息。

它的构造函数是：

• StreamHandler([strm])

其中strm参数是一个文件对象。默认是sys.stderr

2) logging.FileHandler -> 文件输出

和 StreamHandler 类似，用于向一个文件输出日志信息。不过 FileHandler 会帮你打开这个文件。它的构造函数是：

• FileHandler(filename[,mode])

filename 是文件名，必须指定一个文件名。

mode 是文件的打开方式。默认是’a'，即添加到文件末尾。

3) logging.handlers.RotatingFileHandler -> 按照大小自动分割日志文件，一旦达到指定的大小重新生成文件

这个Handler类似于上面的FileHandler，但是它可以管理文件大小。当文件达到一定大小之后，它会自动将当前日志文件改名，然后创建 一个新的同名日志文件继续输出。比如日志文件是chat.log。当chat.log达到指定的大小之后，RotatingFileHandler 自动把 文件改名为chat.log.1。不过，如果chat.log.1已经存在，会先把chat.log.1重命名为chat.log.2。。。最后重新创建 chat.log，继续输出日志信息。它的构造函数是：

• RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]])

• 其中 filename 和 mode 两个参数和FileHandler 一样。

• maxBytes 用于指定日志文件的最大文件大小。如果 maxBytes 为0，意味着日志文件可以无限大，这时上面描述的重命名过程就不会发生。

• backupCount 用于指定保留的备份文件的个数。比如，如果指定为2，当上面描述的重命名过程发生时，原有的chat.log.2并不会被更名，而是被删除。

4) logging.handlers.TimedRotatingFileHandler -> 按照时间自动分割日志文件

这个 Handler 和RotatingFileHandler类似，不过，它没有通过判断文件大小来决定何时重新创建日志文件，而是间隔一定时间就 自动创建新的日志文件。重命名的过程与 RotatingFileHandler类似，不过新的文件不是附加数字，而是当前时间。它的构造函数是：

• TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])
• 其中 filename 参数和 backupCount 参数和 RotatingFileHandler 具有相同的意义。
• interval 是时间间隔。

when 参数是一个字符串。表示时间间隔的单位，不区分大小写。它有以下取值：

• S 秒
• M 分
• H 小时
• D 天
• W 每星期（interval==0时代表星期一）
• midnight 每天凌晨

配置方法：

• setLevel() 方法和日志对象的一样，指明了将会分发日志的最低级别。为什么会有两个 setLevel() 方法？记录器的级别决定了消息是否要传递给处理器。每个处理器的级别决定了消息是否要分发。

• setFormatter() 为该处理器选择一个格式化器。

• addFilter() 和removeFilter() 分别配置和取消配置处理程序上的过滤器对象。

Formatters

Formatter 对象设置日志信息最后的规则、结构和内容，默认的时间格式为%Y-%m-%d %H:%M:%S，下面是 Formatter 常用的一些信息

参数名	说明
%(name)s	Logger的名字
%(levelno)s	数字形式的日志级别
%(levelname)s	文本形式的日志级别
%(pathname)s	调用日志输出函数的模块的完整路径名，可能没有
%(filename)s	调用日志输出函数的模块的文件名
%(module)s	调用日志输出函数的模块名
%(funcName)s	调用日志输出函数的函数名
%(lineno)d	调用日志输出函数的语句所在的代码行
%(created)f	当前时间，用UNIX标准的表示时间的浮 点数表示
%(relativeCreated)d	输出日志信息时的，自Logger创建以 来的毫秒数
%(asctime)s	字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。逗号后面的是毫秒
%(thread)d	线程ID。可能没有
%(threadName)s	线程名。可能没有
%(process)d	进程ID。可能没有
%(message)s	用户输出的消息

示例配置

BASE_DIR = os.path.dirname(os.path.dirname(os.path.dirname(__file__)))
LOG_DIR = os.path.join(BASE_DIR, "logs")
if not os.path.exists(LOG_DIR):
    os.makedirs(LOG_DIR)  # 创建路径

LOGGING_CONFIG = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'standard': {
            'format': '%(asctime)s - [%(levelname)s] - [%(name)s:%(funcName)s:%(lineno)d] - %(message)s'
        },
    },

    'handlers': {
        'info': {
            'class': 'logging.handlers.TimedRotatingFileHandler',
            'level': 'INFO',
            'formatter': 'standard',
            'filename': os.path.join(LOG_DIR, 'info.log'),
            'encoding': 'utf8',
            'when': 'D',
            'interval': 1,
            'backupCount': 30,
        },

        'debug': {
            'class': 'logging.handlers.TimedRotatingFileHandler',
            'level': 'DEBUG',
            'formatter': 'standard',
            'filename': os.path.join(LOG_DIR, 'debug.log'),
            'encoding': 'utf8',
            'when': 'D',
            'interval': 1,
            'backupCount': 30,
        },

        'error': {
            'class': 'logging.handlers.TimedRotatingFileHandler',
            'level': 'ERROR',
            'formatter': 'standard',
            'filename': os.path.join(LOG_DIR, 'error.log'),
            'encoding': 'utf8',
            'when': 'D',
            'interval': 1,
            'backupCount': 30,
        },
    },

    'loggers': {
        'app_name': {
            'level': 'INFO',
            'handlers': ['info', 'debug', 'error'],
            'propagate': 'no'
        }
    },

    'root': {
        'handlers': ['info', 'debug', 'error'],
        'level': 'INFO',
        'propagate': False
    }
}