20180223-logging模块

Python的logging模块提供了标准的日志接口，可以通过它存储各种格式的日志，logging的日志可以依次分为debug()、info()、warning()、error()、cirtical() 5个级别,而且线程安全

最简单用法

import logging

logging.warning('user [XM] attempted wrong password more than 3 times')
logging.critical('server is down')

输出

WARNING:root:user [XM] attempted wrong password more than 3 times
CRITICAL:root:server is down

把日志写到文件中

logging.basicConfig(
                    filename='example.log',
                    level=logging.INFO,
                    format='%(asctime)s %(message)s',
                    datefmt='%m/%d/%Y %I:%M:%S %p'
                    )
logging.debug('This message should go to the file')
logging.info('So should this')
logging.warning('And this too')

其中level=logging.INFO代表的含义是日志级别为INFO,也就是只有日志级别为INFO或者更高的才会被写入文件中。本示例中第一条记录不会被写入文件。

日志文件内容如下：

02/23/2018 03:29:20 PM Log Level is INFO
02/23/2018 03:29:20 PM Log Level is WARNING

自定义日志格式

logging.basicConfig(format='%(asctime)s %(message)s',
                    datefmt='%Y/%m/%d %I:%M:%S %p',
                    )
logging.warning('Log Level is WARNING')
logging.error('Log Level is ERROR')

输出

2018/02/23 03:35:40 PM Log Level is WARNING
2018/02/23 03:35:40 PM Log Level is ERROR

自定义其他格式如下：

%(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日志打印在屏幕和文件中，需要进一步的了解logging

Python使用logging模块记录日志涉及四个主要类

• logger提供了应用程序可以直接使用的接口
• handler将logger创建的日志发送到合适的目的输出
• filter提供了细度设备决定输出哪条日志
• formatter决定了日志输出的最终格

下面讲解一下每个组件的主要功能：

　　logger

每个程序在输出信息之前都要获取一个Logger,Logger通常对应了程序的模块名，比如聊天工具的图形界面模块可以这样获得他的Logger

LOG = logging.getLogger('chat.gui')

而可新模块可以这样

LOG = logging.getLogger('chat.kernel')

还可以绑定handler和filters

LOG.setLevel(level)　　#指定日志级别，低于level级别的将被忽略。
LOG.addFilter(filter)      LOG.removeFilter(filter)   #添加和删除指定的filter
LOG.addHandler(hdlr)   LOG.removeHandler(hdlr) #添加和移除指定的handler

handler

handler对象负责发送相关的信息到目的输出，Python的日志系统有多种Handler可以使用。有些Handler可以把信息输出到控制台，有些Handler可以把信息输出到文件中，还有些信息可以把信息发送到网络上，如果觉得不够用，可以自己编写Handler

Handler.setLevel(level)　　      #指定日志级别，低于level级别的将被忽略。
Handler.setFormatter(filter)     #给这个handler指定一个输出格式
Handler.addFilter(filter)   Handler.removeFilter(filter) #添加和移除指定的filter

　　接下来我们介绍一下常用的Handler:

1. logging.StreamHandler 使用这个Handler可以向类似sys.stdout或者sys.stderr的任何文件对象输出信息
2. logging.FileHandler和StreamHandler类似，用于向一个文件输出日志信息，不过FileHandler会帮你打开这个文件
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

1. 这个Handler和RotatingFileHandler类似，不过，它没有通过判断文件大小来决定何时重新创建日志文件，而是间隔一定时间就 自动创建新的日志文件。重命名的过程与RotatingFileHandler类似，不过新的文件不是附加数字，而是当前时间。它的函数是：

2. TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])

   其中filename参数和backupCount参数和RotatingFileHandler具有相同的意义。

   interval是时间间隔。

   when参数是一个字符串。表示时间间隔的单位，不区分大小写。它有以下取值：

   1. S 秒
   2. M 分
   3. H 小时
   4. D 天
   5. W 每星期（interval==0时代表星期一）
   6. midnight 每天凌晨

　　formatter组件

　　日志的formatter组件是一个独立的组件，可以和handler组合使用

fh = logging.FileHandler('web.log')
file_formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
fh.setFormatter(file_formatter)

　　filter组件

　　如果你想对日志内容进行过滤，就可以自定义一个filter

class IgnoreBackupLogFilter(logging.Filter):
    '''
    忽略带'db backup'的日志
    注意filter函数需要返回True或者False,来觉得是否输出日志
    '''
    def filter(self, record):
        return 'db backup' not in record.getMessage()

　　然后把filter添加到logger中

logger.addFilter(IgnoreBackupLogFilter())

　　下面的日志就会把符合filter条件的过滤点

logger.debug("test ....")
logger.info("test info ....")
logger.warning("start to run db backup job ....")
logger.error("test error ....")

实战练习

1.编写一个既能在控制台输出，又能在文件输出，同时支持filter的日志操作

'''
一个同时输出在屏幕和文件，并带有filter的例子
'''

import logging

class IgnoreBackupLogFilter(logging.Filter):
    '''
    忽略带'db backup'的日志
    注意filter函数需要返回True或者False,来觉得是否输出日志
    '''
    def filter(self, record):
        return 'db backup' not in record.getMessage()

logger = logging.getLogger('logging.filter')
logger.setLevel(logging.INFO)  #默认级别是WARNING

# 创建handler并绑定
formatter = logging.Formatter('%(asctime)s %(levelname)s %(message)s')

ch = logging.StreamHandler()
ch.setFormatter(formatter)

fh = logging.FileHandler('filter.log')
fh.setFormatter(formatter)

logger.addHandler(ch)
logger.addHandler(fh)

# 创建并绑定filter
logger.addFilter(IgnoreBackupLogFilter())

logger.debug("test ....")
logger.info("test info ....")
logger.warning("start to run db backup job ....")
logger.error("test error ....")

# 输出
# 2018-03-14 16:19:32,111 INFO test info ....
# 2018-03-14 16:19:32,111 ERROR test error ....

2.文件自动截断的例子

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")