23-[模块]-logging

1.日志级别

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

默认级别是WARNING，表示只有WARING和比WARNING更严重的事件才会被记录到日志内，低级别的信息会被忽略。

因此，默认情况下，DEBUG和INFO会被忽略，WARING、ERROR和CRITICAL会被记录。

有多种方法用来处理被跟踪的事件。最简单的方法就是把它们打印到终端控制台上。或者将它们写入一个磁盘文件内。

2、用法

3、简单用法

import logging

logging.warning('Watch out!')  # 消息会被打印到控制台上

logging.info('I told you so')  # 这行不会被打印，因为级别低于默认级别warning

4、记录到文件

要把日志输出到文件内，就不能使用上面的方法了，但是logging模块同样给我们提供了一个相对便捷的手段，那就是logging.basicConfig()方法。

import logging

logging.basicConfig(filename='log_test.log', level=logging.INFO)   #info级别以上的写入文件

logging.debug('so should this')

logging.info('I told you so')

logging.warning('Watch out!')

5.自定义日志格式

import logging

logging.basicConfig(filename='log_test.log',

                    level=logging.WARNING,

                    format='%(asctime)s %(message)s',

                    datefmt='%Y-%m-%d %I:%M:%S %p'

                    )

logging.debug('so should this')

logging.info('I told you so')

logging.warning('Watch out!')

logging.error('this error is no')

logging.critical('critical xxxx')

属性        　　    格式   　　　　　　　　       描述

asctime   　　     %(asctime)s   　　　　 　　  日志产生的时间，默认格式为2003-- ::,

created    　　    %(created)f   　　　　　　   time.time()生成的日志创建时间戳

filename   　　    %(filename)s   　　　　     生成日志的程序名

funcName  　　     %(funcName)s    　　　　　  　调用日志的函数名

levelname  　　    %(levelname)s    　　　　　　日志级别 ('DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL')

levelno   　　     %(levelno)s    　　　　　　  日志级别对应的数值

lineno    　　     %(lineno)d    　　　　　　　　日志所针对的代码行号（如果可用的话）

module   　　      %(module)s   　　　　　　　　 生成日志的模块名

msecs    　　      %(msecs)d    　　　　　　　　　　日志生成时间的毫秒部分

message  　　      %(message)s    　　　　　　　　具体的日志信息

name   　　         %(name)s    　　　　　　　　日志调用者

pathname   　　     %(pathname)s    　　　　　　生成日志的文件的完整路径

process   　　      %(process)d    　　　　　　生成日志的进程ID（如果可用）

processName  　　  %(processName)s  　　　　  进程名（如果可用）

thread    　　　　　 %(thread)d    　　　　　　 生成日志的线程ID（如果可用）

threadName   　　  %(threadName)s    　　　　 线程名（如果可用）

# 函数

import logging

logging.basicConfig(filename='log_test.log',

                    level=logging.WARNING,

                    format='%(asctime)s:%(levelname)s:%(filename)s:%(module)s %(message)s',

                    datefmt='%Y-%m-%d %I:%M:%S %p'

                    )

def sayhi():

    logging.error('from sayhi...')

sayhi()

logging.debug('so should this')

logging.info('I told you so')

logging.warning('Watch out!')

logging.error('this error is no')

logging.critical('critical xxxx')

import logging

logging.basicConfig(filename='log_test.log',

                    level=logging.WARNING,

                    format='%(asctime)s:%(levelname)s:%(filename)s:%(module)s:%(lineno)d %(message)s',

                    datefmt='%Y-%m-%d %I:%M:%S %p'

                    )

def sayhi():

    logging.error('from sayhi...')

sayhi()

logging.debug('so should this')

logging.info('I told you so')

logging.warning('Watch out!')

logging.error('this error is no')

logging.critical('critical xxxx')

6、日志同时输出到屏幕和文件

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

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

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

他们之间的关系是这样的

每个组件的主要功能

（1）logger

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

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

而核心模块可以这样：

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

还可以绑定handler和filters

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）handler

handler对象负责发送相关的信息到指定目的地。Python的日志系统有多种Handler可以使用。有些Handler可以把信息输出到控制台，有些Handler可以把信息输出到文件，还有些 Handler可以把信息发送到网络上。如果觉得不够用，还可以编写自己的Handler。可以通过addHandler()方法添加多个多handler

Handler.setLevel(lel):指定被处理的信息级别，低于lel级别的信息将被忽略

Handler.setFormatter()：给这个handler选择一个格式

Handler.addFilter(filt)、Handler.removeFilter(filt)：新增或删除一个filter对象

每个Logger可以附加多个Handler。接下来我们就来介绍一些常用的Handler：

