Python 的 logging 模块的简单用法

在服务器部署时，往往都是在后台运行。当程序发生特定的错误时，我希望能够在日志中查询。因此这里熟悉以下 logging 模块的用法。

logging 模块定义了报告错误和状态信息的标准 API。

logging 的组件

日志系统有 4 个相互交互的组件。我们需要使用 Logger 实例来向日志添加信息。触发日志会创建一个 LogRecord，用于内存中存储信息。Logger 可能有很多 Handler 对象，用于接收和处理日志记录。Handler 使用 Formatter 来输出日志记录。

向文件输入日志

大多数应用都是把日志输入到文件。使用 basicConfig() 函数可以设置默认的 handler，让日志输入到文件。

 1 #!/usr/bin/env python
 2 # -*- coding: utf-8 -*-
 3 import logging
 4 
 5 LOG_FILENAME = 'log.txt'
 6 logging.basicConfig(
 7     filename=LOG_FILENAME,
 8     level=logging.DEBUG,
 9 )
10 
11 logging.debug('hello logging!')
12 
13 with open(LOG_FILENAME, 'rt') as f:
14     body = f.read()
15 
16 print('FILE: ')
17 print(body)

运行脚本后输出如下：

FILE: 
DEBUG:root:hello logging!

日志文件的循环

要让每次程序运行时，生成一个新的文件，需要向 basicConfig() 传一个值为 w 的 filemode 参数。还有一个更方便的方法，就是使用 RotatingFileHandler，可以同时自动创建文件和保存旧文件。

 1 #!/usr/bin/env python
 2 # -*- coding: utf-8 -*-
 3 import glob
 4 import logging.handlers
 5 
 6 LOG_FILENAME = 'log.txt'
 7 
 8 my_logger = logging.getLogger('SpecificLogger')
 9 my_logger.setLevel(logging.DEBUG)
10 
11 # Add the log message handler to the logger
12 handler = logging.handlers.RotatingFileHandler(
13     LOG_FILENAME,
14     maxBytes=20,
15     backupCount=5,
16 )
17 my_logger.addHandler(handler)
18 
19 # Log some messages
20 for i in range(20):
21     my_logger.debug(f'i = {i}')
22 
23 # See what files are created
24 log_files = glob.glob(f'{LOG_FILENAME}*')
25 for filename in sorted(log_files):
26     print(filename)

运行脚本后输出如下：

log.txt
log.txt.1
log.txt.2
log.txt.3
log.txt.4
log.txt.5

可以返现，log.txt 存储的都是最新的内容，logging 会自动地对这些文件进行重命名。

信息显示的级别

logging 有不同的日志级别。

级别（level）	值（value）
CRITICAL	50
ERROR	40
WARNING	30
INFO	20
DEBUG	10
UNSET	0

日志可以只在某一级别之上的情况才会触发。

 1 #!/usr/bin/env python
 2 # -*- coding: utf-8 -*-
 3 import logging
 4 import sys
 5 
 6 level = int(sys.argv[1])
 7 logging.basicConfig(
 8     level=level
 9 )
10 
11 logging.debug('debug message')
12 logging.info('info message')
13 logging.warning('warning message')
14 logging.error('error message')
15 logging.critical('critical message')

$ python logging_level.py 10
DEBUG:root:debug message
INFO:root:info message
WARNING:root:warning message
ERROR:root:error message
CRITICAL:root:critical message

$ python logging_level 40
ERROR:root:error message
CRITICAL:root:critical message

命名 logging 实例

 1 #!/usr/bin/env python
 2 # -*- coding: utf-8 -*-
 3 import logging
 4 
 5 logging.basicConfig(
 6     level=logging.WARNING
 7 )
 8 
 9 logger1 = logging.getLogger('package1.module1')
10 logger2 = logging.getLogger('package2.module2')
11 
12 logger1.warning('hello 1')
13 logger2.warning('hello 2')

运行脚本后输出：

WARNING:package1.module1:hello 1
WARNING:package2.module2:hello 2

秒客网

Python的logging模块基本用法