Python常用模块-logging日志

Python常用模块-logging日志

http://www.cnblogs.com/alex3714/articles/5161349.html

 

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

简单样例

import logging
logging.warning('input passwd 3 times')
logging.critical('server is down!')

>>> import logging

>>> logging.warning('input passwd 3 times')

WARNING:root:input passwd 3 times

>>> logging.critical('server is down!')

CRITICAL:root:server is down!

>>> 

DEBUG

最详细的日志信息,典型应用场景是 问题诊断

INFO

信息详细程度仅次于DEBUG,通常只记录关键节点信息,用于确认一切都是按照我们预期的那样进行工作

WARNING

当某些不期望的事情发生时记录的信息(如,磁盘可用空间较低),但是此时应用程序还是正常运行的

ERROR

由于一个更严重的问题导致某些功能不能正常运行时记录的信息

CRITICAL

当发生严重错误,导致应用程序不能继续运行时记录的信息

 

 

默认生成的root logger的level是logging.WARNING,低于该级别的就不输出了

级别排序:CRITICAL > ERROR > WARNING > INFO > DEBUG

import logging  
logging.debug('debug message')  
logging.info('info message')  
logging.warning('warning message')  
logging.error('error message')  
logging.critical('critical message')  

>>> import logging 

>>> logging.debug('debug message') 

>>> logging.info('info message') 

>>> logging.warning('warning message') 

WARNING:root:warning message

>>> logging.error('error message') 

ERROR:root:error message

>>> logging.critical('critical message') 

CRITICAL:root:critical message

>>>

日志格式内容

import logging
logging.basicConfig(format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
logging.warning('--test--')

/Library/Frameworks/Python.framework/Versions/3.6/bin/python3.6 /Users/admin/PycharmProjects/s18/day5/模块/logging/logging_test.py

2018-07-12 11:36:34,983 - root - WARNING - --test--

 

进程已结束,退出代码0

%(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

用户输出的消息

 

 

配置日志,输出到文件

import logging
logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
                    datefmt='%Y-%m-%d,%H:%M:%S',
                     filename='log_test.log2',
)
logging.debug('-----debug message')
logging.info('-----info message')
logging.warning('-----warning message')
logging.error('-----error message')
logging.critical('-----critical message')
2018-07-12,11:30:48 logging_test.py[line:8] DEBUG -----debug message
2018-07-12,11:30:48 logging_test.py[line:9] INFO -----info message
2018-07-12,11:30:48 logging_test.py[line:10] WARNING -----warning message
2018-07-12,11:30:48 logging_test.py[line:11] ERROR -----error message
2018-07-12,11:30:48 logging_test.py[line:12] CRITICAL -----critical message

 

 

filename:   用指定的文件名创建FiledHandler(后边会具体讲解handler的概念),这样日志会被存

                                储在指定的文件中。

filemode:   文件打开方式,在指定了filename时使用这个参数,默认值为“a”还可指定为“w”。

format:      指定handler使用的日志显示格式。

datefmt:    指定日期时间格式。

level:       设置rootlogger(后边会讲解具体概念)的日志级别

stream:     用指定的stream创建StreamHandler。可以指定输出到sys.stderr,sys.stdout或者文件,    

 默认为sys.stderr,若同时列出了filename和stream,则stream参数会被忽略

 

logging模块日志流处理流程

https://blog.csdn.net/sollor525/article/details/79152526

https://www.cnblogs.com/darkpig/p/5924820.html

 

logging日志模块四大组件

logger提供了应用程序可以直接使用的接口;

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

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

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

 

  • 这些组件之间的关系描述:
  • 日志器(logger)需要通过处理器(handler)将日志信息输出到目标位置,如:文件、sys.stdout、网络等;
  • 不同的处理器(handler)可以将日志输出到不同的位置;
  • 日志器(logger)可以设置多个处理器(handler)将同一条日志记录输出到不同的位置;
  • 每个处理器(handler)都可以设置自己的过滤器(filter)实现日志过滤,从而只保留感兴趣的日志;
  • 每个处理器(handler)都可以设置自己的格式器(formatter)实现同一条日志以不同的格式输出到不同的地方。

简单点说就是:日志器(logger)是入口,真正干活儿的是处理器(handler),处理器(handler)还可以通过过滤器(filter)和格式器(formatter)对要输出的日志内容做过滤和格式化等处理操作。

 

1.  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():可以设置的日志级别

 

2.        Handle类

handler对象负责发送相关的信息到指定目的地。Python的日志系统有多种Handler可以使用。有些Handler可以把信息输出到控制台,有些Logger可以把信息输出到文件,还有些 Handler可以把信息发送到网络上。如果觉得不够用,还可以编写自己的Handler。可以通过addHandler()方法添加多个多handler
Handler.setLevel(lel):指定被处理的信息级别,低于lel级别的信息将被忽略
Handler.setFormatter():给这个handler选择一个格式
Handler.addFilter(filt)、Handler.removeFilter(filt):新增或删除一个filter对象

 

2.1.                logging.StreamHandler

使用这个Handler可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息。它的构造函数是:
StreamHandler([strm])
其中strm参数是一个文件对象。默认是sys.stderr

2.2.                logging.FileHandler

和StreamHandler类似,用于向一个文件输出日志信息。不过FileHandler会帮你打开这个文件。它的构造函数是:
FileHandler(filename[,mode])
filename是文件名,必须指定一个文件名。
mode是文件的打开方式。参见Python内置函数open()的用法。默认是’a',即添加到文件末尾。

2.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并不会被更名,而是被删除。

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 每天凌晨

 

3.        Formater类

Formater对象用于配置日志信息的最终顺序、结构和内容。与logging.Handler基类不同的是,应用代码可以直接实例化Formatter类。另外,如果你的应用程序需要一些特殊的处理行为,也可以实现一个Formatter的子类来完成。

Formatter类的构造方法定义如下:

 

logging.Formatter.__init__(fmt=None, datefmt=None, style='%')

 

4.        Filter类

Filter可以被Handler和Logger用来做比level更细粒度的、更复杂的过滤功能。Filter是一个过滤器基类,它只允许某个logger层级下的日志事件通过过滤。该类定义如下:

·  class logging.Filter(name='')
·      filter(record)

 

比如,一个filter实例化时传递的name参数值为'A.B',那么该filter实例将只允许名称为类似如下规则的loggers产生的日志记录通过过滤:'A.B','A.B,C','A.B.C.D','A.B.D',而名称为'A.BB', 'B.A.B'的loggers产生的日志则会被过滤掉。如果name的值为空字符串,则允许所有的日志事件通过过滤。

 

5.        终端/文件日志例子

import logging
logger = logging.getLogger('TEST-LOG')  # 获取logger实例,如果参数为空则返回root logger
logger.setLevel(logging.DEBUG)

#输出到终端屏幕
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)

