logging模块

不少程序都有记录日志的需求，而且日志中包含的信息即有正常的程序访问日志，还可能有错误、警告等信息输出，python的logging模块提供了标准的日志接口，你能够经过它存储各类格式的日志，logging的日志能够分为 debug(), info(), warning(), error() and critical() 5个级别

看一下这几个日志级别分别表明什么意思

Level	When it’s used
DEBUG	Detailed information, typically of interest only when diagnosing problems.
INFO	Confirmation that things are working as expected.
WARNING	An indication that something unexpected happened, or indicative of some problem in the near future (e.g. ‘disk space low’). The software is still working as expected.
ERROR	Due to a more serious problem, the software has not been able to perform some function.
CRITICAL	A serious error, indicating that the program itself may be unable to continue running.

下面咱们看一下怎么用。

最简单用法：

import logging

 

logging.debug("debug test")

logging.info("info test")

logging.warning("warning test")

logging.error("error test")

logging.critical("critical test")

输出：

WARNING:root:warning test
ERROR:root:error test
CRITICAL:root:critical test

这里为何不输出debug和info呢？由于这里默认的日志级别是warning如下的日志级别均不打印，那咱们要怎么才能打印debug和info信息呢？咱们需设置日志级别为debug，这样就能想打印哪一个级别的日志就打印哪一个级别的日志了

如

import logging

 

logging.basicConfig(level=logging.INFO) #设置日志级别，这里注意INFO必须为大写，若是设置为DEBUG，则能打印出全部日志

 

logging.debug("debug test")

logging.info("info test")

logging.warning("warning test")

logging.error("error test")

 

输出：

INFO:root:info test
WARNING:root:warning test
ERROR:root:error test

这里注意一点logging.debug("debug test")不像print函数，能够打印多条语句，中间用逗号隔开，logging不行，logging输出时只能一条一条的输出，不能用逗号隔开

如：

logging.debug("abc","cba")或则logging.debug([1,2,3],[1,3,4])等均会报错

 

 

若是想把日志写到文件里，也很简单：

import logging

 

logging.basicConfig(filename='example.log',level=logging.INFO)   #filename为文件

 

logging.debug("debug test")

logging.info("info test")

logging.warning("warning test")

logging.error("error test")

 

输出到example.log文件中：

INFO:root:info test

WARNING:root:warning test

ERROR:root:error test

 

感受上面的日志忘记加上时间了，下面就来加上：

import logging

logging.basicConfig(
    filename='example.log',
    level=logging.DEBUG,
    format='%(asctime)s %(message)s',
    datefmt='%y/%m/%d %I:%M:%S %p'
)

logging.debug("debug test")
logging.info("info test")
logging.warning("warning test")
输出：

17/05/26 03:07:22 PM debug test
17/05/26 03:07:22 PM info test
17/05/26 03:07:22 PM warning test

是否是感受输出仍然不是很完善，缺乏行，日志级别等，下面咱们来继续完善

import logging
logging.basicConfig(
    filename='example.log',
    level=logging.DEBUG,
    format='%(asctime)s %(filename)s:%(lineno)d - %(levelname)s:%(message)s', #输出时间，文件名，行，日志级别，信息
    datefmt='%y/%m/%d %I:%M:%S %p'
)

logging.debug("debug test")
logging.info("info test")
logging.warning("warning test")
输出：

17/05/26 03:22:40 PM logging_mod.py:11 - DEBUG:debug test
17/05/26 03:22:40 PM logging_mod.py:12 - INFO:info test
17/05/26 03:22:40 PM logging_mod.py:13 - WARNING:warning test

是否是不清楚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	字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。逗号后面的是毫秒
%(thread)d	线程ID。可能没有
%(threadName)s	线程名。可能没有
%(process)d	进程ID。可能没有
%(message)s	用户输出的消息

 

若是想同时把log打印在屏幕和文件日志里，就须要了解一点复杂的知识 了

Python 使用logging模块记录日志涉及四个主要类，使用官方文档中的归纳最为合适：

logger提供了应用程序能够直接使用的接口；

handler将(logger建立的)日志记录发送到合适的目的输出；

filter提供了细度设备来决定输出哪条日志记录；

formatter决定日志记录的最终输出格式。

 

logger
每一个程序在输出信息以前都要得到一个Logger。Logger一般对应了程序的模块名，好比聊天工具的图形界面模块能够这样得到它的Logger：
LOG=logging.getLogger(”chat.gui”)
而核心模块能够这样：
LOG=logging.getLogger(”chat.kernel”)

Logger.setLevel(lel):指定最低的日志级别，低于lel的级别将被忽略。debug是最低的内置级别，critical为最高
Logger.addFilter(filt)、Logger.removeFilter(filt):添加或删除指定的filter
Logger.addHandler(hdlr)、Logger.removeHandler(hdlr)：增长或删除指定的handler
Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical()：能够设置的日志级别

 

handler

handler对象负责发送相关的信息到指定目的地。Python的日志系统有多种Handler可使用。有些Handler能够把信息输出到控制台，有些Logger能够把信息输出到文件，还有些 Handler能够把信息发送到网络上。若是以为不够用，还能够编写本身的Handler。能够经过addHandler()方法添加多个多handler
Handler.setLevel(lel):指定被处理的信息级别，低于lel级别的信息将被忽略
Handler.setFormatter()：给这个handler选择一个格式
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

