python logging模块
概述:
python的logging模块提供了标准的日志接口,你可以通过它存储各种格式的日志,logging的日志可以分为 debug()
, info()
, warning()
, error()
and critical() 5个级别。
logging 日志信息的简单用法
默认的,日志级别要高于INFO级别才会有内容输出。
import logging logging.debug("user[root] this is a {debug} message..") logging.info("user[root] this is a {info} message..") logging.warning("The server is down. this is a {warning} message..") logging.error("the password is error,con't to login . this is a {error} message..") logging.critical("user[root] this is a critical message..") """ WARNING:root:The server is down. this is a {warning} message.. ERROR:root:the password is error,con't to login . this is a {error} message.. CRITICAL:root:user[root] this is a critical message.. """
logging 5个日志级别代表的意思:
将logging日志信息写到文件内
logging.basicConfig函数对日志的输出格式及方式做相关配置,level 设置日志输出的级别,farmat 设置日志保存的格式,datefmt 设置日志时间的格式,filename日志保存文件的名称,filemode文件输入的模式:“a”为追加。
import logging logging.basicConfig(level=logging.INFO, format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s', datefmt='%a, %d %b %Y %H:%M:%S', filename="myLOG.log", filemode="a") logging.debug('This message should go to the log file') logging.info('So should this,info log') logging.warning('This is warning message')
MyLOG.log文档中日志信息:
Thu, 17 Aug 2017 15:59:10 log_v1.py[line:55] INFO So should this,info log Thu, 17 Aug 2017 15:59:10 log_v1.py[line:56] WARNING This is warning message Thu, 17 Aug 2017 15:59:57 log_v1.py[line:55] INFO So should this,info log Thu, 17 Aug 2017 15:59:57 log_v1.py[line:56] WARNING This is warning message
logging日志格式:
%(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 |
用户输出的消息 |
将logging日志输出到屏幕和文件中
Python 使用logging模块记录日志涉及四个主要类:
logger提供了应用程序可以直接使用的接口;
handler将(logger创建的)日志记录发送到合适的目的输出;
filter提供了细度设备来决定输出哪条日志记录;
formatter决定日志记录的最终输出格式。
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 每天凌晨
# 例1:
import logging logging.basicConfig(level=logging.DEBUG, format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s', datefmt='%a, %d %b %Y %H:%M:%S', filename="myapp.log", filemode="a") #输出到文档 console = logging.StreamHandler() # 定义一个StreamHandler,将INFO级别或更高的日志信息打印到标准错误,并将其添加到当前的日志处理对象 console.setLevel(logging.INFO) formatter = logging.Formatter('%(asctime)s - %(name)-12s:%(levelname)-8s %(message)s') # 屏幕输出 console.setFormatter(formatter) logging.getLogger("").addHandler(console) logging.debug('This is debug message') logging.info('This is info message') logging.warning('This is warning message')
# 例2(另一种经典写法):
import logging logger = logging.getLogger("logger") logger.setLevel(logging.DEBUG) ch = logging.StreamHandler() ch.setLevel(logging.DEBUG) fh = logging.FileHandler("mylog.log") fh.setLevel(logging.DEBUG) formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') ch.setFormatter(formatter) fh.setFormatter(formatter) logger.addHandler(ch) logger.addHandler(fh) # 日志信息 logger.debug('this is debug message') logger.info('this is info message') logger.warn('this is warning message') logger.error('this is error message') logger.critical('this is critical message')
屏幕输出的日志信息:
2017-08-17 16:39:55,971 - logger - DEBUG - this is debug message 2017-08-17 16:39:55,971 - logger - INFO - this is info message 2017-08-17 16:39:55,971 - logger - WARNING - this is warning message 2017-08-17 16:39:55,971 - logger - ERROR - this is error message 2017-08-17 16:39:55,971 - logger - CRITICAL - this is critical message
mylog.log文件中的日志信息:
2017-08-17 16:41:49,346 - logger - DEBUG - this is debug message 2017-08-17 16:41:49,346 - logger - INFO - this is info message 2017-08-17 16:41:49,346 - logger - WARNING - this is warning message 2017-08-17 16:41:49,346 - logger - ERROR - this is error message 2017-08-17 16:41:49,346 - logger - CRITICAL - this is critical message
通过配置文件配置logger:
定义配置文件logger.conf
#logger.conf ############################################### [loggers] keys=root,example01,example02 [logger_root] level=DEBUG handlers=hand01,hand02 [logger_example01] handlers=hand01,hand02 qualname=example01 propagate=0 [logger_example02] handlers=hand01,hand03 qualname=example02 propagate=0 ############################################### [handlers] keys=hand01,hand02,hand03 [handler_hand01] class=StreamHandler level=INFO formatter=form02 args=(sys.stderr,) [handler_hand02] class=FileHandler level=DEBUG formatter=form01 args=('myapp.log', 'a') [handler_hand03] class=handlers.RotatingFileHandler level=INFO formatter=form02 args=('myapp.log', 'a', 10*1024*1024, 5) ############################################### [formatters] keys=form01,form02 [formatter_form01] format=%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s datefmt=%a, %d %b %Y %H:%M:%S [formatter_form02] format=%(name)-12s: %(levelname)-8s %(message)s datefmt=
获取logging.config配置的日志:
import logging import logging.config logging.config.fileConfig("logger.conf") logger = logging.getLogger("example01") logger.debug("this is debug message") logger.info('This is info message') logger.warning('This is warning message')
日志输出结果:
example01 : INFO This is info message example01 : WARNING This is warning message
参考链接1:http://www.cnblogs.com/tkqasn/p/6020282.html
参考链接2:http://www.cnblogs.com/alex3714/articles/5161349.html