python3的formatter_Python3之logging模块

logging的日志可以分为debug(),info(),warning(),error()和critical()5个级别,如果没有设置，那全局的默认的收录日志级别是warning。

基本用法

1: import logging

2: logging.warning("user [alex] attempted wrong password more than 3 times")

3: logging.critical("server is down")

输出

1: >>> WARNING:root:user [alex] attempted wrong password more than 3 times

2: CRITICAL:root:server is down

如果想把日志写到文件里

1: logging.basicConfig(filename='example.log',level=logging.INFO)

2: # level=logging.INFO 只收录比INFO级别高的日志

3: logging.debug('This message should go to the log file')

4: logging.info('So should this')

5: logging.warning('And this, too')

example.log

1: INFO:root:So should this

2: WARNING:root:And this, too

自定义日志格式

1: logging.basicConfig(

2: filename='example.log',

3: level=logging.INFO,

4: format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p')

5: logging.warning('is when this event was logged.')

输出

1: 12/12/2018 05:05:29 PM is when this event was logged.

下面是所有支持的格式

1: %(levelno)s 数字形式的日志级别

2: %(levelname)s 文本形式的日志级别

3: %(pathname)s 调用日志输出函数的模块的完整路径名，可能没有

4: %(filename)s 调用日志输出函数的模块的文件名

5: %(module)s 调用日志输出函数的模块名

6: %(funcName)s 调用日志输出函数的函数名

7: %(lineno)d 调用日志输出函数的语句所在的代码行

8: %(created)f 当前时间，用UNIX标准的表示时间的浮 点数表示

9: %(relativeCreated)d输出日志信息时的，自Logger创建以 来的毫秒数

10: %(asctime)s 字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。 逗号后面的是毫秒

11: %(thread)d 线程ID。可能没有

12: %(threadName)s 线程名。可能没有

13: %(process)d 进程ID。可能没有

14: %(message)s 用户输出的消息

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

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

1: logger提供了应用程序可以直接使用的接口；

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

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

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

他们之间的关系用一张图片表示(stream写成steam了。懒得改了)

每个组件的主要功能如下:

logger

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

1: LOG=logging.getLogger("chat.gui")

核心模块：

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

handler

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

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

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

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

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

1.logging.StreamHandler 使用这个Handler可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息。

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，继续输出日志信息。它的函数是：

1: RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]])

其中filename和mode两个参数和FileHandler一样。

maxBytes用于指定日志文件的最大文件大小。如果maxBytes为0，意味着日志文件可以无限大，这时上面描述的重命名过程就不会发生。

backupCount用于指定保留的备份文件的个数。比如，如果指定为2，当上面描述的重命名过程发生时，原有的chat.log.2并不会被更名，而是被删除。

4.logging.handlers.TimedRotatingFileHandler

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

1: TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])

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

interval是时间间隔。

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

S 秒

M 分

H 小时

D 天

W 每星期(interval==0时代表星期一)

midnight 每天凌晨

formatter 组件

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

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

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

3:

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

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中

1: logger.addFilter(IgnoreBackupLogFilter())

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

1: logger.debug("test ....")

2: logger.info("test info ....")

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

4: logger.error("test error ....")

一个不带filter的简单的例子

1: import logging

2: # 1.生成logger对象,设置日记记录级别(全局，默认级别为warning,且优先级最高)

3: logger = logging.getLogger("web")

4: logger.setLevel(logging.INFO)

5:

6: # 2.生成handler对象,分别设置屏幕打印与文件写入的日志级别

7: # 局部级别的设置不能别全局级别的设置低，否则局部设置是没有效果。

8: ch = logging.StreamHandler()

9: ch.setLevel(logging.DEBUG)

10: fh = logging.FileHandler("web.log")

11: fh.setLevel(logging.WARNING)

12:

13: # 2.1 把handler对象 绑定到logger

14: logger.addHandler(ch)

15: logger.addHandler(fh)

16:

17: # 3.生成formatter对象

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

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

21:

22: # 3.1 把formatter对象 绑定handler对象

23: ch.setFormatter(console_formatter)

24: fh.setFormatter(file_formatter)

25:

26: logger.error("test.log")

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

1: import logging

2:

3: class IgnoreBackupLogFilter(logging.Filter):

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

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

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

7:

8: logger = logging.getLogger("Mysql")

9: logger.setLevel(logging.DEBUG)

10:

11: #console handler file handler

12: ch = logging.StreamHandler()

13: ch.setLevel(logging.INFO)

14: fh = logging.FileHandler('mysql.log')

15: fh.setLevel(logging.WARNING)

16:

17: #formatter

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

19: #bind formatter to ch

20: ch.setFormatter(formatter)

21: fh.setFormatter(formatter)

22:

23: #add handler to logger instance

24: logger.addHandler(ch)

25: logger.addHandler(fh)

26:

27: #add filter

28: logger.addFilter(IgnoreBackupLogFilter())

29:

30: logger.debug("test ....")

31: logger.info("test info ....")

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

33: logger.error("test error ....")

日志自动截断两种方式

按字节数截断

1: fh = handlers.RotatingFileHandler(filename=log_file,maxBytes=10,backupCount=3)

按时间截断

1: fh = handlers.TimedRotatingFileHandler(filename=log_file,when="S",interval=5,backupCount=3)