2) logging.FileHandler
和StreamHandler相似，用于向一个文件输出日志信息。不过FileHandler会帮你打开这个文件。它的构造函数是：
FileHandler(filename[,mode])
filename是文件名，必须指定一个文件名。
mode是文件的打开方式。参见Python内置函数open()的用法。默认是’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 天天凌晨

 

同时输出到屏幕和文件例子：

   import logging

#create logger
logger = logging.getLogger("test-log")
logger.setLevel(logging.DEBUG)

#create console handler and set level to info
ch = logging.StreamHandler()
ch.setLevel(logging.INFO)

#create file handler and set level to error

fh = logging.FileHandler('access.log',encoding='utf-8')
fh.setLevel(logging.ERROR)

#create formatter
formatter = logging.Formatter(
    '%(asctime)s %(filename)s:%(lineno)d - %(levelname)s:%(message)s',
    datefmt='%y/%m/%d %I:%M:%S %p'
)

#add formatter to ch and fh
ch.setFormatter(formatter)
fh.setFormatter(formatter)
#add ch and fh to logger
logger.addHandler(ch)
logger.addHandler(fh)

# 'application' code
logger.debug('debug message')
logger.info('info message')
logger.warn('warn message')
logger.error('error message')
logger.critical('critical message')
结果：
文件输出：

17/05/26 04:36:26 PM logging_mod.py:45 - ERROR:error message
17/05/26 04:36:26 PM logging_mod.py:46 - CRITICAL:critical message
屏幕输出：

   17/05/26 04:36:26 PM logging_mod.py:43 - INFO:info message
   17/05/26 04:36:26 PM logging_mod.py:44 - WARNING:warn message
   17/05/26 04:36:26 PM logging_mod.py:45 - ERROR:error message
   17/05/26 04:36:26 PM logging_mod.py:46 - CRITICAL:critical message

总结：

1. 首先先建立一个logger，而后设置日志级别（若是这里没设置，默认是warning级别）
2. 建立handler，将(logger建立的)日志记录发送到合适的目的输出（我这里设置的为屏幕输出和文件输出），而后设置日志级别，如不设置，默认为logger的日志级别
3. 建立formatter，格式详见以前的日志格式
4. 把日志格式添加到handler
5. 把handler添加到logger

 

根据大小切割：

 

import logging
from logging import handlers

logger = logging.getLogger(__name__)
fh = handlers.RotatingFileHandler(filename='text.log',maxBytes=260,encoding='utf-8',backupCount=2)

formatter = logging.Formatter(
     '%(asctime)s %(filename)s:%(lineno)d - %(levelname)s:%(message)s',
     datefmt='%y/%m/%d %I:%M:%S %p'
)

fh.setFormatter(formatter)
logger.addHandler(fh)

logger.warning("test1")
logger.warning("test2")
logger.warning("test3")
logger.warning("test4")
logger.warning("test5")
结果为

text.log.1:

17/05/26 06:39:27 PM logging_mod.py:62 - WARNING:test1
17/05/26 06:39:27 PM logging_mod.py:63 - WARNING:test2
17/05/26 06:39:27 PM logging_mod.py:64 - WARNING:test3
17/05/26 06:39:27 PM logging_mod.py:65 - WARNING:test4
text.log:

17/05/26 06:39:27 PM logging_mod.py:66 - WARNING:test5

输出：当.log达到指定的大小以后，RotatingFileHandler自动把 文件更名为.log.1。不过，若是.log.1已经存在，会先把.log.1重命名为t.log.2。。。以此类推（若是设置了备份文件个数n，则最多只能生成log文件n+1，如此列设置了备份文件为2，那最多只能生成3个log文件，分别是.log,.log.1,.log.2,当超过log文件个数，原有的.log.2并不会被改名，而是被删除），最后从新建立 chat.log，继续输出日志信息


根据时间截断：

import logging
from logging import handlers
import time

logger = logging.getLogger(__name__)

fh = handlers.TimedRotatingFileHandler(filename='text.log',when='S',interval=2,encoding='utf-8',backupCount=2)

formatter = logging.Formatter(
     '%(asctime)s %(filename)s:%(lineno)d - %(levelname)s:%(message)s',
     datefmt='%y/%m/%d %I:%M:%S %p'
)

fh.setFormatter(formatter)
logger.addHandler(fh)

logger.warning("test1")
time.sleep(2)
logger.warning("test2")
time.sleep(2)
logger.warning("test3")
time.sleep(2)
logger.warning("test4")
logger.warning("test5")
输出：

text.log:

17/05/26 07:18:35 PM logging_mod.py:70 - WARNING:test4
17/05/26 07:18:35 PM logging_mod.py:71 - WARNING:test5
text.log.2017..33:

17/05/26 07:18:33 PM logging_mod.py:68 - WARNING:test3

text.log.2017..31:

17/05/26 07:18:31 PM logging_mod.py:66 - WARNING:test2