#输出到文件
fl = logging.FileHandler('access.log')
fl.setLevel(logging.ERROR)

#设置日志格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

#把日志格式赋给终端和文件
ch.setFormatter(formatter)
fl.setFormatter(formatter)

#把设置好的终端和文件  赋给全局日志
logger.addHandler(ch)
logger.addHandler(fl)

# 输出日志内容
logger.debug('--debug message--')
logger.info('--info message--')
logger.warning('--worning massage--')
logger.error('--error massage--')
logger.critical('--critical massage--')
##终端显示

/Library/Frameworks/Python.framework/Versions/3.6/bin/python3.6 /Users/admin/PycharmProjects/s18/day5/模块/logging/logging_test.py

2018-07-12 14:25:59,819 - TEST-LOG - DEBUG - --debug message--

2018-07-12 14:25:59,819 - TEST-LOG - INFO - --info message--

2018-07-12 14:25:59,819 - TEST-LOG - WARNING - --worning massage--

2018-07-12 14:25:59,819 - TEST-LOG - ERROR - --error massage--

2018-07-12 14:25:59,820 - TEST-LOG - CRITICAL - --critical massage--

 

进程已结束,退出代码0

 

##日志文件
2018-07-12 14:25:59,819 - TEST-LOG - ERROR - --error massage--
2018-07-12 14:25:59,820 - TEST-LOG - CRITICAL - --critical massage--

6.        文件自动截断例子

import logging
from logging import handlers

logger = logging.getLogger(__name__)
log_file = "timelog.log"
#fh = handlers.RotatingFileHandler(filename=log_file,maxBytes=10,backupCount=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("test1")
logger.warning("test12")
logger.warning("test13")
logger.warning("test14")

 

posted on 2018-07-16 13:55  光阴8023  阅读(250)  评论(0编辑  收藏  举报