zoukankan      html  css  js  c++  java
  • python—logger

    logging模块可以提供一个很简单的basicConfig,但是它不够强大,忘记它吧

    使用logging模块的logger

    import logging
     
    logger = logging.getLogger()#创建一个logger实例
    # 创建一个handler实例,用于写入日志文件
    logger.setLevel('DEBUG')#默认级别是WARNING
    fh = logging.FileHandler('test.log',encoding='utf-8')
     
    # 再创建一个handler实例,用于输出到控制台
    ch = logging.StreamHandler()
    #创建格式实例
    formatter = logging.Formatter('[%(asctime)s] %(levelname)s [%(pathname)s %(lineno)d [%(funcName)s] %(message)s',
                                    datefmt='%Y-%m-%d %H:%M:%S')
    fh.setLevel(logging.DEBUG)#如果logger的level级别比fh高,按logger的走
    fh.setFormatter(formatter) #将第一个handler实例关联格式实例
    ch.setFormatter(formatter) #将第二个handler实例关联格式实例
    logger.addHandler(fh) #logger对象可以添加多个fh和ch对象
    logger.addHandler(ch)
     
    #试验输出
    logger.debug('logger debug message')
    logger.info('logger info message')
    logger.warning('logger warning message')
    logger.error('logger error message')
    logger.critical('logger critical message')

    先上一个简单应用实例:

    logger记录Exception

    logger.exception("Exception Logged")

     

    1. logging日志模块四大组件

    在介绍logging模块的日志流处理流程之前,我们先来介绍下logging模块的四大组件:

    组件名称对应类名功能描述
    日志器 Logger 提供了应用程序可一直使用的接口
    处理器 Handler 将logger创建的日志记录发送到合适的目的输出
    过滤器 Filter 提供了更细粒度的控制工具来决定输出哪条日志记录,丢弃哪条日志记录
    格式器 Formatter 决定日志记录的最终输出格式

    logging模块就是通过这些组件来完成日志处理的,上面所使用的logging模块级别的函数也是通过这些组件对应的类来实现的。

    这些组件之间的关系描述:
    • 日志器(logger)需要通过处理器(handler)将日志信息输出到目标位置,如:文件、sys.stdout、网络等;
    • 不同的处理器(handler)可以将日志输出到不同的位置;
    • 日志器(logger)可以设置多个处理器(handler)将同一条日志记录输出到不同的位置;
    • 每个处理器(handler)都可以设置自己的过滤器(filter)实现日志过滤,从而只保留感兴趣的日志;
    • 每个处理器(handler)都可以设置自己的格式器(formatter)实现同一条日志以不同的格式输出到不同的地方。

    简单点说就是:日志器(logger)是入口,真正干活儿的是处理器(handler),处理器(handler)还可以通过过滤器(filter)和格式器(formatter)对要输出的日志内容做过滤和格式化等处理操作。

    2. logging日志模块相关类及其常用方法介绍

    下面介绍下与logging四大组件相关的类:Logger, Handler, Filter, Formatter。

    Logger类

    Logger对象有3个任务要做:

    • 1)向应用程序代码暴露几个方法,使应用程序可以在运行时记录日志消息;
    • 2)基于日志严重等级(默认的过滤设施)或filter对象来决定要对哪些日志进行后续处理;
    • 3)将日志消息传送给所有感兴趣的日志handlers。

    Logger对象最常用的方法分为两类:配置方法 和 消息发送方法

    最常用的配置方法如下:

    方法描述
    Logger.setLevel() 设置日志器将会处理的日志消息的最低严重级别
    Logger.addHandler() 和 Logger.removeHandler() 为该logger对象添加 和 移除一个handler对象
    Logger.addFilter() 和 Logger.removeFilter() 为该logger对象添加 和 移除一个filter对象

    关于Logger.setLevel()方法的说明:

    内建等级中,级别最低的是DEBUG,级别最高的是CRITICAL。例如setLevel(logging.INFO),此时函数参数为INFO,那么该logger将只会处理INFO、WARNING、ERROR和CRITICAL级别的日志,而DEBUG级别的消息将会被忽略/丢弃。

    logger对象配置完成后,可以使用下面的方法来创建日志记录:

    方法描述
    Logger.debug(), Logger.info(), Logger.warning(), Logger.error(), Logger.critical() 创建一个与它们的方法名对应等级的日志记录
    Logger.exception() 创建一个类似于Logger.error()的日志消息
    Logger.log() 需要获取一个明确的日志level参数来创建一个日志记录

    说明:

    • Logger.exception()与Logger.error()的区别在于:Logger.exception()将会输出堆栈追踪信息,另外通常只是在一个exception handler中调用该方法。
    • Logger.log()与Logger.debug()、Logger.info()等方法相比,虽然需要多传一个level参数,显得不是那么方便,但是当需要记录自定义level的日志时还是需要该方法来完成。

    那么,怎样得到一个Logger对象呢?一种方式是通过Logger类的实例化方法创建一个Logger类的实例,但是我们通常都是用第二种方式--logging.getLogger()方法。

    logging.getLogger()方法有一个可选参数name,该参数表示将要返回的日志器的名称标识,如果不提供该参数,则其值为'root'。若以相同的name参数值多次调用getLogger()方法,将会返回指向同一个logger对象的引用。

    关于logger的层级结构与有效等级的说明:

    • logger的名称是一个以'.'分割的层级结构,每个'.'后面的logger都是'.'前面的logger的children,例如,有一个名称为 foo 的logger,其它名称分别为 foo.bar, foo.bar.baz 和 foo.bam都是 foo 的后代。
    • logger有一个"有效等级(effective level)"的概念。如果一个logger上没有被明确设置一个level,那么该logger就是使用它parent的level;如果它的parent也没有明确设置level则继续向上查找parent的parent的有效level,依次类推,直到找到个一个明确设置了level的祖先为止。需要说明的是,root logger总是会有一个明确的level设置(默认为 WARNING)。当决定是否去处理一个已发生的事件时,logger的有效等级将会被用来决定是否将该事件传递给该logger的handlers进行处理。
    • child loggers在完成对日志消息的处理后,默认会将日志消息传递给与它们的祖先loggers相关的handlers。因此,我们不必为一个应用程序中所使用的所有loggers定义和配置handlers,只需要为一个顶层的logger配置handlers,然后按照需要创建child loggers就可足够了。我们也可以通过将一个logger的propagate属性设置为False来关闭这种传递机制。
    Handler类

    Handler对象的作用是(基于日志消息的level)将消息分发到handler指定的位置(文件、网络、邮件等)。Logger对象可以通过addHandler()方法为自己添加0个或者更多个handler对象。比如,一个应用程序可能想要实现以下几个日志需求:

    • 1)把所有日志都发送到一个日志文件中;
    • 2)把所有严重级别大于等于error的日志发送到stdout(标准输出);
    • 3)把所有严重级别为critical的日志发送到一个email邮件地址。
      这种场景就需要3个不同的handlers,每个handler复杂发送一个特定严重级别的日志到一个特定的位置。

    一个handler中只有非常少数的方法是需要应用开发人员去关心的。对于使用内建handler对象的应用开发人员来说,似乎唯一相关的handler方法就是下面这几个配置方法:

    方法描述
    Handler.setLevel() 设置handler将会处理的日志消息的最低严重级别
    Handler.setFormatter() 为handler设置一个格式器对象
    Handler.addFilter() 和 Handler.removeFilter() 为handler添加 和 删除一个过滤器对象

    需要说明的是,应用程序代码不应该直接实例化和使用Handler实例。因为Handler是一个基类,它只定义了素有handlers都应该有的接口,同时提供了一些子类可以直接使用或覆盖的默认行为。下面是一些常用的Handler:

    Handler描述
    logging.StreamHandler 将日志消息发送到输出到Stream,如std.out, std.err或任何file-like对象。
    logging.FileHandler 将日志消息发送到磁盘文件,默认情况下文件大小会无限增长
    logging.handlers.RotatingFileHandler 将日志消息发送到磁盘文件,并支持日志文件按大小切割
    logging.hanlders.TimedRotatingFileHandler 将日志消息发送到磁盘文件,并支持日志文件按时间切割
    logging.handlers.HTTPHandler 将日志消息以GET或POST的方式发送给一个HTTP服务器
    logging.handlers.SMTPHandler 将日志消息发送给一个指定的email地址
    logging.NullHandler 该Handler实例会忽略error messages,通常被想使用logging的library开发者使用来避免'No handlers could be found for logger XXX'信息的出现。
    Formater类

    Formater对象用于配置日志信息的最终顺序、结构和内容。与logging.Handler基类不同的是,应用代码可以直接实例化Formatter类。另外,如果你的应用程序需要一些特殊的处理行为,也可以实现一个Formatter的子类来完成。

    Formatter类的构造方法定义如下:

    logging.Formatter.__init__(fmt=None, datefmt=None, style='%')

    可见,该构造方法接收3个可选参数:

    • fmt:指定消息格式化字符串,如果不指定该参数则默认使用message的原始值
    • datefmt:指定日期格式字符串,如果不指定该参数则默认使用"%Y-%m-%d %H:%M:%S"
    • style:Python 3.2新增的参数,可取值为 '%', '{'和 '$',如果不指定该参数则默认使用'%'
    Filter类

    Filter可以被Handler和Logger用来做比level更细粒度的、更复杂的过滤功能。Filter是一个过滤器基类,它只允许某个logger层级下的日志事件通过过滤。该类定义如下:

    class logging.Filter(name='')
        filter(record)

    比如,一个filter实例化时传递的name参数值为'A.B',那么该filter实例将只允许名称为类似如下规则的loggers产生的日志记录通过过滤:'A.B','A.B,C','A.B.C.D','A.B.D',而名称为'A.BB', 'B.A.B'的loggers产生的日志则会被过滤掉。如果name的值为空字符串,则允许所有的日志事件通过过滤。

    filter方法用于具体控制传递的record记录是否能通过过滤,如果该方法返回值为0表示不能通过过滤,返回值为非0表示可以通过过滤。

    说明:

    • 如果有需要,也可以在filter(record)方法内部改变该record,比如添加、删除或修改一些属性。
    • 我们还可以通过filter做一些统计工作,比如可以计算下被一个特殊的logger或handler所处理的record数量等。
    参考目录:
  • 相关阅读:
    响应式网页设计简单入门
    食品企业模拟大作业
    pyqt5 QTreeWiget删除节点的问题
    递归问题记录attention
    pyinstaller打包:AttributeError: module 'win32ctypes.pywin32.win32api' has no attribute 'error'
    QT调用python的部分问题
    QT编译出现ld.exe: cannot open output file debug h_03testCallPy.exe: Permission denied collect2.exe: error: ld returned 1 exit status
    pyinstaller执行后出现maximum recursion depth exceeded while calling a Python object
    优学院辅助_全自动视频...
    年产xx吨xx食品工厂设计资料
  • 原文地址:https://www.cnblogs.com/yuanji2018/p/10031118.html
Copyright © 2011-2022 走看看