Python入门：常用模块—logging模块

logging日志的分级：

        debug(),info(),warning(),error(),critical() 5个级别

最简单用法

1 2 3 4

import logging logging.warning("user [mike] attempted wrong password more than 3 times") logging.critical("server is down")

　　输出：

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

　　日志级别分别代表什么意思

Level	when it's used
DEBUG	打印详细信息，只有调试的时候才有意义
INFO	打印正常信息
WARNING	打印警告信息
ERROR	打印错误信息
CRITICAL	打印严重的错误信息，比如系统奔溃的错误信息

日志写到文件里

1 2 3 4

logging.basicConfig(filename='example.log', level=logging.INFO) logging.debug('This message should go to the log file') logging.info('So should this') logging.warning('And this, too')

　　其中level=logging.INFO意思是：把日志记录级别设置为INFO，也就是说，只有比日志是INFO或比INFO级别更高的日志才会被记录到文件里，在上面debug是不会被记录的

输出

1 2	INFO:root:So should this WARNING:root:And this, too

　　自定义日志格式

1 2	logging.basicConfig(format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p') logging.warning('is when this event was logged.')

　　输出

1	05/25/2018 09:37:33 AM is when this event was logged.

　　

除了加时间，还可以子定义各种格式

  

%(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	用户输出的消息

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

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

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

他们之间的关系如下：

每个组件的主要功能

logger

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

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

　　

而核心模块可以这样：

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

还可以绑定handler和filters　　

1 2 3

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 2 3

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)输出信息。
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]]])

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

   • maxBytes用于指定日志文件的最大文件大小。如果maxBytes为0，意味着日志文件可以无限大，这时上面描述的重命名过程就不会发生。
   • backupCount用于指定保留的备份文件的个数。比如，如果指定为2，当上面描述的重命名过程发生时，原有的chat.log.2并不会被更名，而是被删除。

2. logging.handlers.TimedRotatingFileHandler

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

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

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

   interval是时间间隔。

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

   • S 秒
   • M 分
   • H 小时
   • D 天
   • W 每星期（interval==0时代表星期一）
   • midnight 每天凌晨

formatter 组件

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

1 2 3 4

fh = logging.FileHandler("access.log") formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') fh.setFormatter(formatter)

　　

filter 组件

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

1 2 3 4

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 2 3 4

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

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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

class IgnoreBackupLogFilter(logging.Filter):     """忽略带db backup的日志"""     def filter(self, record):   # 固定写法         return "db backup" not in record.getMessage() # console handler ch = logging.StreamHandler() ch.setLevel(logging.INFO) fh = logging.FileHandler('mysql.log') # formatter formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') ch.setFormatter(formatter) fh.setFormatter(formatter) logger = logging.getLogger("Mysql") logger.setLevel(logging.DEBUG)  # logger优先级高于其它输出途径的 # add handler to logger instance logger.addHandler(ch) logger.addHandler(fh) # add filter logger.addFilter(IgnoreBackupLogFilter()) logger.debug("test....") logger.info("test info...") logger.warning("start to run db backup job...") logger.error("test error")

文件自动截断例子　　

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

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