day5-logging模块
概述
很多程序都有记录日志的需求，并且日志中包含的信息即有正常的程序访问日志，还可能有错误，警告等信息输出，python的logging模块提供了标准的日志接口，你可以通过它存储各种格式的日志，logging的日志可以分为debug，info，warning，error和critical 5个级别，下面我们看一下怎么用
日志级别
日志一共分成5个等级，从低到高分别是：DEBUG INFO WARNING ERROR CRITICAL。
DEBUG：详细的信息,通常只出现在诊断问题上
INFO：确认一切按预期运行
WARNING：一个迹象表明,一些意想不到的事情发生了,或表明一些问题在不久的将来(例如，磁盘空间低)。
ERROR：更严重的问题,软件没能执行一些功能
CRITICAL：一个严重的错误,这表明程序本身可能无法继续运行
这5个等级，也分别对应5种打日志的方法： debug 、info 、warning 、error 、critical。默认的是WARNING，当在WARNING或之上时才被跟踪。
日志输出
有两种方式记录跟踪：
- 输出到控制台
- 记录到文件中，如日志文件。
输出到控制台
import logging
logging.debug("test debug")
logging.info("test info")
logging.warning("user [dick] attempted wrong password more than 3 times")
logging.error("test error")
logging.critical("server is down")
#输出
WARNING:root:user [dick] attempted wrong password more than 3 times
ERROR:root:test error
CRITICAL:root:server is down
输出到文件
我们还可以将日志输出到文件，只需要在logging.basicConfig函数中设置好输出文件的文件名。
import logging
logging.basicConfig(filename='example.log',level=logging.INFO) #加入
logging.debug("test debug")
logging.info("testinfo")
logging.warning("user[dick] attempted wrong password more than 3 times")
logging.error("testerror")
logging.critical("server is down")
#输出到名为example.log的文件
INFO:root:testinfo
WARNING:root:user[dick] attempted wrong password more than 3 times
ERROR:root:testerror
CRITICAL:root:serverisdown
解析：其中level=logging.INFO意思是把日志级别设置为INFO，也就是说，只有比日志INFO或比INFO级别更高的日志才会被记录到文件里，所以，第一条日志是不会被记录的，如果想记录的话，将INFO改为DEBUG就好了。
加入日期输出到文件
import logging logging.basicConfig(filename='example.log',level=logging.DEBUG,format='%(asctime)s%(message)s',datefmt='%m/%d/%Y%I:%M:%S%p') #输出到名为example.log的文件 07/16/2017 11:24:43 PM test debug 07/16/2017 11:24:43 PM test info 07/16/2017 11:24:43 PM user [dick] attempted wrong password more than 3 times 07/16/2017 11:24:43 PM test error 07/16/2017 11:24:43 PM server is down
format日志格式
logging.basicConfig函数中，可以指定日志的输出格式format，这个参数可以输出很多有用的信息：
|
%(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 |
字符串形式的当前时间。默认格式是"2017-08-22 16：50：45，678"。逗号后面的是毫秒 |
|
%(thread)d |
线程ID，可能没有 |
|
%(threadName)s |
线程名，可能没有 |
|
%(process)d |
进程ID，可能没有 |
|
%(message)s |
用户输出信息 |
既要输出到控制台，也要输出到文件
这就要用到Logger 对象，下面将对他进行详细介绍，这里先学习怎么实现把日志既要输出到控制台又要输出到文件的功能。
import logging
# 第一步，创建一个logger
logger = logging.getLogger()
logger.setLevel(logging.INFO) # log等级总开关
# 第二步，创建一个handler，用于输出到控制台
ch = logging.StreamHandler()
ch.setLevel(logging.WARNING) # 输出到屏幕的log等级的开关
# 第三步，再创建一个handler，用于写入日志文件
fh = logging.FileHandler('/huwei/log/log.txt')
fh.setLevel(logging.DEBUG) # 输出到文件log等级的开关
# 第四步，定义handler的输出格式
formatter = logging.Formatter("%(asctime)s - %(filename)s[line:%(lineno)d] - %(levelname)s: %(message)s")
fh.setFormatter(formatter)
ch.setFormatter(formatter)
# 第五步，将logger添加到handler里面
logger.addHandler(fh)
logger.addHandler(ch)
# 日志调用
logger.debug('this is a logger debug message')
logger.info('this is a logger info message')
logger.warning('this is a logger warning message')
logger.error('this is a logger error message')
logger.critical('this is a logger critical message')
#输出到控制台
2017-08-13 23:49:33,318 - logger_test.py[line:26] - WARNING: this is a logger warning message
2017-08-13 23:49:33,318 - logger_test.py[line:27] - ERROR: this is a logger error message
2017-08-13 23:49:33,318 - logger_test.py[line:28] - CRITICAL: this is a logger critical message
#输出到文件log.txt
2017-08-13 23:49:33,318 - logger_test.py[line:25] - INFO: this is a logger info message
2017-08-13 23:49:33,318 - logger_test.py[line:26] - WARNING: this is a logger warning message
2017-08-13 23:49:33,318 - logger_test.py[line:27] - ERROR: this is a logger error message
2017-08-13 23:49:33,318 - logger_test.py[line:28] - CRITICAL: this is a logger critical message
logging模块详解
Python使用logging模块记录日志涉及四个主要类：
logger提供了应用程序可以直接使用的接口
handler将(logger创建的)日志记录发送到合适的目的输出
filter提供了细度设备来决定输出哪条日志记录
formatter决定日志记录的最终输出格式
logger
每个程序在输出信息之前都要获得一个logger。logger通常对应了程序的模块名，比如聊天工具的图形界面模块可以这样获得它的logger：
LOG=logging.getLogger("chat.gui")
而核心模块可以这样：
LOG=logging.getLogger("chat.kernel")
Logger.setLevel(lev):指定最低的日志级别，低于lev的级别将被忽略。debug是最低的内置级别，critical为最高
logger.setLevel(logging.DEBUG) #设置级别为debug级别
Logger.addFilter(filt)、Logger.removeFilter(filt):添加或删除指定的filter
Logger.addHandler(hdlr)、Logger.removeHandler(hdlr)：增加或删除指定的handler
logger.addHandler(ch) #添加handler logger.removeHandler(ch) #删除handler
Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical()：可以设置的日志级别
logger.debug('debug message')
logger.info('info message')
logger.warn('warn message')
logger.error('error message')
logger.critical('critical message')
handler
handler对象负责发送相关的信息到指定目的地。Python的日志系统有多种Handler可以使用。有些Handler可以把信息输出到控制台，有些Logger可以把信息输出到文件，还有些 Handler可以把信息发送到网络上。如果觉得不够用，还可以编写自己的Handler。可以通过addHandler()方法添加多个handler,获取自己想要的输出。
Handler.setLevel(lel):指定被处理的信息级别，低于lel级别的信息将被忽略
ch = logging.StreamHandler() ch.setLevel(logging.DEBUG)
Handler.setFormatter()：给这个handler选择一个格式
ch_formatter = logging.Formatter("%(asctime)s - %(filename)s[line:%(lineno)d] - %(levelname)s: %(message)s") #生成格式
fh.setFormatter(ch_formatter) #设置格式
Handler.addFilter(filt)、Handler.removeFilter(filt)：新增或删除一个filter对象
每个Logger可以附加多个Handler。接下来我们就来介绍一些常用的Handler：
1) logging.StreamHandler
使用这个Handler可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息。它的构造函数是：
StreamHandler([strm])
其中strm参数是一个文件对象。默认是sys.stderr
# 第二步，创建一个handler，用于输出到控制台 ch = logging.StreamHandler() ch.setLevel(logging.WARNING) # 输出到屏幕的log等级的开关
2) logging.FileHandler
和StreamHandler类似，用于向一个文件输出日志信息。不过FileHandler会帮你打开这个文件。它的构造函数是：
FileHandler(filename[,mode])
filename是文件名，必须指定一个文件名。
mode是文件的打开方式。参见Python内置函数open()的用法。默认是’a'，即添加到文件末尾。
# 第三步，再创建一个handler，用于写入日志文件
fh = logging.FileHandler('/huwei/log/log.txt')
fh.setLevel(logging.DEBUG) # 输出到文件log等级的开关
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并不会被更名，而是被删除。
import logging
from logging import handlers #导入handlers
logger=logging.getLogger(__name__)
log_file="timelog.log"
#按文件大小来分割，10字节，保留个数为3
fh=handlers.RotatingFileHandler(filename=log_file,maxBytes=10,backupCount=3,encoding="utf-8")
formatter=logging.Formatter('%(asctime)s%(module)s:%(lineno)d%(message)s')
fh.setFormatter(formatter)
logger.addHandler(fh)
logger.warning("test11")
logger.warning("test12")
logger.warning("test13")
logger.warning("test14")
logger.warning("test15")
logger.warning("test16")
#生成输出到文件
文件timelog.log:
2017-07-17 00:41:48,462 文件日志自动截断:24 test16
文件timelog.log.1:
2017-07-17 00:41:48,461 文件日志自动截断:23 test15
文件timelog.log.2:
2017-07-17 00:41:48,460 文件日志自动截断:22 test14
文件timelog.log.3:
2017-07-17 00:41:48,459 文件日志自动截断:21 test13
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 每天凌晨
import logging,time
from logging import handlers
logger=logging.getLogger(__name__)
log_file="timelog.log"
#按时间来分割文件，5秒分割一次，保留3个
fh=handlers.TimedRotatingFileHandler(filename=log_file,when="S",interval=5,backupCount=3)
formatter=logging.Formatter('%(asctime)s%(module)s:%(lineno)d%(message)s')
fh.setFormatter(formatter)
logger.addHandler(fh)
logger.warning("test11") #19
time.sleep(2)
logger.warning("test12") #21
time.sleep(2)
logger.warning("test13") #23
logger.warning("test14") #24
time.sleep(2)
logger.warning("test15") #26
logger.warning("test16") #27
#生成输出到文件
文件timelog.log:
2017-07-17 00:50:47,331 文件日志自动截断:26 test15
2017-07-17 00:50:47,332 文件日志自动截断:27 test16
文件timelog.log.2017-07-17_00-50-41:
2017-07-17 00:50:41,319 文件日志自动截断:19 test11
2017-07-17 00:50:43,323 文件日志自动截断:21 test12
2017-07-17 00:50:45,327 文件日志自动截断:23 test13
2017-07-17 00:50:45,327 文件日志自动截断:24 test14
浙公网安备 33010602011771号