Python中的logger和handler到底是个什么鬼

Posted 2020-11-08 风-fmgao

最近的任务经常涉及到日志的记录，特意去又学了一遍logging的记录方法。跟java一样，python的日志记录也是比较繁琐的一件事，在写一条记录之前，要写好多东西。典型的日志记录的步骤是这样的：

1. 创建logger
2. 创建handler
3. 定义formatter
4. 给handler添加formatter
5. 给logger添加handler

写成代码差不多就是酱婶的（这个是照别的网页抄的，参考附注）：

 1 import logging 
 2 
 3 # 1、创建一个logger 
 4 logger = logging.getLogger(‘mylogger‘) 
 5 logger.setLevel(logging.DEBUG) 
 6 
 7 # 2、创建一个handler，用于写入日志文件 
 8 fh = logging.FileHandler(‘test.log‘) 
 9 fh.setLevel(logging.DEBUG) 
10 
11 # 再创建一个handler，用于输出到控制台 
12 ch = logging.StreamHandler() 
13 ch.setLevel(logging.DEBUG) 
14 
15 # 3、定义handler的输出格式（formatter）
16 formatter = logging.Formatter(‘%(asctime)s - %(name)s - %(levelname)s - %(message)s‘) 
17 
18 # 4、给handler添加formatter
19 fh.setFormatter(formatter) 
20 ch.setFormatter(formatter) 
21 
22 # 5、给logger添加handler 
23 logger.addHandler(fh) 
24 logger.addHandler(ch) 

之后才可以正式的开始记录日志。Java里面的java.util.Logging类差不多也是这样，代码还要更复杂一点。Golang的日志相对写法简单一些，不过没有什么格式，系统记录一条时间，内容格式完全自己手画。第三方的日志库倒是没有接触过，像Java的Log4j，Golang的log4go和seelog等等，不知道用起来会不会简单一点。我一直都记不住这些，因为不太理解logger和handler为什么要这样写。一直到这次任务中出现的在我看来相当“诡异”的bug，才深入理解了一下。

我的任务是这样的，要做一个日志切割的工具，按天将日志分割开，即每天0点产生一个新日志，将旧日志改名。并且，将超过3个月的日志删除掉，以保证磁盘空间不会被log占满。程序要求可以切割多个目录中的不同日志，具体路径由json中配置。

这里用到了logging.handlers类中的TimedRotatingFileHandler方法，用以获得一个handler。大概的写法为：

1 logger = logging.getLogger() #获得logger
2 handler = logging.handlers.TimedRotatingFileHandler(logfile, ‘S‘, 1, 0) #切割日志
3 handler.suffix = ‘%Y%m%d‘ #切割后的日志设置后缀
4 logger.addHandler(handler) #把logger添加上handler
5 logger.fatal(datetime.datetime.now().strftime(‘%Y-%m-%d‘)) #在新日志中写上当天的日期

这里我没有设置level和formatter。因为只是分割，对新日志没有什么影响。TimedRotatingFileHandler函数的方法见附注，或查看python的源码，这个函数是python写的，可以找到定义。这里我使用的是每秒生成一个新的日志文件，之后用Crontab在每天0点调度，然后用for循环处理json中的每一个日志文件。

但是奇怪的是，每次运行程序，第一个切割的日志生成一个分割后的文件，而后面的都生成两个新日志。百思不得其解。后检查代码觉得，可能是程序中设置的时间太短了，每秒生成一个文件，有可能一秒钟处理不完，就生成了两个。虽然这个说法没有什么科学根据，但是还是把TimedRotatingFileHandler中的第三个参数改成了60，即每60秒生成一个文件。完成，静静的等待crontab到时间。

 

叮！时间到。赶紧检查一下结果。一个好消息和一个坏消息。好消息是这次每个日志都只切割生成了一个新文件，没有生成两个。坏消息是每个文件里面添加的当天的日期的数量见鬼了。我切割了4条日志，生成的新日志里面就分别写上了一、二、三、四行当天日期。

 

此刻我的内心几乎是崩溃的。我开始思考为什么会这样。很明显四行日期是调用了4次logger.fatal(‘datetime.datetime.now().strftime(‘%Y-%m-%d‘)) 这个函数。换句话说，我每一次for循环都在这个log里面写了一句话。可是明明每个for是处理一个日志，下一次for应该是处理下一个日志的，为什么会再处理这个日志一次？我突然想到，logger.addHandler(handler)是每次循环都会运行的，也就是说，logger是同一个logger，添加了4次handler。到第4次循环的时候，这个logger中有4个handler，也就会往4个不同的日志中添加内容了。呃。

 

如果是这样的话，那么把上面的程序改改，第一句和最后一句放在循环外，循环内只用中间的三句。这次OK了。回头再看log记录的步骤，也就明白了logger和handler到底是个什么鬼：logger可以看做是一个记录日志的人，对于记录的每个日志，他需要有一套规则，比如记录的格式（formatter），等级（level）等等，这个规则就是handler。使用logger.addHandler(handler)添加多个规则，就可以让一个logger记录多个日志。至于logging.getLogger()方法获得的root logger和继承关系，可以详见附注的网页，这里我也只是大概明白了什么意思，还没有具体用过。也许将来在框架中使用，要记录较为复杂的日志时候会用到吧。