logging.StreamHandler 使用这个Handler可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息。
logging.FileHandler 和StreamHandler 类似，用于向一个文件输出日志信息。不过FileHandler会帮你打开这个文件
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并不会被更名，而是被删除。
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）formatter 组件

　　日志的formatter是个独立的组件，可以跟handler组合

fh = logging.FileHandler("access.log")

formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

fh.setFormatter(formatter) #把formmater绑定到fh上

　　（4）filter 组件

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

class IgnoreBackupLogFilter(logging.Filter):

    """忽略带db backup 的日志"""

    def filter(self, record): #固定写法

        return   "db backup" not in record.getMessage()

注意filter函数会返加True or False，logger根据此值决定是否输出此日志

然后把这个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 ....")

7.实例1：

一个同时输出到屏幕、文件的完成例子

import logging

# 1.生成logging对象

logger = logging.getLogger('web')

# 2。生成hander对象

ch = logging.StreamHandler()   # 终端打印

fh = logging.FileHandler('web.log')  # 文件保存

# 2.1把hander对象绑定到logger

logger.addHandler(ch)

logger.addHandler(fh)

# 3.生成formatter 对象

file_formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

console_formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

# 3.1把formatter对象绑定到hander对象

ch.setFormatter(console_formatter)

fh.setFormatter(file_formatter)

logger.debug("test ....")

logger.info("test info ....")

logger.warning("start to run db backup job ....")

logger.error("test error ....")

（2）设置日志等级

　　（3）设置终端，文件日志等级

（4）总结

日志先经过全局的level限制，
然后，各自通过终端或文件的等级限制在输出

8.实例2：filter

一个同时输出到屏幕、文件、带filter的完成例子

import logging

# filter 过滤

class IgnoreBackupLogFilter(logging.Filter):

    """忽略带db backup 的日志"""

    def filter(self, record): #固定写法

        return "db backup" not in record.getMessage()

# 1.生成logging对象

logger = logging.getLogger('web')

logger.setLevel(logging.INFO)  # 设置日志等级

# 1.1 把filter对象添加到logger中

logger.addFilter(IgnoreBackupLogFilter())

# 2。生成hander对象

ch = logging.StreamHandler()   # 终端打印

ch.setLevel(logging.DEBUG)     # 终端打印 日志等级

fh = logging.FileHandler('web.log')  # 文件保存

fh.setLevel(logging.WARNING)   # 文件保存 日志等级

# 2.1把hander对象绑定到logger

logger.addHandler(ch)

logger.addHandler(fh)

# 3.生成formatter 对象

file_formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

console_formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

# 3.1把formatter对象绑定到hander对象

ch.setFormatter(console_formatter)

fh.setFormatter(file_formatter)

logger.debug("test ....")

logger.info("test info ....")

logger.warning("start to run db backup job ....")

logger.warning("start to run db backup job 1....")

logger.warning("start to run db backup job 2....")

logger.error("test error ....")

9、实例三：文件自动截断

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

import logging

from logging import handlers

# filter 过滤

class IgnoreBackupLogFilter(logging.Filter):

    """忽略带db backup 的日志"""

    def filter(self, record): #固定写法

        return "db backup" not in record.getMessage()

# 1.生成logging对象

logger = logging.getLogger('web')

logger.setLevel(logging.INFO)  # 设置日志等级

# 1.1 把filter对象添加到logger中

logger.addFilter(IgnoreBackupLogFilter())

# 2。生成hander对象

ch = logging.StreamHandler()   # 终端打印

ch.setLevel(logging.DEBUG)     # 终端打印 日志等级

#fh = logging.FileHandler('web.log')  # 文件保存

#fh = handlers.RotatingFileHandler('web.log',maxBytes=10, backupCount=3)

fh = handlers.TimedRotatingFileHandler('web.log',when='S',interval=5, backupCount=3)

fh.setLevel(logging.WARNING)   # 文件保存 日志等级

# 2.1把hander对象绑定到logger

logger.addHandler(ch)

logger.addHandler(fh)

# 3.生成formatter 对象

file_formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

console_formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

# 3.1把formatter对象绑定到hander对象

ch.setFormatter(console_formatter)

fh.setFormatter(file_formatter)

logger.debug("test ....")

logger.info("test info ....")

logger.warning("start to run db backup job ....")

logger.warning("start to run db backup job 1....")

logger.warning("start to run db backup job 2....")

logger.error("test error ....")

　　（1）handlers.RotatingFileHandler

```
from logging import handlers
```

fh = handlers.RotatingFileHandler('web.log', maxBytes=10, backupCount=3)

　　（2）handlers.RotatingFileHandler

```
from logging import handlers
```
fh = handlers.RotatingFileHandler(filename=log_file,maxBytes=10,backupCount=3)