首页 » 编程 » Python » Python学习 » 正文

logging 模块

介绍

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

 

一、最简单的用法

import logging

logging.debug("debug msg")
logging.info("info msg")
logging.warning("warning msg")
logging.error("error msg")
logging.critical("critical msg")

输出:

WARNING:root:warning msg
ERROR:root:error msg
CRITICAL:root:critical msg

发现只输出了WARNING, ERROR, CRITICAL 而 debug 和 info 都没有输出,为什么?

因为它有一个日志级别:debug < info < warning < error < critical  , 默认为warning,默认打印warning以及比warning级别高的日志。

 

看一下这几个日志级别分别代表什么意思:

Level When it’s used
DEBUG Detailed information, typically of interest only when diagnosing problems.
INFO Confirmation that things are working as expected.
WARNING An indication that something unexpected happened, or indicative of some problem in the near future (e.g. ‘disk space low’). The software is still working as expected.
ERROR Due to a more serious problem, the software has not been able to perform some function.
CRITICAL A serious error, indicating that the program itself may be unable to continue running.

 

二、把日志写到文件里

import logging

logging.basicConfig(filename="test.log", level=logging.INFO)
logging.debug("debug msg")
logging.info("info msg")
logging.warning("warning msg")
logging.error("error msg")
logging.critical("critical msg")

运行后生成了文件 test.log , 文件内容为 :

INFO:root:info msg
WARNING:root:warning msg
ERROR:root:error msg
CRITICAL:root:critical msg

可以看到没有debug的信息,因为设置了日志级别 level=logging.INFO ,所以只会将 INFO级别和INFO级别以上的日志进行输出。

如果想要输出全部日志,将日志级别改为DEBUG就行了  level=logging.DEBUG

 

三、自定义日志格式

上面讲了如何输出到屏幕 和 文件,但是日志格式都是只有一条简单的信息,没有日期时间,这样记录日志是没有多大意义的,我们可以通过 time模块或datetime模块来打印时间,但是我们还有更简便的方法,在logging模块里都有相应的设置方法。

import logging

logging.basicConfig(format="%(asctime)s %(message)s")
logging.warning("alex login more than 3 times.")

输出:

2018-06-23 21:57:20,372 alex login more than 3 times.

调用 %(asctime)s 就直接将时间以上面的格式进行了输出。

 

我们还可以通过 datefmt 对时间的格式进行格式化:

import logging

logging.basicConfig(format="%(asctime)s %(message)s", datefmt="%Y/%m/%d %H:%M:%S")
logging.warning("alex login more than 3 times.")

输出:

2018/06/23 22:07:42 alex login more than 3 times.

 

还有其他可以使用的格式:

%(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决定日志记录的最终输出格式。

他们的关系是这样的:

 

是不是感觉很抽象,我们先来看一个例子,然后再说每个组件的功能:

import logging


# 声明用于过滤指定内容的filter类
class IgnoreBackupLogFilter(logging.Filter):
    """忽略带db backup 的日志"""

    def filter(self, record):  # 固定写法
        return "db backup" not in record.getMessage()


# 1. 生成 logger 对象
logger = logging.getLogger("web")
logger.setLevel(logging.DEBUG)  # 设置全局的日志级别,可不不设,默认为WARNING

# 1.1 把filter对象添加到logger中
logger.addFilter(IgnoreBackupLogFilter())

# 2. 生成 handler 对象
console_handler = logging.StreamHandler()  # 输出到屏幕的handler
console_handler.setLevel(logging.DEBUG)  # 单独给输出到屏幕的console_handler设置日志级别

file_handler = logging.FileHandler("web.log")  # 输出到文件的handler
file_handler.setLevel(logging.INFO)  # 单独给输出到文件的file_handler设置日志级别

# 这里关于全局日志级别和局部日志级别的问题就要注意了:
# 全局设置为DEBUG后,console_handler设置为INFO,如果输出的日志级别是DEBUG,那就不会在屏幕上输出。
# 以上解释为:因为输出的日志级别是DEBUG,那么首先和全局是一样的会进入到全局,然后走到局部,局部的级别是INFO,比DEBUG级别要高,所以最终不会输出。


# 2.1 把handler对象绑定到logger
logger.addHandler(console_handler)
logger.addHandler(file_handler)

# 3. 生成formatter对象
console_formatter = logging.Formatter("%(asctime)s %(message)s")
file_formatter = logging.Formatter("%(asctime)s %(levelname)s [%(filename)s] %(message)s")

# 3.1 把formatter对象绑定到handler对象
console_handler.setFormatter(console_formatter)
file_handler.setFormatter(file_formatter)

# 4. 调用logger打印日志
logger.debug("debug msg")
logger.info("info msg")
logger.warning("warning msg")
logger.error("error msg")
logger.critical("critical msg db backup")

运行后,日志会同时在屏幕和文件里打印。

在屏幕上打印内容为:

2018-06-24 11:14:49,452 debug msg
2018-06-24 11:14:49,452 info msg
2018-06-24 11:14:49,453 warning msg
2018-06-24 11:14:49,453 error msg

在文件里打印内容为:

2018-06-24 11:14:49,452 INFO [logging mod.py] info msg
2018-06-24 11:14:49,453 WARNING [logging mod.py] warning msg
2018-06-24 11:14:49,453 ERROR [logging mod.py] error msg

从上面的结果可以看到:

在屏幕上打印了从dubug到error的日志,因为全局日志级别是DEBUG,打印到屏幕上的日志级别也是DEBUG,所以会打印DEBUG和DEBUG以上的日志,但是又没有打印critical日志,因为添加了过滤“db backup”的filter,critical的日志中包含“db back” 所以不会打印。

在文件里打印了从info到error的日志,因为全局日志级别是DEBUG,打印到文件里的日志级别是INFO,所以只会打印INFO和INFO以上的日志,没有打印critical的日志原因同上,因为加了filter。

 

每个组件的功能

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

 

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:

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

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

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

    • maxBytes用于指定日志文件的最大文件大小。如果maxBytes为0,意味着日志文件可以无限大,这时上面描述的重命名过程就不会发生。
    • backupCount用于指定保留的备份文件的个数。比如,如果指定为2,当上面描述的重命名过程发生时,原有的chat.log.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 每天凌晨

 

formatter

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

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

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中

logger.addFilter(IgnoreBackupLogFilter())

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

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

如上面那个例子。

 

文件自动截断例子:

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

 

 

赞 (0)

发表评论